• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.orderreports.html">orderreports</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#listdisbursements">listdisbursements(merchantId, disbursementStartDate, disbursementEndDate=None, pageToken=None, maxResults=None)</a></code></p>
79<p class="firstline">Retrieves a report for disbursements from your Merchant Center account.</p>
80<p class="toc_element">
81  <code><a href="#listdisbursements_next">listdisbursements_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84  <code><a href="#listtransactions">listtransactions(merchantId, disbursementId, transactionStartDate, pageToken=None, maxResults=None, transactionEndDate=None)</a></code></p>
85<p class="firstline">Retrieves a list of transactions for a disbursement from your Merchant Center account.</p>
86<p class="toc_element">
87  <code><a href="#listtransactions_next">listtransactions_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
91    <code class="details" id="listdisbursements">listdisbursements(merchantId, disbursementStartDate, disbursementEndDate=None, pageToken=None, maxResults=None)</code>
92  <pre>Retrieves a report for disbursements from your Merchant Center account.
93
94Args:
95  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
96  disbursementStartDate: string, The first date which disbursements occurred. In ISO 8601 format. (required)
97  disbursementEndDate: string, The last date which disbursements occurred. In ISO 8601 format. Default: current date.
98  pageToken: string, The token returned by the previous request.
99  maxResults: integer, The maximum number of disbursements to return in the response, used for paging.
100
101Returns:
102  An object of the form:
103
104    {
105    "nextPageToken": "A String", # The token for the retrieval of the next page of disbursements.
106    "kind": "content#orderreportsListDisbursementsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListDisbursementsResponse".
107    "disbursements": [ # The list of disbursements.
108      { # Order disbursement. All methods require the payment analyst role.
109        "disbursementCreationDate": "A String", # The disbursement date, in ISO 8601 format.
110        "disbursementAmount": { # The disbursement amount.
111          "currency": "A String", # The currency of the price.
112          "value": "A String", # The price represented as a number.
113        },
114        "disbursementDate": "A String", # The date the disbursement was initiated, in ISO 8601 format.
115        "merchantId": "A String", # The ID of the managing account.
116        "disbursementId": "A String", # The ID of the disbursement.
117      },
118    ],
119  }</pre>
120</div>
121
122<div class="method">
123    <code class="details" id="listdisbursements_next">listdisbursements_next(previous_request, previous_response)</code>
124  <pre>Retrieves the next page of results.
125
126Args:
127  previous_request: The request for the previous page. (required)
128  previous_response: The response from the request for the previous page. (required)
129
130Returns:
131  A request object that you can call 'execute()' on to request the next
132  page. Returns None if there are no more items in the collection.
133    </pre>
134</div>
135
136<div class="method">
137    <code class="details" id="listtransactions">listtransactions(merchantId, disbursementId, transactionStartDate, pageToken=None, maxResults=None, transactionEndDate=None)</code>
138  <pre>Retrieves a list of transactions for a disbursement from your Merchant Center account.
139
140Args:
141  merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
142  disbursementId: string, The Google-provided ID of the disbursement (found in Wallet). (required)
143  transactionStartDate: string, The first date in which transaction occurred. In ISO 8601 format. (required)
144  pageToken: string, The token returned by the previous request.
145  maxResults: integer, The maximum number of disbursements to return in the response, used for paging.
146  transactionEndDate: string, The last date in which transaction occurred. In ISO 8601 format. Default: current date.
147
148Returns:
149  An object of the form:
150
151    {
152    "nextPageToken": "A String", # The token for the retrieval of the next page of transactions.
153    "kind": "content#orderreportsListTransactionsResponse", # Identifies what kind of resource this is. Value: the fixed string "content#orderreportsListTransactionsResponse".
154    "transactions": [ # The list of transactions.
155      {
156        "orderId": "A String", # The ID of the order.
157        "merchantOrderId": "A String", # Merchant-provided ID of the order.
158        "productAmountWithRemittedTax": { # Total amount with remitted tax for the items.
159          "priceAmount": { # The pre-tax or post-tax price depending on the location of the order.
160            "currency": "A String", # The currency of the price.
161            "value": "A String", # The price represented as a number.
162          },
163          "remittedTaxAmount": { # Remitted tax value.
164            "currency": "A String", # The currency of the price.
165            "value": "A String", # The price represented as a number.
166          },
167          "taxAmount": { # Tax value.
168            "currency": "A String", # The currency of the price.
169            "value": "A String", # The price represented as a number.
170          },
171        },
172        "productAmount": { # Total amount for the items.
173          "tax": { # [required] Tax value.
174            "currency": "A String", # The currency of the price.
175            "value": "A String", # The price represented as a number.
176          },
177          "pretax": { # [required] Value before taxes.
178            "currency": "A String", # The currency of the price.
179            "value": "A String", # The price represented as a number.
180          },
181        },
182        "disbursementId": "A String", # The ID of the disbursement.
183        "transactionDate": "A String", # The date of the transaction, in ISO 8601 format.
184        "disbursementCreationDate": "A String", # The date the disbursement was created, in ISO 8601 format.
185        "disbursementAmount": { # The disbursement amount.
186          "currency": "A String", # The currency of the price.
187          "value": "A String", # The price represented as a number.
188        },
189        "disbursementDate": "A String", # The date the disbursement was initiated, in ISO 8601 format.
190        "merchantId": "A String", # The ID of the managing account.
191      },
192    ],
193  }</pre>
194</div>
195
196<div class="method">
197    <code class="details" id="listtransactions_next">listtransactions_next(previous_request, previous_response)</code>
198  <pre>Retrieves the next page of results.
199
200Args:
201  previous_request: The request for the previous page. (required)
202  previous_response: The response from the request for the previous page. (required)
203
204Returns:
205  A request object that you can call 'execute()' on to request the next
206  page. Returns None if there are no more items in the collection.
207    </pre>
208</div>
209
210</body></html>