Content API for Shopping . 1 . returnaddress

custombatch(body=None)

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.
        "returnAddress": { # Return address resource. # The return address to submit. Set this only if the method is insert.
            "kind": "content#returnAddress", # Identifies what kind of resource this is. Value: the fixed string "content#returnAddress".
            "country": "A String", # The country of sale where the return address is applicable.
            "returnAddressId": "A String", # Return address ID generated by Google.
            "label": "A String", # The user-defined label of the return address. For the default address, use the label "default".
            "phoneNumber": "A String", # The merchant's contact phone number regarding the return.
            "address": { # The address.
              "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
              "country": "A String", # CLDR country code (e.g. "US").
              "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",
              ],
              "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
              "recipientName": "A String", # Name of the recipient to address returns to.
            },
          },
        "merchantId": "A String", # The Merchant Center account ID.
        "returnAddressId": "A String", # The return address ID. Set this only if the method is delete or get.
        "method": "A String",
      },
    ],
  }


Returns:
  An object of the form:

    {
    "kind": "content#returnaddressCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#returnaddressCustomBatchResponse".
    "entries": [ # The result of the execution of the batch requests.
      {
        "batchId": 42, # The ID of the request entry to which this entry responds.
        "kind": "content#returnaddressCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#returnaddressCustomBatchResponseEntry".
        "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if, and only if, the request failed.
          "message": "A String", # The message of the first error in errors.
          "code": 42, # The HTTP status of the first error in errors.
          "errors": [ # A list of errors.
            { # An error returned by the API.
              "reason": "A String", # The error code.
              "domain": "A String", # The domain of the error.
              "message": "A String", # A description of the error.
            },
          ],
        },
        "returnAddress": { # Return address resource. # The retrieved return address.
            "kind": "content#returnAddress", # Identifies what kind of resource this is. Value: the fixed string "content#returnAddress".
            "country": "A String", # The country of sale where the return address is applicable.
            "returnAddressId": "A String", # Return address ID generated by Google.
            "label": "A String", # The user-defined label of the return address. For the default address, use the label "default".
            "phoneNumber": "A String", # The merchant's contact phone number regarding the return.
            "address": { # The address.
              "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
              "country": "A String", # CLDR country code (e.g. "US").
              "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",
              ],
              "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
              "recipientName": "A String", # Name of the recipient to address returns to.
            },
          },
      },
    ],
  }

delete(merchantId=*, returnAddressId=*)

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)

get(merchantId=*, returnAddressId=*)

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)

Returns:
  An object of the form:

    { # Return address resource.
      "kind": "content#returnAddress", # Identifies what kind of resource this is. Value: the fixed string "content#returnAddress".
      "country": "A String", # The country of sale where the return address is applicable.
      "returnAddressId": "A String", # Return address ID generated by Google.
      "label": "A String", # The user-defined label of the return address. For the default address, use the label "default".
      "phoneNumber": "A String", # The merchant's contact phone number regarding the return.
      "address": { # The address.
        "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
        "country": "A String", # CLDR country code (e.g. "US").
        "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",
        ],
        "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
        "recipientName": "A String", # Name of the recipient to address returns to.
      },
    }

insert(merchantId=*, body=None)

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.
    "kind": "content#returnAddress", # Identifies what kind of resource this is. Value: the fixed string "content#returnAddress".
    "country": "A String", # The country of sale where the return address is applicable.
    "returnAddressId": "A String", # Return address ID generated by Google.
    "label": "A String", # The user-defined label of the return address. For the default address, use the label "default".
    "phoneNumber": "A String", # The merchant's contact phone number regarding the return.
    "address": { # The address.
      "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
      "country": "A String", # CLDR country code (e.g. "US").
      "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",
      ],
      "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
      "recipientName": "A String", # Name of the recipient to address returns to.
    },
  }


Returns:
  An object of the form:

    { # Return address resource.
      "kind": "content#returnAddress", # Identifies what kind of resource this is. Value: the fixed string "content#returnAddress".
      "country": "A String", # The country of sale where the return address is applicable.
      "returnAddressId": "A String", # Return address ID generated by Google.
      "label": "A String", # The user-defined label of the return address. For the default address, use the label "default".
      "phoneNumber": "A String", # The merchant's contact phone number regarding the return.
      "address": { # The address.
        "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
        "country": "A String", # CLDR country code (e.g. "US").
        "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",
        ],
        "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
        "recipientName": "A String", # Name of the recipient to address returns to.
      },
    }

list(merchantId=*, pageToken=None, country=None, maxResults=None)

Lists the return addresses of the Merchant Center account.

Args:
  merchantId: string, The Merchant Center account to list return addresses for. (required)
  pageToken: string, The token returned by the previous request.
  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.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # The token for the retrieval of the next page of addresses.
    "kind": "content#returnaddressListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#returnaddressListResponse".
    "resources": [
      { # Return address resource.
          "kind": "content#returnAddress", # Identifies what kind of resource this is. Value: the fixed string "content#returnAddress".
          "country": "A String", # The country of sale where the return address is applicable.
          "returnAddressId": "A String", # Return address ID generated by Google.
          "label": "A String", # The user-defined label of the return address. For the default address, use the label "default".
          "phoneNumber": "A String", # The merchant's contact phone number regarding the return.
          "address": { # The address.
            "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
            "country": "A String", # CLDR country code (e.g. "US").
            "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",
            ],
            "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
            "recipientName": "A String", # Name of the recipient to address returns to.
          },
        },
    ],
  }

list_next(previous_request=*, previous_response=*)

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.