class Liasettings extends Resource (View source)

The "liasettings" collection of methods.

Typical usage is:

 $contentService = new Google\Service\ShoppingContent(...);
 $liasettings = $contentService->liasettings;

Methods

custombatch(LiasettingsCustomBatchRequest $postBody, array $optParams = [])

Retrieves and/or updates the LIA settings of multiple accounts in a single request. (liasettings.custombatch)

get(string $merchantId, string $accountId, array $optParams = [])

Retrieves the LIA settings of the account. (liasettings.get)

getaccessiblegmbaccounts(string $merchantId, string $accountId, array $optParams = [])

Retrieves the list of accessible Business Profiles.

listLiasettings(string $merchantId, array $optParams = [])

Lists the LIA settings of the sub-accounts in your Merchant Center account.

listposdataproviders(array $optParams = [])

Retrieves the list of POS data providers that have active settings for the all eiligible countries. (liasettings.listposdataproviders)

requestgmbaccess(string $merchantId, string $accountId, string $gmbEmail, array $optParams = [])

Requests access to a specified Business Profile.

requestinventoryverification(string $merchantId, string $accountId, string $country, array $optParams = [])

Requests inventory validation for the specified country.

setinventoryverificationcontact(string $merchantId, string $accountId, string $country, string $language, string $contactName, string $contactEmail, array $optParams = [])

Sets the inventory verification contract for the specified country.

setomnichannelexperience(string $merchantId, string $accountId, array $optParams = [])

Sets the omnichannel experience for the specified country. Only supported for merchants whose POS data provider is trusted to enable the corresponding experience. For more context, see these help articles about LFP and how to get started with it.

setposdataprovider(string $merchantId, string $accountId, string $country, array $optParams = [])

Sets the POS data provider for the specified country.

update(string $merchantId, string $accountId, LiaSettings $postBody, array $optParams = [])

Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource. (liasettings.update)

Details

LiasettingsCustomBatchResponse custombatch(LiasettingsCustomBatchRequest $postBody, array $optParams = [])

Retrieves and/or updates the LIA settings of multiple accounts in a single request. (liasettings.custombatch)

Parameters

LiasettingsCustomBatchRequest $postBody
array $optParams

Optional parameters.

Return Value

LiasettingsCustomBatchResponse

Exceptions

Exception

LiaSettings get(string $merchantId, string $accountId, array $optParams = [])

Retrieves the LIA settings of the account. (liasettings.get)

Parameters

string $merchantId

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.

string $accountId

The ID of the account for which to get or update LIA settings.

array $optParams

Optional parameters.

Return Value

LiaSettings

Exceptions

Exception

LiasettingsGetAccessibleGmbAccountsResponse getaccessiblegmbaccounts(string $merchantId, string $accountId, array $optParams = [])

Retrieves the list of accessible Business Profiles.

(liasettings.getaccessiblegmbaccounts)

Parameters

string $merchantId

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.

string $accountId

The ID of the account for which to retrieve accessible Business Profiles.

array $optParams

Optional parameters.

Return Value

LiasettingsGetAccessibleGmbAccountsResponse

Exceptions

Exception

LiasettingsListResponse listLiasettings(string $merchantId, array $optParams = [])

Lists the LIA settings of the sub-accounts in your Merchant Center account.

(liasettings.listLiasettings)

Parameters

string $merchantId

The ID of the managing account. This must be a multi-client account.

array $optParams

Optional parameters.

Return Value

LiasettingsListResponse

Exceptions

Exception

LiasettingsListPosDataProvidersResponse listposdataproviders(array $optParams = [])

Retrieves the list of POS data providers that have active settings for the all eiligible countries. (liasettings.listposdataproviders)

Parameters

array $optParams

Optional parameters.

Return Value

LiasettingsListPosDataProvidersResponse

Exceptions

Exception

LiasettingsRequestGmbAccessResponse requestgmbaccess(string $merchantId, string $accountId, string $gmbEmail, array $optParams = [])

Requests access to a specified Business Profile.

(liasettings.requestgmbaccess)

Parameters

string $merchantId

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.

string $accountId

The ID of the account for which Business Profile access is requested.

string $gmbEmail

The email of the Business Profile.

array $optParams

Optional parameters.

Return Value

LiasettingsRequestGmbAccessResponse

Exceptions

Exception

LiasettingsRequestInventoryVerificationResponse requestinventoryverification(string $merchantId, string $accountId, string $country, array $optParams = [])

Requests inventory validation for the specified country.

(liasettings.requestinventoryverification)

Parameters

string $merchantId

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.

string $accountId

The ID of the account that manages the order. This cannot be a multi-client account.

string $country

The country for which inventory validation is requested.

array $optParams

Optional parameters.

Return Value

LiasettingsRequestInventoryVerificationResponse

Exceptions

Exception

LiasettingsSetInventoryVerificationContactResponse setinventoryverificationcontact(string $merchantId, string $accountId, string $country, string $language, string $contactName, string $contactEmail, array $optParams = [])

Sets the inventory verification contract for the specified country.

(liasettings.setinventoryverificationcontact)

Parameters

string $merchantId

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.

string $accountId

The ID of the account that manages the order. This cannot be a multi-client account.

string $country

The country for which inventory verification is requested.

string $language

The language for which inventory verification is requested.

string $contactName

The name of the inventory verification contact.

string $contactEmail

The email of the inventory verification contact.

array $optParams

Optional parameters.

Return Value

LiasettingsSetInventoryVerificationContactResponse

Exceptions

Exception

LiaOmnichannelExperience setomnichannelexperience(string $merchantId, string $accountId, array $optParams = [])

Sets the omnichannel experience for the specified country. Only supported for merchants whose POS data provider is trusted to enable the corresponding experience. For more context, see these help articles about LFP and how to get started with it.

(liasettings.setomnichannelexperience)

Parameters

string $merchantId

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.

string $accountId

The ID of the account for which to retrieve accessible Business Profiles.

array $optParams

Optional parameters.

Return Value

LiaOmnichannelExperience

Exceptions

Exception

LiasettingsSetPosDataProviderResponse setposdataprovider(string $merchantId, string $accountId, string $country, array $optParams = [])

Sets the POS data provider for the specified country.

(liasettings.setposdataprovider)

Parameters

string $merchantId

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.

string $accountId

The ID of the account for which to retrieve accessible Business Profiles.

string $country

The country for which the POS data provider is selected.

array $optParams

Optional parameters.

Return Value

LiasettingsSetPosDataProviderResponse

Exceptions

Exception

LiaSettings update(string $merchantId, string $accountId, LiaSettings $postBody, array $optParams = [])

Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource. (liasettings.update)

Parameters

string $merchantId

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.

string $accountId

The ID of the account for which to get or update LIA settings.

LiaSettings $postBody
array $optParams

Optional parameters.

Return Value

LiaSettings

Exceptions

Exception