Debian Codegraph @

docs/dyn/content_v2.orderreports.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#listdisbursements">listdisbursements(merchantId, disbursementEndDate=None, disbursementStartDate=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves a report for disbursements from your Merchant Center account.</p>
83 <p class="toc_element">
84 <code><a href="#listdisbursements_next">listdisbursements_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <p class="toc_element">
87 <code><a href="#listtransactions">listtransactions(merchantId, disbursementId, maxResults=None, pageToken=None, transactionEndDate=None, transactionStartDate=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves a list of transactions for a disbursement from your Merchant Center account.</p>
89 <p class="toc_element">
90 <code><a href="#listtransactions_next">listtransactions_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="listdisbursements">listdisbursements(merchantId, disbursementEndDate=None, disbursementStartDate=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
100 <pre>Retrieves a report for disbursements from your Merchant Center account.
101
102 Args:
103 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
104 disbursementEndDate: string, The last date which disbursements occurred. In ISO 8601 format. Default: current date.
105 disbursementStartDate: string, The first date which disbursements occurred. In ISO 8601 format.
106 maxResults: integer, The maximum number of disbursements to return in the response, used for paging.
107 pageToken: string, The token returned by the previous request.
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113 Returns:
114 An object of the form:
115
116 {
117 &quot;disbursements&quot;: [ # The list of disbursements.
118 { # Order disbursement. All methods require the payment analyst role.
119 &quot;disbursementAmount&quot;: { # The disbursement amount.
120 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
121 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
122 },
123 &quot;disbursementCreationDate&quot;: &quot;A String&quot;, # The disbursement date, in ISO 8601 format.
124 &quot;disbursementDate&quot;: &quot;A String&quot;, # The date the disbursement was initiated, in ISO 8601 format.
125 &quot;disbursementId&quot;: &quot;A String&quot;, # The ID of the disbursement.
126 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
127 },
128 ],
129 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#orderreportsListDisbursementsResponse&quot;.
130 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of disbursements.
131 }</pre>
132 </div>
133
134 <div class="method">
135 <code class="details" id="listdisbursements_next">listdisbursements_next()</code>
136 <pre>Retrieves the next page of results.
137
138 Args:
139 previous_request: The request for the previous page. (required)
140 previous_response: The response from the request for the previous page. (required)
141
142 Returns:
143 A request object that you can call &#x27;execute()&#x27; on to request the next
144 page. Returns None if there are no more items in the collection.
145 </pre>
146 </div>
147
148 <div class="method">
149 <code class="details" id="listtransactions">listtransactions(merchantId, disbursementId, maxResults=None, pageToken=None, transactionEndDate=None, transactionStartDate=None, x__xgafv=None)</code>
150 <pre>Retrieves a list of transactions for a disbursement from your Merchant Center account.
151
152 Args:
153 merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
154 disbursementId: string, The Google-provided ID of the disbursement (found in Wallet). (required)
155 maxResults: integer, The maximum number of disbursements to return in the response, used for paging.
156 pageToken: string, The token returned by the previous request.
157 transactionEndDate: string, The last date in which transaction occurred. In ISO 8601 format. Default: current date.
158 transactionStartDate: string, The first date in which transaction occurred. In ISO 8601 format.
159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164 Returns:
165 An object of the form:
166
167 {
168 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#orderreportsListTransactionsResponse&quot;.
169 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of transactions.
170 &quot;transactions&quot;: [ # The list of transactions.
171 {
172 &quot;disbursementAmount&quot;: { # The disbursement amount.
173 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
174 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
175 },
176 &quot;disbursementCreationDate&quot;: &quot;A String&quot;, # The date the disbursement was created, in ISO 8601 format.
177 &quot;disbursementDate&quot;: &quot;A String&quot;, # The date the disbursement was initiated, in ISO 8601 format.
178 &quot;disbursementId&quot;: &quot;A String&quot;, # The ID of the disbursement.
179 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
180 &quot;merchantOrderId&quot;: &quot;A String&quot;, # Merchant-provided ID of the order.
181 &quot;orderId&quot;: &quot;A String&quot;, # The ID of the order.
182 &quot;productAmount&quot;: { # Total amount for the items.
183 &quot;pretax&quot;: { # [required] Value before taxes.
184 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
185 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
186 },
187 &quot;tax&quot;: { # [required] Tax value.
188 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
189 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
190 },
191 },
192 &quot;productAmountWithRemittedTax&quot;: { # Total amount with remitted tax for the items.
193 &quot;priceAmount&quot;: { # The pre-tax or post-tax price depending on the location of the order.
194 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
195 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
196 },
197 &quot;remittedTaxAmount&quot;: { # Remitted tax value.
198 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
199 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
200 },
201 &quot;taxAmount&quot;: { # Tax value.
202 &quot;currency&quot;: &quot;A String&quot;, # The currency of the price.
203 &quot;value&quot;: &quot;A String&quot;, # The price represented as a number.
204 },
205 },
206 &quot;transactionDate&quot;: &quot;A String&quot;, # The date of the transaction, in ISO 8601 format.
207 },
208 ],
209 }</pre>
210 </div>
211
212 <div class="method">
213 <code class="details" id="listtransactions_next">listtransactions_next()</code>
214 <pre>Retrieves the next page of results.
215
216 Args:
217 previous_request: The request for the previous page. (required)
218 previous_response: The response from the request for the previous page. (required)
219
220 Returns:
221 A request object that you can call &#x27;execute()&#x27; on to request the next
222 page. Returns None if there are no more items in the collection.
223 </pre>
224 </div>
225
226 </body></html>