Close httplib2 connections.
Batches multiple return address related calls in a single request.
delete(merchantId, returnAddressId)
Deletes a return address for the given Merchant Center account.
get(merchantId, returnAddressId)
Gets a return address of the Merchant Center account.
Inserts a return address for the Merchant Center account.
list(merchantId, country=None, maxResults=None, pageToken=None)
Lists the return addresses of the Merchant Center account.
list_next(previous_request, previous_response)
Retrieves the next page of results.
close()
Close httplib2 connections.
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.
"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. Set this 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": "content#returnAddress", # 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. Set this only if the method is `delete` or `get`.
},
],
}
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": "content#returnaddressCustomBatchResponseEntry", # 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": "content#returnAddress", # 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": "content#returnaddressCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#returnaddressCustomBatchResponse".
}
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.
"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": "content#returnAddress", # 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.
}
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.
"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": "content#returnAddress", # 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.
}
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": "content#returnAddress", # 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.
}
list(merchantId, country=None, maxResults=None, pageToken=None)
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.
Returns:
An object of the form:
{
"kind": "content#returnaddressListResponse", # 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": "content#returnAddress", # 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.
},
],
}
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.