Home | History | Annotate | Download | only in dyn 
      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.accounttax.html">accounttax</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#custombatch">custombatch(body, dryRun=None)</a></code></p>
     79 <p class="firstline">Retrieves and updates tax settings of multiple accounts in a single request.</p>
     80 <p class="toc_element">
     81   <code><a href="#get">get(merchantId, accountId)</a></code></p>
     82 <p class="firstline">Retrieves the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.</p>
     83 <p class="toc_element">
     84   <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
     85 <p class="firstline">Lists the tax settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.</p>
     86 <p class="toc_element">
     87   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     88 <p class="firstline">Retrieves the next page of results.</p>
     89 <p class="toc_element">
     90   <code><a href="#patch">patch(merchantId, accountId, body, dryRun=None)</a></code></p>
     91 <p class="firstline">Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.</p>
     92 <p class="toc_element">
     93   <code><a href="#update">update(merchantId, accountId, body, dryRun=None)</a></code></p>
     94 <p class="firstline">Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.</p>
     95 <h3>Method Details</h3>
     96 <div class="method">
     97     <code class="details" id="custombatch">custombatch(body, dryRun=None)</code>
     98   <pre>Retrieves and updates tax settings of multiple accounts in a single request.
     99 
    100 Args:
    101   body: object, The request body. (required)
    102     The object takes the form of:
    103 
    104 {
    105     "entries": [ # The request entries to be processed in the batch.
    106       { # A batch entry encoding a single non-batch accounttax request.
    107         "batchId": 42, # An entry ID, unique within the batch request.
    108         "method": "A String",
    109         "accountTax": { # The tax settings of a merchant account. # The account tax settings to update. Only defined if the method is update.
    110           "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    111             { # Tax calculation rule to apply in a state or province (USA only).
    112               "country": "A String", # Country code in which tax is applicable.
    113               "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
    114               "shippingTaxed": True or False, # If true, shipping charges are also taxed.
    115               "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
    116               "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    117             },
    118           ],
    119           "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    120           "accountId": "A String", # The ID of the account to which these account tax settings belong.
    121         },
    122         "merchantId": "A String", # The ID of the managing account.
    123         "accountId": "A String", # The ID of the account for which to get/update account tax settings.
    124       },
    125     ],
    126   }
    127 
    128   dryRun: boolean, Flag to run the request in dry-run mode.
    129 
    130 Returns:
    131   An object of the form:
    132 
    133     {
    134     "kind": "content#accounttaxCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponse".
    135     "entries": [ # The result of the execution of the batch requests.
    136       { # A batch entry encoding a single non-batch accounttax response.
    137         "batchId": 42, # The ID of the request entry this entry responds to.
    138         "accountTax": { # The tax settings of a merchant account. # The retrieved or updated account tax settings.
    139           "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    140             { # Tax calculation rule to apply in a state or province (USA only).
    141               "country": "A String", # Country code in which tax is applicable.
    142               "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
    143               "shippingTaxed": True or False, # If true, shipping charges are also taxed.
    144               "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
    145               "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    146             },
    147           ],
    148           "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    149           "accountId": "A String", # The ID of the account to which these account tax settings belong.
    150         },
    151         "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
    152           "message": "A String", # The message of the first error in errors.
    153           "code": 42, # The HTTP status of the first error in errors.
    154           "errors": [ # A list of errors.
    155             { # An error returned by the API.
    156               "reason": "A String", # The error code.
    157               "domain": "A String", # The domain of the error.
    158               "message": "A String", # A description of the error.
    159             },
    160           ],
    161         },
    162         "kind": "content#accounttaxCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry".
    163       },
    164     ],
    165   }</pre>
    166 </div>
    167 
    168 <div class="method">
    169     <code class="details" id="get">get(merchantId, accountId)</code>
    170   <pre>Retrieves the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
    171 
    172 Args:
    173   merchantId: string, The ID of the managing account. (required)
    174   accountId: string, The ID of the account for which to get/update account tax settings. (required)
    175 
    176 Returns:
    177   An object of the form:
    178 
    179     { # The tax settings of a merchant account.
    180     "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    181       { # Tax calculation rule to apply in a state or province (USA only).
    182         "country": "A String", # Country code in which tax is applicable.
    183         "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
    184         "shippingTaxed": True or False, # If true, shipping charges are also taxed.
    185         "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
    186         "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    187       },
    188     ],
    189     "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    190     "accountId": "A String", # The ID of the account to which these account tax settings belong.
    191   }</pre>
    192 </div>
    193 
    194 <div class="method">
    195     <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
    196   <pre>Lists the tax settings of the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
    197 
    198 Args:
    199   merchantId: string, The ID of the managing account. (required)
    200   pageToken: string, The token returned by the previous request.
    201   maxResults: integer, The maximum number of tax settings to return in the response, used for paging.
    202 
    203 Returns:
    204   An object of the form:
    205 
    206     {
    207     "nextPageToken": "A String", # The token for the retrieval of the next page of account tax settings.
    208     "kind": "content#accounttaxListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accounttaxListResponse".
    209     "resources": [
    210       { # The tax settings of a merchant account.
    211         "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    212           { # Tax calculation rule to apply in a state or province (USA only).
    213             "country": "A String", # Country code in which tax is applicable.
    214             "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
    215             "shippingTaxed": True or False, # If true, shipping charges are also taxed.
    216             "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
    217             "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    218           },
    219         ],
    220         "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    221         "accountId": "A String", # The ID of the account to which these account tax settings belong.
    222       },
    223     ],
    224   }</pre>
    225 </div>
    226 
    227 <div class="method">
    228     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    229   <pre>Retrieves the next page of results.
    230 
    231 Args:
    232   previous_request: The request for the previous page. (required)
    233   previous_response: The response from the request for the previous page. (required)
    234 
    235 Returns:
    236   A request object that you can call 'execute()' on to request the next
    237   page. Returns None if there are no more items in the collection.
    238     </pre>
    239 </div>
    240 
    241 <div class="method">
    242     <code class="details" id="patch">patch(merchantId, accountId, body, dryRun=None)</code>
    243   <pre>Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.
    244 
    245 Args:
    246   merchantId: string, The ID of the managing account. (required)
    247   accountId: string, The ID of the account for which to get/update account tax settings. (required)
    248   body: object, The request body. (required)
    249     The object takes the form of:
    250 
    251 { # The tax settings of a merchant account.
    252   "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    253     { # Tax calculation rule to apply in a state or province (USA only).
    254       "country": "A String", # Country code in which tax is applicable.
    255       "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
    256       "shippingTaxed": True or False, # If true, shipping charges are also taxed.
    257       "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
    258       "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    259     },
    260   ],
    261   "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    262   "accountId": "A String", # The ID of the account to which these account tax settings belong.
    263 }
    264 
    265   dryRun: boolean, Flag to run the request in dry-run mode.
    266 
    267 Returns:
    268   An object of the form:
    269 
    270     { # The tax settings of a merchant account.
    271     "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    272       { # Tax calculation rule to apply in a state or province (USA only).
    273         "country": "A String", # Country code in which tax is applicable.
    274         "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
    275         "shippingTaxed": True or False, # If true, shipping charges are also taxed.
    276         "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
    277         "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    278       },
    279     ],
    280     "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    281     "accountId": "A String", # The ID of the account to which these account tax settings belong.
    282   }</pre>
    283 </div>
    284 
    285 <div class="method">
    286     <code class="details" id="update">update(merchantId, accountId, body, dryRun=None)</code>
    287   <pre>Updates the tax settings of the account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
    288 
    289 Args:
    290   merchantId: string, The ID of the managing account. (required)
    291   accountId: string, The ID of the account for which to get/update account tax settings. (required)
    292   body: object, The request body. (required)
    293     The object takes the form of:
    294 
    295 { # The tax settings of a merchant account.
    296   "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    297     { # Tax calculation rule to apply in a state or province (USA only).
    298       "country": "A String", # Country code in which tax is applicable.
    299       "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
    300       "shippingTaxed": True or False, # If true, shipping charges are also taxed.
    301       "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
    302       "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    303     },
    304   ],
    305   "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    306   "accountId": "A String", # The ID of the account to which these account tax settings belong.
    307 }
    308 
    309   dryRun: boolean, Flag to run the request in dry-run mode.
    310 
    311 Returns:
    312   An object of the form:
    313 
    314     { # The tax settings of a merchant account.
    315     "rules": [ # Tax rules. Updating the tax rules will enable US taxes (not reversible). Defining no rules is equivalent to not charging tax at all.
    316       { # Tax calculation rule to apply in a state or province (USA only).
    317         "country": "A String", # Country code in which tax is applicable.
    318         "ratePercent": "A String", # Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.
    319         "shippingTaxed": True or False, # If true, shipping charges are also taxed.
    320         "locationId": "A String", # State (or province) is which the tax is applicable, described by its location id (also called criteria id).
    321         "useGlobalRate": True or False, # Whether the tax rate is taken from a global tax table or specified explicitly.
    322       },
    323     ],
    324     "kind": "content#accountTax", # Identifies what kind of resource this is. Value: the fixed string "content#accountTax".
    325     "accountId": "A String", # The ID of the account to which these account tax settings belong.
    326   }</pre>
    327 </div>
    328 
    329 </body></html>