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