REST Resource: accounts.lfpMerchantStates

Resource: LfpMerchantState

The LFP state of a merchant.

JSON representation
{
  "name": string,
  "linkedGbps": string,
  "storeStates": [
    {
      object (LfpStoreState)
    }
  ],
  "inventoryStats": {
    object (InventoryStats)
  },
  "countrySettings": [
    {
      object (CountrySettings)
    }
  ]
}
Fields
name

string

Identifier. The name of the LfpMerchantState resource. Format: accounts/{account}/lfpMerchantStates/{target_merchant}

linkedGbps

string (int64 format)

Number of GBPs this merchant has access to.

storeStates[]

object (LfpStoreState)

Output only. The state per store from the specified merchant. The field will be absent if the merchant has no stores submitted through LFP.

inventoryStats

object (InventoryStats)

The inventory statistics for the merchant. The field will be absent if the merchant has no inventory submitted through LFP.

countrySettings[]

object (CountrySettings)

Country-specific settings for the merchant.

LfpStoreState

The state of a specific merchant's store.

JSON representation
{
  "storeCode": string,
  "matchingState": enum (StoreMatchingState),
  "matchingStateHint": string
}
Fields
storeCode

string

Required. Immutable. The identifier of this store.

matchingState

enum (StoreMatchingState)

Output only. The store matching state.

matchingStateHint

string

The hint of why the matching has failed (only set if matchingState is FAILED).

StoreMatchingState

The state of matching LfpStore to a Google Business Profile listing.

Enums
STORE_MATCHING_STATE_UNSPECIFIED Store matching state unspecified.
STORE_MATCHING_STATE_MATCHED The LfpStore is successfully matched with a Google Business Profile store.
STORE_MATCHING_STATE_FAILED The LfpStore is not matched with a Google Business Profile store.

InventoryStats

The inventory statistics for a merchant.

JSON representation
{
  "submittedEntries": string,
  "submittedInStockEntries": string,
  "unsubmittedEntries": string,
  "submittedProducts": string
}
Fields
submittedEntries

string (int64 format)

Number of entries (understanding entry as a pair of product and store) that were built based on provided inventories/sales and submitted to Google.

submittedInStockEntries

string (int64 format)

Number of submitted in stock entries.

unsubmittedEntries

string (int64 format)

Number of entries that were built based on provided inventories/sales and couldn't be submitted to Google due to errors like missing product.

submittedProducts

string (int64 format)

Number of products from provided inventories/sales that were created from matches to existing online products provided by the merchant or to the Google catalog.

CountrySettings

Country-specific settings for the merchant.

JSON representation
{
  "regionCode": string,
  "freeLocalListingsEnabled": boolean,
  "localInventoryAdsEnabled": boolean,
  "inventoryVerificationState": enum (VerificationState),
  "productPageType": enum (ProductPageType),
  "instockServingVerificationState": enum (VerificationState),
  "pickupServingVerificationState": enum (VerificationState)
}
Fields
regionCode

string

Required. The CLDR territory code for the country for which these settings are defined.

freeLocalListingsEnabled

boolean

True if this merchant has enabled free local listings in MC.

localInventoryAdsEnabled

boolean

True if this merchant has enabled local inventory ads in MC.

inventoryVerificationState

enum (VerificationState)

Output only. The verification state of this merchant's inventory check.

productPageType

enum (ProductPageType)

Output only. The product page type selected by this merchant.

instockServingVerificationState

enum (VerificationState)

Output only. The verification state of this merchant's instock serving feature.

pickupServingVerificationState

enum (VerificationState)

Output only. The verification state of this merchant's pickup serving feature.

VerificationState

The possible verification states for different merchant programs.

Enums
VERIFICATION_STATE_UNSPECIFIED Verification state unspecified.
VERIFICATION_STATE_NOT_APPROVED Verification state not approved.
VERIFICATION_STATE_IN_PROGRESS Verification state in progress.
VERIFICATION_STATE_APPROVED Verification state approved.

ProductPageType

The possible product page types for a merchant.

Enums
PRODUCT_PAGE_TYPE_UNSPECIFIED Product page type unspecified.
GOOGLE_HOSTED Google hosted product page.
MERCHANT_HOSTED Merchant hosted product page.
MERCHANT_HOSTED_STORE_SPECIFIC Merchant hosted store specific product page.

Methods

get

Gets the LFP state of a merchant