| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.returnaddress.html">returnaddress</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Batches multiple return address related calls in a single request.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(merchantId, returnAddressId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a return address for the given Merchant Center account.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(merchantId, returnAddressId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a return address of the Merchant Center account.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(merchantId, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Inserts a return address for the Merchant Center account.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(merchantId, country=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the return addresses of the Merchant Center account.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="custombatch">custombatch(body=None, x__xgafv=None)</code> |
| <pre>Batches multiple return address related calls in a single request. |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "entries": [ # The request entries to be processed in the batch. |
| { |
| "batchId": 42, # An entry ID, unique within the batch request. |
| "merchantId": "A String", # The Merchant Center account ID. |
| "method": "A String", # Method of the batch request entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" |
| "returnAddress": { # Return address resource. # The return address to submit. This should be set only if the method is `insert`. |
| "address": { # Required. The address. |
| "country": "A String", # CLDR country code (e.g. "US"). |
| "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| "recipientName": "A String", # Name of the recipient to address returns to. |
| "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. |
| "A String", |
| ], |
| }, |
| "country": "A String", # Required. The country of sale where the return address is applicable. |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" |
| "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". |
| "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. |
| "returnAddressId": "A String", # Return address ID generated by Google. |
| }, |
| "returnAddressId": "A String", # The return address ID. This should be set only if the method is `delete` or `get`. |
| }, |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "entries": [ # The result of the execution of the batch requests. |
| { |
| "batchId": 42, # The ID of the request entry to which this entry responds. |
| "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed. |
| "code": 42, # The HTTP status of the first error in `errors`. |
| "errors": [ # A list of errors. |
| { # An error returned by the API. |
| "domain": "A String", # The domain of the error. |
| "message": "A String", # A description of the error. |
| "reason": "A String", # The error code. |
| }, |
| ], |
| "message": "A String", # The message of the first error in `errors`. |
| }, |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnaddressCustomBatchResponseEntry`" |
| "returnAddress": { # Return address resource. # The retrieved return address. |
| "address": { # Required. The address. |
| "country": "A String", # CLDR country code (e.g. "US"). |
| "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| "recipientName": "A String", # Name of the recipient to address returns to. |
| "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. |
| "A String", |
| ], |
| }, |
| "country": "A String", # Required. The country of sale where the return address is applicable. |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" |
| "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". |
| "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. |
| "returnAddressId": "A String", # Return address ID generated by Google. |
| }, |
| }, |
| ], |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnaddressCustomBatchResponse`". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(merchantId, returnAddressId, x__xgafv=None)</code> |
| <pre>Deletes a return address for the given Merchant Center account. |
| |
| Args: |
| merchantId: string, The Merchant Center account from which to delete the given return address. (required) |
| returnAddressId: string, Return address ID generated by Google. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(merchantId, returnAddressId, x__xgafv=None)</code> |
| <pre>Gets a return address of the Merchant Center account. |
| |
| Args: |
| merchantId: string, The Merchant Center account to get a return address for. (required) |
| returnAddressId: string, Return address ID generated by Google. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Return address resource. |
| "address": { # Required. The address. |
| "country": "A String", # CLDR country code (e.g. "US"). |
| "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| "recipientName": "A String", # Name of the recipient to address returns to. |
| "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. |
| "A String", |
| ], |
| }, |
| "country": "A String", # Required. The country of sale where the return address is applicable. |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" |
| "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". |
| "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. |
| "returnAddressId": "A String", # Return address ID generated by Google. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(merchantId, body=None, x__xgafv=None)</code> |
| <pre>Inserts a return address for the Merchant Center account. |
| |
| Args: |
| merchantId: string, The Merchant Center account to insert a return address for. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Return address resource. |
| "address": { # Required. The address. |
| "country": "A String", # CLDR country code (e.g. "US"). |
| "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| "recipientName": "A String", # Name of the recipient to address returns to. |
| "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. |
| "A String", |
| ], |
| }, |
| "country": "A String", # Required. The country of sale where the return address is applicable. |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" |
| "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". |
| "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. |
| "returnAddressId": "A String", # Return address ID generated by Google. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Return address resource. |
| "address": { # Required. The address. |
| "country": "A String", # CLDR country code (e.g. "US"). |
| "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| "recipientName": "A String", # Name of the recipient to address returns to. |
| "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. |
| "A String", |
| ], |
| }, |
| "country": "A String", # Required. The country of sale where the return address is applicable. |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" |
| "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". |
| "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. |
| "returnAddressId": "A String", # Return address ID generated by Google. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(merchantId, country=None, maxResults=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists the return addresses of the Merchant Center account. |
| |
| Args: |
| merchantId: string, The Merchant Center account to list return addresses for. (required) |
| country: string, List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed. |
| maxResults: integer, The maximum number of addresses in the response, used for paging. |
| pageToken: string, The token returned by the previous request. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnaddressListResponse`". |
| "nextPageToken": "A String", # The token for the retrieval of the next page of addresses. |
| "resources": [ |
| { # Return address resource. |
| "address": { # Required. The address. |
| "country": "A String", # CLDR country code (e.g. "US"). |
| "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). |
| "postalCode": "A String", # Postal code or ZIP (e.g. "94043"). |
| "recipientName": "A String", # Name of the recipient to address returns to. |
| "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). |
| "streetAddress": [ # Street-level part of the address. May be up to two lines, each line specified as an array element. |
| "A String", |
| ], |
| }, |
| "country": "A String", # Required. The country of sale where the return address is applicable. |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" |
| "label": "A String", # Required. The user-defined label of the return address. For the default address, use the label "default". |
| "phoneNumber": "A String", # Required. The merchant's contact phone number regarding the return. |
| "returnAddressId": "A String", # Return address ID generated by Google. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
