Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 26aa9e282e30ca9c8797ee5346cbe9c0b9ca65a7 / . / docs / dyn / content_v2.accounttax.html
blob: 7951fb5ea265a381938d18b452eb85b10fc57e40 [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">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]81 <code><a href="#custombatch">custombatch(body=None, dryRun=None, x__xgafv=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">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]84 <code><a href="#get">get(merchantId, accountId, x__xgafv=None)</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">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]87 <code><a href="#list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=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">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]93 <code><a href="#update">update(merchantId, accountId, body=None, dryRun=None, x__xgafv=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">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]102 <code class="details" id="custombatch">custombatch(body=None, dryRun=None, x__xgafv=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{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]110 &quot;entries&quot;: [ # The request entries to be processed in the batch.
111 { # A batch entry encoding a single non-batch accounttax request.
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;A String&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.
117 { # Tax calculation rule to apply in a state or province (USA only).
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.
123 },
124 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]125 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[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. Acceptable values are: - &quot;`get`&quot; - &quot;`update`&quot;
129 },
130 ],
131}
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]132
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]133 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).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]134 x__xgafv: string, V1 error format.
135 Allowed values
136 1 - v1 error format
137 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]138
139Returns:
140 An object of the form:
141
142 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]143 &quot;entries&quot;: [ # The result of the execution of the batch requests.
144 { # A batch entry encoding a single non-batch accounttax response.
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;A String&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.
149 { # Tax calculation rule to apply in a state or province (USA only).
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.
155 },
156 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]157 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[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.
162 { # An error returned by the API.
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.
166 },
167 ],
168 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
169 },
170 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#accounttaxCustomBatchResponseEntry`&quot;
171 },
172 ],
173 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accounttaxCustomBatchResponse&quot;.
174}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]175</div>
176
177<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]178 <code class="details" id="get">get(merchantId, accountId, x__xgafv=None)</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)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]188
189Returns:
190 An object of the form:
191
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 { # The tax settings of a merchant account. All methods require the admin role.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]193 &quot;accountId&quot;: &quot;A String&quot;, # Required. The ID of the account to which these account tax settings belong.
194 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountTax&quot;.
195 &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.
196 { # Tax calculation rule to apply in a state or province (USA only).
197 &quot;country&quot;: &quot;A String&quot;, # Country code in which tax is applicable.
198 &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).
199 &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.
200 &quot;shippingTaxed&quot;: True or False, # If true, shipping charges are also taxed.
201 &quot;useGlobalRate&quot;: True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
202 },
203 ],
204}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]205</div>
206
207<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]208 <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 <pre>Lists the tax settings of the sub-accounts in your Merchant Center account.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]210
211Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]213 maxResults: integer, The maximum number of tax settings to return in the response, used for paging.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]214 pageToken: string, The token returned by the previous request.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]215 x__xgafv: string, V1 error format.
216 Allowed values
217 1 - v1 error format
218 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]219
220Returns:
221 An object of the form:
222
223 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]224 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accounttaxListResponse&quot;.
225 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of account tax settings.
226 &quot;resources&quot;: [
227 { # The tax settings of a merchant account. All methods require the admin role.
228 &quot;accountId&quot;: &quot;A String&quot;, # Required. The ID of the account to which these account tax settings belong.
229 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountTax&quot;.
230 &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.
231 { # Tax calculation rule to apply in a state or province (USA only).
232 &quot;country&quot;: &quot;A String&quot;, # Country code in which tax is applicable.
233 &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).
234 &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.
235 &quot;shippingTaxed&quot;: True or False, # If true, shipping charges are also taxed.
236 &quot;useGlobalRate&quot;: True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
237 },
238 ],
239 },
240 ],
241}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]242</div>
243
244<div class="method">
245 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
246 <pre>Retrieves the next page of results.
247
248Args:
249 previous_request: The request for the previous page. (required)
250 previous_response: The response from the request for the previous page. (required)
251
252Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]253 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]254 page. Returns None if there are no more items in the collection.
255 </pre>
256</div>
257
258<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]259 <code class="details" id="update">update(merchantId, accountId, body=None, dryRun=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]260 <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]261
262Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]263 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]264 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]265 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]266 The object takes the form of:
267
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]268{ # The tax settings of a merchant account. All methods require the admin role.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]269 &quot;accountId&quot;: &quot;A String&quot;, # Required. The ID of the account to which these account tax settings belong.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]270 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountTax&quot;.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]271 &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]272 { # Tax calculation rule to apply in a state or province (USA only).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]273 &quot;country&quot;: &quot;A String&quot;, # Country code in which tax is applicable.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]274 &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).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]275 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]276 &quot;shippingTaxed&quot;: True or False, # If true, shipping charges are also taxed.
277 &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]278 },
279 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]280}
281
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 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).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]283 x__xgafv: string, V1 error format.
284 Allowed values
285 1 - v1 error format
286 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]287
288Returns:
289 An object of the form:
290
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 { # The tax settings of a merchant account. All methods require the admin role.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]292 &quot;accountId&quot;: &quot;A String&quot;, # Required. The ID of the account to which these account tax settings belong.
293 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountTax&quot;.
294 &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.
295 { # Tax calculation rule to apply in a state or province (USA only).
296 &quot;country&quot;: &quot;A String&quot;, # Country code in which tax is applicable.
297 &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).
298 &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.
299 &quot;shippingTaxed&quot;: True or False, # If true, shipping charges are also taxed.
300 &quot;useGlobalRate&quot;: True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
301 },
302 ],
303}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]304</div>
305
306</body></html>