Method: liasettings.custombatch

  • Enables retrieval and/or updates of LIA settings for multiple accounts through a single batch request.

  • Utilizes HTTP POST request to https://shoppingcontent.googleapis.com/content/v2.1/liasettings/batch with a request body containing LiasettingsCustomBatchRequest.

  • Requires https://www.googleapis.com/auth/content OAuth scope for authorization.

  • Response provides details like updated LIA settings, accessible Business Profiles, and any errors encountered during the batch operation.

  • Includes specific request and response structures with detailed field descriptions for LiasettingsCustomBatchRequest, LiasettingsCustomBatchResponse, and related objects.

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

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2.1/liasettings/batch

Request body

The request body contains an instance of LiasettingsCustomBatchRequest.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "entries": [
    {
      object (LiasettingsCustomBatchResponseEntry)
    }
  ],
  "kind": string
}
Fields
entries[]

object (LiasettingsCustomBatchResponseEntry)

The result of the execution of the batch requests.
kind

string

Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse".

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

LiasettingsCustomBatchRequest

JSON representation 
{
  "entries": [
    {
      object (LiasettingsCustomBatchRequestEntry)
    }
  ]
}
Fields
entries[]

object (LiasettingsCustomBatchRequestEntry)

The request entries to be processed in the batch.

LiasettingsCustomBatchRequestEntry

JSON representation 
{
  "batchId": integer,
  "merchantId": string,
  "method": string,
  "accountId": string,
  "country": string,
  "liaSettings": {
    object (LiaSettings)
  },
  "gmbEmail": string,
  "contactName": string,
  "contactEmail": string,
  "posDataProviderId": string,
  "posExternalAccountId": string,
  "omnichannelExperience": {
    object (LiaOmnichannelExperience)
  }
}
Fields
batchId

integer (uint32 format)

An entry ID, unique within the batch request.
merchantId

string

The ID of the managing account.
method

string

The method of the batch entry.

Acceptable values are:

  • "get"
  • "getAccessibleGmbAccounts"
  • "requestGmbAccess"
  • "requestInventoryVerification"
  • "setInventoryVerificationContact"
  • "update"
accountId

string

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

string

The country code. Required only for RequestInventoryVerification.
liaSettings

object (LiaSettings)

The account Lia settings to update. Only defined if the method is update.
gmbEmail

string

The Business Profile. Required only for RequestGmbAccess.
contactName

string

pos.inventory validation contact name. Required only for SetInventoryValidationContact.
contactEmail

string

pos.inventory validation contact email. Required only for SetInventoryValidationContact.
posDataProviderId

string

The ID of POS data provider. Required only for SetPosProvider.
posExternalAccountId

string

The account ID by which this merchant is known to the POS provider.
omnichannelExperience

object (LiaOmnichannelExperience)

The omnichannel experience for a country. Required only for SetOmnichannelExperience.

LiasettingsCustomBatchResponseEntry

JSON representation 
{
  "batchId": integer,
  "liaSettings": {
    object (LiaSettings)
  },
  "errors": {
    object (Errors)
  },
  "gmbAccounts": {
    object (GmbAccounts)
  },
  "posDataProviders": [
    {
      object (PosDataProviders)
    }
  ],
  "omnichannelExperience": {
    object (LiaOmnichannelExperience)
  },
  "kind": string
}
Fields
batchId

integer (uint32 format)

The ID of the request entry to which this entry responds.
liaSettings

object (LiaSettings)

The retrieved or updated Lia settings.
errors

object (Errors)

A list of errors defined if, and only if, the request failed.
gmbAccounts

object (GmbAccounts)

The list of accessible Business Profiles.
posDataProviders[]

object (PosDataProviders)

The list of POS data providers.
omnichannelExperience

object (LiaOmnichannelExperience)

The updated omnichannel experience for a country.
kind

string

Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry"

GmbAccounts

JSON representation 
{
  "accountId": string,
  "gmbAccounts": [
    {
      object (GmbAccountsGmbAccount)
    }
  ]
}
Fields
accountId

string

The ID of the Merchant Center account.
gmbAccounts[]

object (GmbAccountsGmbAccount)

A list of Business Profiles which are available to the merchant.