Returns the lfpProviders Resource.
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Create the omnichannel settings for a given merchant.
Get the omnichannel settings for a given merchant.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all the omnichannel settings for a given merchant.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Update the omnichannel setting for a given merchant in a given country.
requestInventoryVerification(name, body=None, x__xgafv=None)
Requests inventory verification for a given merchant in a given country.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Create the omnichannel settings for a given merchant.
Args:
parent: string, Required. The parent resource where this omnichannel setting will be created. Format: `accounts/{account}` (required)
body: object, The request body.
The object takes the form of:
{ # Collection of information related to the omnichannel settings of a merchant.
"about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The about page URI.
},
"inStock": { # Collection of information related to InStock. # Optional. The InStock URI and state for this country.
"state": "A String", # Output only. The state of the in-stock serving.
"uri": "A String", # Optional. Product landing page URI. It is only used for the review of MHLSF in-stock serving. This URI domain should match with the business's homepage. Required to be empty if the lsf_type is GHLSF, and required when the lsf_type is MHLSF_FULL or MHLSF_BASIC.
},
"inventoryVerification": { # Collection of information related to [inventory verification](https://support.google.com/merchants/answer/14684499?ref_topic=15145634&sjid=6892280366904591178-NC). # Optional. The inventory verification contact and state for this country.
"contact": "A String", # Required. The name of the contact for the inventory verification process.
"contactEmail": "A String", # Required. The email address of the contact for the inventory verification process.
"contactState": "A String", # Output only. The state of the contact verification.
"state": "A String", # Output only. The state of the inventory verification process.
},
"lfpLink": { # Collection of information related to the LFP link. # Output only. The established link to a LFP provider.
"externalAccountId": "A String", # Required. The account ID by which this merchant is known to the LFP provider.
"lfpProvider": "A String", # Required. The resource name of the LFP provider. Format: `lfpProviders/{lfp_provider}`
"state": "A String", # Output only. The state of the LFP link.
},
"lsfType": "A String", # Required. The Local Store Front type for this country.
"name": "A String", # Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
"odo": { # Collection of information related to the on display to order ([ODO](https://support.google.com/merchants/answer/14615056?ref_topic=15145747&sjid=6892280366904591178-NC)). # Optional. The On Display to Order (ODO) policy URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The on display to order (ODO) policy URI.
},
"pickup": { # Collection of information related to Pickup. # Optional. The Pickup URI and state for this country.
"state": "A String", # Output only. The state of the pickup serving.
"uri": "A String", # Required. Pickup product page URI. It is only used for the review of pickup serving. This URI domain should match with the business's homepage.
},
"regionCode": "A String", # Required. Immutable. Region code defined by [CLDR](https://cldr.unicode.org/). Must be provided in the Create method, and is immutable.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Collection of information related to the omnichannel settings of a merchant.
"about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The about page URI.
},
"inStock": { # Collection of information related to InStock. # Optional. The InStock URI and state for this country.
"state": "A String", # Output only. The state of the in-stock serving.
"uri": "A String", # Optional. Product landing page URI. It is only used for the review of MHLSF in-stock serving. This URI domain should match with the business's homepage. Required to be empty if the lsf_type is GHLSF, and required when the lsf_type is MHLSF_FULL or MHLSF_BASIC.
},
"inventoryVerification": { # Collection of information related to [inventory verification](https://support.google.com/merchants/answer/14684499?ref_topic=15145634&sjid=6892280366904591178-NC). # Optional. The inventory verification contact and state for this country.
"contact": "A String", # Required. The name of the contact for the inventory verification process.
"contactEmail": "A String", # Required. The email address of the contact for the inventory verification process.
"contactState": "A String", # Output only. The state of the contact verification.
"state": "A String", # Output only. The state of the inventory verification process.
},
"lfpLink": { # Collection of information related to the LFP link. # Output only. The established link to a LFP provider.
"externalAccountId": "A String", # Required. The account ID by which this merchant is known to the LFP provider.
"lfpProvider": "A String", # Required. The resource name of the LFP provider. Format: `lfpProviders/{lfp_provider}`
"state": "A String", # Output only. The state of the LFP link.
},
"lsfType": "A String", # Required. The Local Store Front type for this country.
"name": "A String", # Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
"odo": { # Collection of information related to the on display to order ([ODO](https://support.google.com/merchants/answer/14615056?ref_topic=15145747&sjid=6892280366904591178-NC)). # Optional. The On Display to Order (ODO) policy URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The on display to order (ODO) policy URI.
},
"pickup": { # Collection of information related to Pickup. # Optional. The Pickup URI and state for this country.
"state": "A String", # Output only. The state of the pickup serving.
"uri": "A String", # Required. Pickup product page URI. It is only used for the review of pickup serving. This URI domain should match with the business's homepage.
},
"regionCode": "A String", # Required. Immutable. Region code defined by [CLDR](https://cldr.unicode.org/). Must be provided in the Create method, and is immutable.
}
get(name, x__xgafv=None)
Get the omnichannel settings for a given merchant.
Args:
name: string, Required. The name of the omnichannel setting to retrieve. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Collection of information related to the omnichannel settings of a merchant.
"about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The about page URI.
},
"inStock": { # Collection of information related to InStock. # Optional. The InStock URI and state for this country.
"state": "A String", # Output only. The state of the in-stock serving.
"uri": "A String", # Optional. Product landing page URI. It is only used for the review of MHLSF in-stock serving. This URI domain should match with the business's homepage. Required to be empty if the lsf_type is GHLSF, and required when the lsf_type is MHLSF_FULL or MHLSF_BASIC.
},
"inventoryVerification": { # Collection of information related to [inventory verification](https://support.google.com/merchants/answer/14684499?ref_topic=15145634&sjid=6892280366904591178-NC). # Optional. The inventory verification contact and state for this country.
"contact": "A String", # Required. The name of the contact for the inventory verification process.
"contactEmail": "A String", # Required. The email address of the contact for the inventory verification process.
"contactState": "A String", # Output only. The state of the contact verification.
"state": "A String", # Output only. The state of the inventory verification process.
},
"lfpLink": { # Collection of information related to the LFP link. # Output only. The established link to a LFP provider.
"externalAccountId": "A String", # Required. The account ID by which this merchant is known to the LFP provider.
"lfpProvider": "A String", # Required. The resource name of the LFP provider. Format: `lfpProviders/{lfp_provider}`
"state": "A String", # Output only. The state of the LFP link.
},
"lsfType": "A String", # Required. The Local Store Front type for this country.
"name": "A String", # Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
"odo": { # Collection of information related to the on display to order ([ODO](https://support.google.com/merchants/answer/14615056?ref_topic=15145747&sjid=6892280366904591178-NC)). # Optional. The On Display to Order (ODO) policy URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The on display to order (ODO) policy URI.
},
"pickup": { # Collection of information related to Pickup. # Optional. The Pickup URI and state for this country.
"state": "A String", # Output only. The state of the pickup serving.
"uri": "A String", # Required. Pickup product page URI. It is only used for the review of pickup serving. This URI domain should match with the business's homepage.
},
"regionCode": "A String", # Required. Immutable. Region code defined by [CLDR](https://cldr.unicode.org/). Must be provided in the Create method, and is immutable.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all the omnichannel settings for a given merchant.
Args:
parent: string, Required. The parent, which owns this collection of omnichannel settings. Format: `accounts/{account}` (required)
pageSize: integer, Optional. The maximum number of omnichannel settings to return. The service may return fewer than this value. If unspecified, at most 50 omnichannel settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListOmnichannelSettings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOmnichannelSettings` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the ListOmnichannelSettings method.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"omnichannelSettings": [ # The omnichannel settings from the specified merchant.
{ # Collection of information related to the omnichannel settings of a merchant.
"about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The about page URI.
},
"inStock": { # Collection of information related to InStock. # Optional. The InStock URI and state for this country.
"state": "A String", # Output only. The state of the in-stock serving.
"uri": "A String", # Optional. Product landing page URI. It is only used for the review of MHLSF in-stock serving. This URI domain should match with the business's homepage. Required to be empty if the lsf_type is GHLSF, and required when the lsf_type is MHLSF_FULL or MHLSF_BASIC.
},
"inventoryVerification": { # Collection of information related to [inventory verification](https://support.google.com/merchants/answer/14684499?ref_topic=15145634&sjid=6892280366904591178-NC). # Optional. The inventory verification contact and state for this country.
"contact": "A String", # Required. The name of the contact for the inventory verification process.
"contactEmail": "A String", # Required. The email address of the contact for the inventory verification process.
"contactState": "A String", # Output only. The state of the contact verification.
"state": "A String", # Output only. The state of the inventory verification process.
},
"lfpLink": { # Collection of information related to the LFP link. # Output only. The established link to a LFP provider.
"externalAccountId": "A String", # Required. The account ID by which this merchant is known to the LFP provider.
"lfpProvider": "A String", # Required. The resource name of the LFP provider. Format: `lfpProviders/{lfp_provider}`
"state": "A String", # Output only. The state of the LFP link.
},
"lsfType": "A String", # Required. The Local Store Front type for this country.
"name": "A String", # Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
"odo": { # Collection of information related to the on display to order ([ODO](https://support.google.com/merchants/answer/14615056?ref_topic=15145747&sjid=6892280366904591178-NC)). # Optional. The On Display to Order (ODO) policy URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The on display to order (ODO) policy URI.
},
"pickup": { # Collection of information related to Pickup. # Optional. The Pickup URI and state for this country.
"state": "A String", # Output only. The state of the pickup serving.
"uri": "A String", # Required. Pickup product page URI. It is only used for the review of pickup serving. This URI domain should match with the business's homepage.
},
"regionCode": "A String", # Required. Immutable. Region code defined by [CLDR](https://cldr.unicode.org/). Must be provided in the Create method, and is immutable.
},
],
}
list_next()
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.
patch(name, body=None, updateMask=None, x__xgafv=None)
Update the omnichannel setting for a given merchant in a given country.
Args:
name: string, Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}` (required)
body: object, The request body.
The object takes the form of:
{ # Collection of information related to the omnichannel settings of a merchant.
"about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The about page URI.
},
"inStock": { # Collection of information related to InStock. # Optional. The InStock URI and state for this country.
"state": "A String", # Output only. The state of the in-stock serving.
"uri": "A String", # Optional. Product landing page URI. It is only used for the review of MHLSF in-stock serving. This URI domain should match with the business's homepage. Required to be empty if the lsf_type is GHLSF, and required when the lsf_type is MHLSF_FULL or MHLSF_BASIC.
},
"inventoryVerification": { # Collection of information related to [inventory verification](https://support.google.com/merchants/answer/14684499?ref_topic=15145634&sjid=6892280366904591178-NC). # Optional. The inventory verification contact and state for this country.
"contact": "A String", # Required. The name of the contact for the inventory verification process.
"contactEmail": "A String", # Required. The email address of the contact for the inventory verification process.
"contactState": "A String", # Output only. The state of the contact verification.
"state": "A String", # Output only. The state of the inventory verification process.
},
"lfpLink": { # Collection of information related to the LFP link. # Output only. The established link to a LFP provider.
"externalAccountId": "A String", # Required. The account ID by which this merchant is known to the LFP provider.
"lfpProvider": "A String", # Required. The resource name of the LFP provider. Format: `lfpProviders/{lfp_provider}`
"state": "A String", # Output only. The state of the LFP link.
},
"lsfType": "A String", # Required. The Local Store Front type for this country.
"name": "A String", # Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
"odo": { # Collection of information related to the on display to order ([ODO](https://support.google.com/merchants/answer/14615056?ref_topic=15145747&sjid=6892280366904591178-NC)). # Optional. The On Display to Order (ODO) policy URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The on display to order (ODO) policy URI.
},
"pickup": { # Collection of information related to Pickup. # Optional. The Pickup URI and state for this country.
"state": "A String", # Output only. The state of the pickup serving.
"uri": "A String", # Required. Pickup product page URI. It is only used for the review of pickup serving. This URI domain should match with the business's homepage.
},
"regionCode": "A String", # Required. Immutable. Region code defined by [CLDR](https://cldr.unicode.org/). Must be provided in the Create method, and is immutable.
}
updateMask: string, Required. The list of fields to be updated. The following fields are supported in snake_case only: - `lsf_type` - `in_stock` - `pickup` - `odo` - `about` - `inventory_verification` Full replacement with wildcard `*`is supported, while empty/implied update mask is not.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Collection of information related to the omnichannel settings of a merchant.
"about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The about page URI.
},
"inStock": { # Collection of information related to InStock. # Optional. The InStock URI and state for this country.
"state": "A String", # Output only. The state of the in-stock serving.
"uri": "A String", # Optional. Product landing page URI. It is only used for the review of MHLSF in-stock serving. This URI domain should match with the business's homepage. Required to be empty if the lsf_type is GHLSF, and required when the lsf_type is MHLSF_FULL or MHLSF_BASIC.
},
"inventoryVerification": { # Collection of information related to [inventory verification](https://support.google.com/merchants/answer/14684499?ref_topic=15145634&sjid=6892280366904591178-NC). # Optional. The inventory verification contact and state for this country.
"contact": "A String", # Required. The name of the contact for the inventory verification process.
"contactEmail": "A String", # Required. The email address of the contact for the inventory verification process.
"contactState": "A String", # Output only. The state of the contact verification.
"state": "A String", # Output only. The state of the inventory verification process.
},
"lfpLink": { # Collection of information related to the LFP link. # Output only. The established link to a LFP provider.
"externalAccountId": "A String", # Required. The account ID by which this merchant is known to the LFP provider.
"lfpProvider": "A String", # Required. The resource name of the LFP provider. Format: `lfpProviders/{lfp_provider}`
"state": "A String", # Output only. The state of the LFP link.
},
"lsfType": "A String", # Required. The Local Store Front type for this country.
"name": "A String", # Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
"odo": { # Collection of information related to the on display to order ([ODO](https://support.google.com/merchants/answer/14615056?ref_topic=15145747&sjid=6892280366904591178-NC)). # Optional. The On Display to Order (ODO) policy URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The on display to order (ODO) policy URI.
},
"pickup": { # Collection of information related to Pickup. # Optional. The Pickup URI and state for this country.
"state": "A String", # Output only. The state of the pickup serving.
"uri": "A String", # Required. Pickup product page URI. It is only used for the review of pickup serving. This URI domain should match with the business's homepage.
},
"regionCode": "A String", # Required. Immutable. Region code defined by [CLDR](https://cldr.unicode.org/). Must be provided in the Create method, and is immutable.
}
requestInventoryVerification(name, body=None, x__xgafv=None)
Requests inventory verification for a given merchant in a given country.
Args:
name: string, Required. The name of the omnichannel setting to request inventory verification. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the RequestInventoryVerification method.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the RequestInventoryVerification method.
"omnichannelSetting": { # Collection of information related to the omnichannel settings of a merchant. # The omnichannel setting that was updated.
"about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The about page URI.
},
"inStock": { # Collection of information related to InStock. # Optional. The InStock URI and state for this country.
"state": "A String", # Output only. The state of the in-stock serving.
"uri": "A String", # Optional. Product landing page URI. It is only used for the review of MHLSF in-stock serving. This URI domain should match with the business's homepage. Required to be empty if the lsf_type is GHLSF, and required when the lsf_type is MHLSF_FULL or MHLSF_BASIC.
},
"inventoryVerification": { # Collection of information related to [inventory verification](https://support.google.com/merchants/answer/14684499?ref_topic=15145634&sjid=6892280366904591178-NC). # Optional. The inventory verification contact and state for this country.
"contact": "A String", # Required. The name of the contact for the inventory verification process.
"contactEmail": "A String", # Required. The email address of the contact for the inventory verification process.
"contactState": "A String", # Output only. The state of the contact verification.
"state": "A String", # Output only. The state of the inventory verification process.
},
"lfpLink": { # Collection of information related to the LFP link. # Output only. The established link to a LFP provider.
"externalAccountId": "A String", # Required. The account ID by which this merchant is known to the LFP provider.
"lfpProvider": "A String", # Required. The resource name of the LFP provider. Format: `lfpProviders/{lfp_provider}`
"state": "A String", # Output only. The state of the LFP link.
},
"lsfType": "A String", # Required. The Local Store Front type for this country.
"name": "A String", # Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
"odo": { # Collection of information related to the on display to order ([ODO](https://support.google.com/merchants/answer/14615056?ref_topic=15145747&sjid=6892280366904591178-NC)). # Optional. The On Display to Order (ODO) policy URI and state for this country.
"state": "A String", # Output only. The state of the URI.
"uri": "A String", # Required. The on display to order (ODO) policy URI.
},
"pickup": { # Collection of information related to Pickup. # Optional. The Pickup URI and state for this country.
"state": "A String", # Output only. The state of the pickup serving.
"uri": "A String", # Required. Pickup product page URI. It is only used for the review of pickup serving. This URI domain should match with the business's homepage.
},
"regionCode": "A String", # Required. Immutable. Region code defined by [CLDR](https://cldr.unicode.org/). Must be provided in the Create method, and is immutable.
},
}