Liasettings: custombatch

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

Request

HTTP request

POST https://www.googleapis.com/content/v2/liasettings/batch

Parameters

Parameter name Value Description
Optional query parameters
dryRun boolean Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).

Authorization

This request requires authorization with the following scope:

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

For more information, see the authentication and authorization page.

Request body

In the request body, supply data with the following structure:

{
  "entries": [
    {
      "batchId": unsigned integer,
      "merchantId": unsigned long,
      "method": string,
      "accountId": unsigned long,
      "country": string,
      "liaSettings": liasettings Resource,
      "gmbEmail": string,
      "contactName": string,
      "contactEmail": string,
      "posDataProviderId": unsigned long,
      "posExternalAccountId": string
    }
  ]
}
Property name Value Description Notes
entries[] list The request entries to be processed in the batch.
entries[].batchId unsigned integer An entry ID, unique within the batch request.
entries[].merchantId unsigned long The ID of the managing account.
entries[].method string

Acceptable values are:
  • "get"
  • "getAccessibleGmbAccounts"
  • "requestGmbAccess"
  • "requestInventoryVerification"
  • "setInventoryVerificationContact"
  • "update"
entries[].accountId unsigned long The ID of the account for which to get/update account shipping settings.
entries[].country string The country code. Required only for RequestInventoryVerification.
entries[].liaSettings nested object The account Lia settings to update. Only defined if the method is update.
entries[].gmbEmail string The GMB account. Required only for RequestGmbAccess.
entries[].contactName string Inventory validation contact name. Required only for SetInventoryValidationContact.
entries[].contactEmail string Inventory validation contact email. Required only for SetInventoryValidationContact.
entries[].posDataProviderId unsigned long The ID of POS data provider. Required only for SetPosProvider.
entries[].posExternalAccountId string The account ID by which this merchant is known to the POS provider.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "content#liasettingsCustomBatchResponse",
  "entries": [
    {
      "kind": "content#liasettingsCustomBatchResponseEntry",
      "batchId": unsigned integer,
      "liaSettings": liasettings Resource,
      "gmbAccounts": {
        "accountId": unsigned long,
        "gmbAccounts": [
          {
            "type": string,
            "email": string,
            "name": string,
            "listingCount": unsigned long
          }
        ]
      },
      "posDataProviders": [
        {
          "country": string,
          "posDataProviders": [
            {
              "providerId": unsigned long,
              "displayName": string,
              "fullName": string
            }
          ]
        }
      ],
      "errors": {
        "errors": [
          {
            "domain": string,
            "reason": string,
            "message": string
          }
        ],
        "code": unsigned integer,
        "message": string
      }
    }
  ]
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponse".
entries[] list The result of the execution of the batch requests.
entries[].kind string Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry".
entries[].batchId unsigned integer The ID of the request entry to which this entry responds.
entries[].liaSettings nested object The retrieved or updated Lia settings.
entries[].gmbAccounts nested object The the list of accessible GMB accounts.
entries[].gmbAccounts.accountId unsigned long The ID of the account.
entries[].gmbAccounts.gmbAccounts[] list A list of GMB accounts which are available to the merchant.
entries[].gmbAccounts.gmbAccounts[].type string The type of the GMB account (User or Business).
entries[].gmbAccounts.gmbAccounts[].email string The email which identifies the GMB account.
entries[].gmbAccounts.gmbAccounts[].name string The name of the GMB account.
entries[].gmbAccounts.gmbAccounts[].listingCount unsigned long Number of listings under this account.
entries[].errors nested object A list of errors defined if, and only if, the request failed.
entries[].errors.errors[] list A list of errors.
entries[].errors.errors[].domain string The domain of the error.
entries[].errors.errors[].reason string The error code.
entries[].errors.errors[].message string A description of the error.
entries[].errors.code unsigned integer The HTTP status of the first error in errors.
entries[].errors.message string The message of the first error in errors.
entries[].posDataProviders[] list The list of POS data providers.
entries[].posDataProviders[].country string Country code.
entries[].posDataProviders[].posDataProviders[] list A list of POS data providers.
entries[].posDataProviders[].posDataProviders[].providerId unsigned long The ID of the account.
entries[].posDataProviders[].posDataProviders[].displayName string The display name of Pos data Provider.
entries[].posDataProviders[].posDataProviders[].fullName string The full name of this POS data Provider.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.