Migrate Local Inventory Ads (LIA) settings

    If you used Local Inventory Ads settings under the Shopping Content API, there are several important changes with Merchant API.

    LIA settings belong now to one of three core components, each having an associated resource.

    Core component Resource
    Account configuration for Omnichannel serving OmnichannelSetting
    Connection to Local Feed Partnership (LFP) partner for inventory data LfpProvider
    Connection to Google Business Profile (GBP) account for local stores data GbpAccount

    In addition, with LIA settings there was a single resource per account and it contained a list of settings for each national entity. With OmnichannelSettings you can associate multiple resources with an account. Each resource represents the settings for a particular national entity.

    Here's how requests and resources have changed.

    Requests

    New domain
    Content API method name
    Merchant API method name
    accounts.omnichannelSettings
    liasettings.custombatch
    This method goes away. The Merchant API supports the ability to Send multiple requests at once .
    liasettings.get
    accounts.omnichannelSettings.list
    liasettings.list
    A method to get all the LIA settings for all sub-accounts is no longer directly available. Instead, query all sub-accounts and use accounts.omnichannelSettings.list to get the omnichannelSettings for the ones of interest.
    liasettings.update
    accounts.omnichannelSettings.create, accounts.omnichannelSettings.update
    liasettings.requestinventoryverification
    accounts.omnichannelSettings.requestInventoryVerification
    liasettings.setinventoryverificationcontact
    This method goes away. Instead use accounts.omnichannelSettings.create or accounts.omnichannelSettings.update with an updated mask.
    liasettings.setomnichannelexperience
    This method goes away. Instead use accounts.omnichannelSettings.create or accounts.omnichannelSettings.update with an updated mask.
    accounts.omnichannelSettings.lfpProvider
    liasettings.listposdataproviders
    accounts.omnichannelSettings.lfpProviders.findLfpProviders
    liasettings.setposdataprovider
    accounts.omnichannelSettings.lfpProviders.linkLfpProvider
    accounts.gbpAccount
    liasettings.getaccessiblegmbaccounts
    accounts.gbpAccount.list
    liasettings.requestgmbaccess
    accounts.gbpAccount.linkGbpAccount

    Resources

    In addition, the service behaves differently for PickupType. See Pickup .

    OmnichannelSetting

    Shopping Content API
    Merchant API
    Field
    Type
    Field
    Type
    Description
    (n/a)
    (n/a)
    name
    string
    The resource name of this omnichannel setting. Format:
    Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}
    country
    string
    regionCode
    string
    Required. Common Locale Data Repository (CLDR) country code (for example, "US")
    hostedLocalStorefrontActive
    boolean
    lsfType
    enum (LsfType)
    Required. The Local Store Front (LSF) type for this regionCode . Possible values include
    • GHLSF (Google-Hosted Local Storefront)
    • MHLSF_BASIC (Merchant-Hosted Local Storefront Basic, which refers to product pages with in-store availability)
    • MHLSF_FULL (Merchant-Hosted Local Storefront Full, which refers to product pages with in-store availability)
    (n/a)
    (n/a)
    inStock
    object
    (InStock)
    The in-stock product page URI (Universal Resource Identifier) and serving status for this regionCode . Set at least one of the inStock or pickup objects in the create API if you chose one of the MHLSF types, but only set inStock if the lsfType is GHLSF .
    storePickupActive
    boolean
    pickup
    object
    (Pickup)
    The Pickup product page URI and serving status for this regionCode . Set at least one of the inStock or Pickup objects in the create API if you chose one of the MHLSF types, but don't set it when GHLSF is set as the lsfType .
    posDataProvider
    object
    (LiaPosDataProvider)
    lfpLink
    object
    (LfpLink)
    Output only. The established link to a LFP provider
    onDisplayToOrder
    object
    (LiaOnDisplayToOrderSettings)
    odo
    object
    (OnDisplayToOrder)
    The "on display to order" (ODO) policy URI and status for this regionCode
    about
    object
    (LiaAboutPageSettings)
    about
    object
    (About)
    The about page URI and status for this regionCode
    inventory
    object
    (LiaInventorySettings)
    inventoryVerification
    object
    (InventoryVerification)
    The inventory verification process status and contact information for this regionCode
    omnichannelExperience
    object (LiaOmnichannelExperience)
    (n/a)
    (n/a)
    Use lsfType and pickup (above).

    LsfType

    Shopping Content API
    Merchant API
    Field
    Type
    Field
    Type
    Description
    lsfType
    string
    lsfType
    enum (LsfType)
    The Local Store Front (LSF) type. Possible values are:
    • GHLSF (Google-Hosted Local Store Front)
    • MHLSF_BASIC (Merchant-Hosted Local Store Front Basic)
    • MHLSF_FULL (Merchant-Hosted Local Store Front Full)

    InStock

    Shopping Content API
    Merchant API
    Field
    Type
    Field
    Type
    Description
    (n/a)
    (n/a)
    uri
    string
    Product landing page URI. Required if you chose one of the MHLSF types. Required if the object is set. For GHLSF , it must be empty, but for MHLSF , non-empty. The service uses it only to review in-stock serving. This URI domain should match the merchant homepage.
    (n/a)
    (n/a)
    state
    enum
    (ReviewState.State)
    Output only. The status of the in-stock serving. Available values are
    • ACTIVE
    • FAILED
    • RUNNING
    • ACTION_REQUIRED

    To review the Shopping Content version, see LiaCountrySettings and LiaOmnichannelExperience .

    Pickup

    Shopping Content API
    Merchant API
    Field
    Type
    Field
    Type
    Description
    (n/a)
    (n/a)
    uri
    string
    Pickup product page URI. Required if the object is set. The API only uses it to review pickup serving. This URI domain should match the merchant's homepage.
    LiaInventorySettings.status
    string
    state
    enum (ReviewState.State)
    Output only. The status of the pickup serving. Available values are
    • ACTIVE
    • FAILED
    • RUNNING
      •

    To review the Shopping Content version, see LiaCountrySettings and LiaOmnichannelExperience .

    Shopping Content API
    Merchant API
    Field
    Type
    Field
    Type
    Description
    posDataProviderId
    string
    lfpProvider
    string
    Required. The resource name of the LFP provider
    posExternalAccountId
    string
    externalAccountId
    string
    Required. The account ID by which this merchant is known to the LFP provider
    (n/a)
    (n/a)
    state
    enum (ReviewState.State)
    Output only. The status of the LfpLink. Available values are
    • ACTIVE
    • RUNNING
      •

    To review the Shopping Content version, see LiaPosDataProvider .

    OnDisplayToOrder

    Shopping Content API
    Merchant API
    Field
    Type
    Field
    Type
    Description
    shippingCostPolicyUrl
    string
    uri
    string
    Required. The "on display to order" (ODO) policy URI.
    status
    string
    state
    enum (ReviewState.State)
    Output only. The status of the URI. Possible values are
    • ACTIVE
    • FAILED
    • RUNNING

    To review the Shopping Content version, see LiaOnDisplayToOrderSettings .

    About

    Shopping Content API
    Merchant API
    Field
    Type
    Field
    Type
    Description
    url
    string
    uri
    string
    Required. The about page URI
    status
    string
    state
    enum (ReviewState.State)
    Output only. The status of the URI. Possible values are
    • ACTIVE
    • FAILED
    • RUNNING

    To review the Shopping Content version, see LiaAboutPageSettings .

    InventoryVerification

    Shopping Content API
    Merchant API
    Field
    Type
    Field
    Type
    Description
    status
    string
    state
    enum (InventoryVerification.State)
    Output only. The status of the inventory verification process. Possible values are
    • ACTION_REQUIRED
    • INACTIVE
    • RUNNING
    • SUCCEEDED
    • SUSPENDED
    inventoryVerificationContactName
    string
    contact
    string
    Required. The contact name for the inventory verification process
    inventoryVerificationContactEmail
    string
    contactEmail
    string
    Required. The email of the contact for the inventory verification process
    inventoryVerificationContactStatus
    string
    contactState
    enum (ReviewState.State)
    Output only. The status of the contact verification. Possible values are
    • ACTIVE
    • RUNNING

    To review the Shopping Content version, see LiaCountrySettings and LiaInventorySettings .

    LfpProvider

    Field Type Field Type Description
    fullName
    		string name string The resource name of the LFP provider.
    Format: accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}
    (n/a)
    		 (n/a) regionCode string Required. CLDR country code
    providerId
    		string (n/a) (n/a) This field goes away.
    displayName
    		string displayName string The display name of LFP provider

    To review the Shopping Content version, see PosDataProvidersPosDataProvider .

    GbpAccount

    Shopping Content API
    Merchant API
    Field
    Type
    Field
    Type
    Description
    name
    string
    name
    string
    The resource name of the GBP account
    Format: accounts/{account}/gbpAccount/{gbp_account}
    (n/a)
    (n/a)
    gbpAccountId
    string
    The ID of the business profile
    type
    string
    type
    enum (GbpAccount.Type)
    The type of the business profile. Available values are
    • USER (personal account)
    • BUSINESS_ACCOUNT (business account)
    email
    string
    gbpAccountName
    string
    The name of the business profile:
    • For personal accounts, this is the email ID of the owner.
    • For business accounts, this is the name of the business account.
    listingCount
    string
    listingCount
    int64
    Number of listings associated with this account

    To review the Shopping Content version, see GmbAccountsGmbAccount .

    Previous
    Migrate local feeds partnership management
    Next
    Migrate online return policy management
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: