Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / content_v2.accounttax.html
blob: 17cf0aa086b66a5f2e0d58ade5871d9bc32bd108 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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.accounttax.html">accounttax</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#custombatch">custombatch(body=None, dryRun=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]82<p class="firstline">Retrieves and updates tax settings of multiple accounts in a single request.</p>
83<p class="toc_element">
84 <code><a href="#get">get(merchantId, accountId)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Retrieves the tax settings of the account.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#list">list(merchantId, maxResults=None, pageToken=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Lists the tax settings of the sub-accounts in your Merchant Center account.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#update">update(merchantId, accountId, body=None, dryRun=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]94<p class="firstline">Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <code class="details" id="custombatch">custombatch(body=None, dryRun=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]103 <pre>Retrieves and updates tax settings of multiple accounts in a single request.
104
105Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]107 The object takes the form of:
108
109{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 &quot;entries&quot;: [ # The request entries to be processed in the batch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]111 { # A batch entry encoding a single non-batch accounttax request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the account for which to get/update account tax settings.
113 &quot;accountTax&quot;: { # The tax settings of a merchant account. All methods require the admin role. # The account tax settings to update. Only defined if the method is `update`.
114 &quot;accountId&quot;: &quot;A String&quot;, # Required. The ID of the account to which these account tax settings belong.
115 &quot;kind&quot;: &quot;content#accountTax&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountTax&quot;.
116 &quot;rules&quot;: [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]117 { # Tax calculation rule to apply in a state or province (USA only).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]118 &quot;country&quot;: &quot;A String&quot;, # Country code in which tax is applicable.
119 &quot;locationId&quot;: &quot;A String&quot;, # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
120 &quot;ratePercent&quot;: &quot;A String&quot;, # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
121 &quot;shippingTaxed&quot;: True or False, # If true, shipping charges are also taxed.
122 &quot;useGlobalRate&quot;: True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]123 },
124 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]125 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
127 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
128 &quot;method&quot;: &quot;A String&quot;, # The method of the batch entry.
129 #
130 # Acceptable values are:
131 # - &quot;`get`&quot;
132 # - &quot;`update`&quot;
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]133 },
134 ],
135 }
136
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]138
139Returns:
140 An object of the form:
141
142 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;entries&quot;: [ # The result of the execution of the batch requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]144 { # A batch entry encoding a single non-batch accounttax response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 &quot;accountTax&quot;: { # The tax settings of a merchant account. All methods require the admin role. # The retrieved or updated account tax settings.
146 &quot;accountId&quot;: &quot;A String&quot;, # Required. The ID of the account to which these account tax settings belong.
147 &quot;kind&quot;: &quot;content#accountTax&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountTax&quot;.
148 &quot;rules&quot;: [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]149 { # Tax calculation rule to apply in a state or province (USA only).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;country&quot;: &quot;A String&quot;, # Country code in which tax is applicable.
151 &quot;locationId&quot;: &quot;A String&quot;, # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
152 &quot;ratePercent&quot;: &quot;A String&quot;, # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
153 &quot;shippingTaxed&quot;: True or False, # If true, shipping charges are also taxed.
154 &quot;useGlobalRate&quot;: True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]155 },
156 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]157 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 &quot;batchId&quot;: 42, # The ID of the request entry this entry responds to.
159 &quot;errors&quot;: { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
160 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
161 &quot;errors&quot;: [ # A list of errors.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]162 { # An error returned by the API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
164 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
165 &quot;reason&quot;: &quot;A String&quot;, # The error code.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]166 },
167 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]169 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 &quot;kind&quot;: &quot;content#accounttaxCustomBatchResponseEntry&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#accounttaxCustomBatchResponseEntry`&quot;
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]171 },
172 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]173 &quot;kind&quot;: &quot;content#accounttaxCustomBatchResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accounttaxCustomBatchResponse&quot;.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]174 }</pre>
175</div>
176
177<div class="method">
178 <code class="details" id="get">get(merchantId, accountId)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 <pre>Retrieves the tax settings of the account.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]180
181Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]182 merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]183 accountId: string, The ID of the account for which to get/update account tax settings. (required)
184
185Returns:
186 An object of the form:
187
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 { # The tax settings of a merchant account. All methods require the admin role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189 &quot;accountId&quot;: &quot;A String&quot;, # Required. The ID of the account to which these account tax settings belong.
190 &quot;kind&quot;: &quot;content#accountTax&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountTax&quot;.
191 &quot;rules&quot;: [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]192 { # Tax calculation rule to apply in a state or province (USA only).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 &quot;country&quot;: &quot;A String&quot;, # Country code in which tax is applicable.
194 &quot;locationId&quot;: &quot;A String&quot;, # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
195 &quot;ratePercent&quot;: &quot;A String&quot;, # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
196 &quot;shippingTaxed&quot;: True or False, # If true, shipping charges are also taxed.
197 &quot;useGlobalRate&quot;: True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]198 },
199 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]200 }</pre>
201</div>
202
203<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]204 <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 <pre>Lists the tax settings of the sub-accounts in your Merchant Center account.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]206
207Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]209 maxResults: integer, The maximum number of tax settings to return in the response, used for paging.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210 pageToken: string, The token returned by the previous request.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]211
212Returns:
213 An object of the form:
214
215 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]216 &quot;kind&quot;: &quot;content#accounttaxListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accounttaxListResponse&quot;.
217 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of account tax settings.
218 &quot;resources&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219 { # The tax settings of a merchant account. All methods require the admin role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]220 &quot;accountId&quot;: &quot;A String&quot;, # Required. The ID of the account to which these account tax settings belong.
221 &quot;kind&quot;: &quot;content#accountTax&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountTax&quot;.
222 &quot;rules&quot;: [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]223 { # Tax calculation rule to apply in a state or province (USA only).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 &quot;country&quot;: &quot;A String&quot;, # Country code in which tax is applicable.
225 &quot;locationId&quot;: &quot;A String&quot;, # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
226 &quot;ratePercent&quot;: &quot;A String&quot;, # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
227 &quot;shippingTaxed&quot;: True or False, # If true, shipping charges are also taxed.
228 &quot;useGlobalRate&quot;: True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]229 },
230 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]231 },
232 ],
233 }</pre>
234</div>
235
236<div class="method">
237 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
238 <pre>Retrieves the next page of results.
239
240Args:
241 previous_request: The request for the previous page. (required)
242 previous_response: The response from the request for the previous page. (required)
243
244Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]246 page. Returns None if there are no more items in the collection.
247 </pre>
248</div>
249
250<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]251 <code class="details" id="update">update(merchantId, accountId, body=None, dryRun=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]252 <pre>Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]253
254Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]255 merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]256 accountId: string, The ID of the account for which to get/update account tax settings. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]257 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]258 The object takes the form of:
259
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]260{ # The tax settings of a merchant account. All methods require the admin role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]261 &quot;accountId&quot;: &quot;A String&quot;, # Required. The ID of the account to which these account tax settings belong.
262 &quot;kind&quot;: &quot;content#accountTax&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountTax&quot;.
263 &quot;rules&quot;: [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]264 { # Tax calculation rule to apply in a state or province (USA only).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]265 &quot;country&quot;: &quot;A String&quot;, # Country code in which tax is applicable.
266 &quot;locationId&quot;: &quot;A String&quot;, # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
267 &quot;ratePercent&quot;: &quot;A String&quot;, # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
268 &quot;shippingTaxed&quot;: True or False, # If true, shipping charges are also taxed.
269 &quot;useGlobalRate&quot;: True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]270 },
271 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]272}
273
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]274 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]275
276Returns:
277 An object of the form:
278
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 { # The tax settings of a merchant account. All methods require the admin role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]280 &quot;accountId&quot;: &quot;A String&quot;, # Required. The ID of the account to which these account tax settings belong.
281 &quot;kind&quot;: &quot;content#accountTax&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountTax&quot;.
282 &quot;rules&quot;: [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]283 { # Tax calculation rule to apply in a state or province (USA only).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]284 &quot;country&quot;: &quot;A String&quot;, # Country code in which tax is applicable.
285 &quot;locationId&quot;: &quot;A String&quot;, # Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).
286 &quot;ratePercent&quot;: &quot;A String&quot;, # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
287 &quot;shippingTaxed&quot;: True or False, # If true, shipping charges are also taxed.
288 &quot;useGlobalRate&quot;: True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]289 },
290 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]291 }</pre>
292</div>
293
294</body></html>