Close httplib2 connections.
custombatch(body=None, x__xgafv=None)
Retrieves and/or updates the LIA settings of multiple accounts in a single request.
get(merchantId, accountId, x__xgafv=None)
Retrieves the LIA settings of the account.
getaccessiblegmbaccounts(merchantId, accountId, x__xgafv=None)
Retrieves the list of accessible Business Profiles.
list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)
Lists the LIA settings of the sub-accounts in your Merchant Center account.
list_next(previous_request, previous_response)
Retrieves the next page of results.
listposdataproviders(x__xgafv=None)
Retrieves the list of POS data providers that have active settings for the all eiligible countries.
requestgmbaccess(merchantId, accountId, gmbEmail, x__xgafv=None)
Requests access to a specified Business Profile.
requestinventoryverification(merchantId, accountId, country, x__xgafv=None)
Requests inventory validation for the specified country.
Sets the inventory verification contract for the specified country.
Sets the POS data provider for the specified country.
update(merchantId, accountId, body=None, x__xgafv=None)
Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.
close()
Close httplib2 connections.
custombatch(body=None, x__xgafv=None)
Retrieves and/or updates the LIA settings of multiple accounts 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.
{
"accountId": "A String", # The ID of the account for which to get/update account LIA settings.
"batchId": 42, # An entry ID, unique within the batch request.
"contactEmail": "A String", # Inventory validation contact email. Required only for SetInventoryValidationContact.
"contactName": "A String", # Inventory validation contact name. Required only for SetInventoryValidationContact.
"country": "A String", # The country code. Required only for RequestInventoryVerification.
"gmbEmail": "A String", # The Business Profile. Required only for RequestGmbAccess.
"liaSettings": { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. # The account Lia settings to update. Only defined if the method is `update`.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (e.g. "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
},
"merchantId": "A String", # The ID of the managing account.
"method": "A String", # The method of the batch entry. Acceptable values are: - "`get`" - "`getAccessibleGmbAccounts`" - "`requestGmbAccess`" - "`requestInventoryVerification`" - "`setInventoryVerificationContact`" - "`update`"
"posDataProviderId": "A String", # The ID of POS data provider. Required only for SetPosProvider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS provider.
},
],
}
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`.
},
"gmbAccounts": { # The list of accessible Business Profiles.
"accountId": "A String", # The ID of the Merchant Center account.
"gmbAccounts": [ # A list of Business Profiles which are available to the merchant.
{
"email": "A String", # The email which identifies the Business Profile.
"listingCount": "A String", # Number of listings under this account.
"name": "A String", # The name of the Business Profile.
"type": "A String", # The type of the Business Profile (User or Business).
},
],
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsCustomBatchResponseEntry`"
"liaSettings": { # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role. # The retrieved or updated Lia settings.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (e.g. "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
},
"posDataProviders": [ # The list of POS data providers.
{
"country": "A String", # Country code.
"posDataProviders": [ # A list of POS data providers.
{
"displayName": "A String", # The display name of Pos data Provider.
"fullName": "A String", # The full name of this POS data Provider.
"providerId": "A String", # The ID of the account.
},
],
},
],
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsCustomBatchResponse`".
}
get(merchantId, accountId, x__xgafv=None)
Retrieves the LIA settings of the account.
Args:
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)
accountId: string, The ID of the account for which to get or update LIA settings. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (e.g. "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
}
getaccessiblegmbaccounts(merchantId, accountId, x__xgafv=None)
Retrieves the list of accessible Business Profiles.
Args:
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)
accountId: string, The ID of the account for which to retrieve accessible Business Profiles. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"accountId": "A String", # The ID of the Merchant Center account.
"gmbAccounts": [ # A list of Business Profiles which are available to the merchant.
{
"email": "A String", # The email which identifies the Business Profile.
"listingCount": "A String", # Number of listings under this account.
"name": "A String", # The name of the Business Profile.
"type": "A String", # The type of the Business Profile (User or Business).
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsGetAccessibleGmbAccountsResponse`".
}
list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)
Lists the LIA settings of the sub-accounts in your Merchant Center account.
Args:
merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
maxResults: integer, The maximum number of LIA settings to return 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#liasettingsListResponse`".
"nextPageToken": "A String", # The token for the retrieval of the next page of LIA settings.
"resources": [
{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (e.g. "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
},
],
}
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.
listposdataproviders(x__xgafv=None)
Retrieves the list of POS data providers that have active settings for the all eiligible countries.
Args:
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#liasettingsListPosDataProvidersResponse`".
"posDataProviders": [ # The list of POS data providers for each eligible country
{
"country": "A String", # Country code.
"posDataProviders": [ # A list of POS data providers.
{
"displayName": "A String", # The display name of Pos data Provider.
"fullName": "A String", # The full name of this POS data Provider.
"providerId": "A String", # The ID of the account.
},
],
},
],
}
requestgmbaccess(merchantId, accountId, gmbEmail, x__xgafv=None)
Requests access to a specified Business Profile.
Args:
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)
accountId: string, The ID of the account for which Business Profile access is requested. (required)
gmbEmail: string, The email of the Business Profile. (required)
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#liasettingsRequestGmbAccessResponse`".
}
requestinventoryverification(merchantId, accountId, country, x__xgafv=None)
Requests inventory validation for the specified country.
Args:
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)
accountId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
country: string, The country for which inventory validation is requested. (required)
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#liasettingsRequestInventoryVerificationResponse`".
}
setinventoryverificationcontact(merchantId, accountId, country, language, contactName, contactEmail, x__xgafv=None)
Sets the inventory verification contract for the specified country.
Args:
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)
accountId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
country: string, The country for which inventory verification is requested. (required)
language: string, The language for which inventory verification is requested. (required)
contactName: string, The name of the inventory verification contact. (required)
contactEmail: string, The email of the inventory verification contact. (required)
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#liasettingsSetInventoryVerificationContactResponse`".
}
setposdataprovider(merchantId, accountId, country, posDataProviderId=None, posExternalAccountId=None, x__xgafv=None)
Sets the POS data provider for the specified country.
Args:
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)
accountId: string, The ID of the account for which to retrieve accessible Business Profiles. (required)
country: string, The country for which the POS data provider is selected. (required)
posDataProviderId: string, The ID of POS data provider.
posExternalAccountId: string, The account ID by which this merchant is known to the POS data provider.
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#liasettingsSetPosDataProviderResponse`".
}
update(merchantId, accountId, body=None, x__xgafv=None)
Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.
Args:
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)
accountId: string, The ID of the account for which to get or update LIA settings. (required)
body: object, The request body.
The object takes the form of:
{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (e.g. "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.
"accountId": "A String", # The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.
"countrySettings": [ # The LIA settings for each country.
{
"about": { # The settings for the About page.
"status": "A String", # The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"url": "A String", # The URL for the About page.
},
"country": "A String", # Required. CLDR country code (e.g. "US").
"hostedLocalStorefrontActive": True or False, # The status of the "Merchant hosted local storefront" feature.
"inventory": { # LIA inventory verification settings.
"inventoryVerificationContactEmail": "A String", # The email of the contact for the inventory verification process.
"inventoryVerificationContactName": "A String", # The name of the contact for the inventory verification process.
"inventoryVerificationContactStatus": "A String", # The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
"status": "A String", # The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"onDisplayToOrder": { # LIA "On Display To Order" settings.
"shippingCostPolicyUrl": "A String", # Shipping cost and policy URL.
"status": "A String", # The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`"
},
"posDataProvider": { # The POS data provider linked with this country.
"posDataProviderId": "A String", # The ID of the POS data provider.
"posExternalAccountId": "A String", # The account ID by which this merchant is known to the POS data provider.
},
"storePickupActive": True or False, # The status of the "Store pickup" feature.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`"
}