Package google.shopping.merchant.lfp.v1beta

    Index

    LfpInventoryService

    Service for a LFP partner to submit local inventories for a merchant.

    InsertLfpInventory

    rpc InsertLfpInventory( InsertLfpInventoryRequest ) returns ( LfpInventory )

    Inserts a LfpInventory resource for the given target merchant account. If the resource already exists, it will be replaced. The inventory automatically expires after 30 days.

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the OAuth 2.0 Overview .

    LfpMerchantStateService

    Service for a LFP partner to get the state of a merchant.

    For information about onboarding a retailer, see How to onboard a retailer .

    GetLfpMerchantState

    rpc GetLfpMerchantState( GetLfpMerchantStateRequest ) returns ( LfpMerchantState )

    Gets the LFP state of a merchant

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the OAuth 2.0 Overview .

    LfpSaleService

    Service for a LFP partner to submit sales data for a merchant.

    InsertLfpSale

    rpc InsertLfpSale( InsertLfpSaleRequest ) returns ( LfpSale )

    Inserts a LfpSale for the given merchant.

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the OAuth 2.0 Overview .

    LfpStoreService

    Service for a LFP partner to submit local stores for a merchant.

    DeleteLfpStore

    rpc DeleteLfpStore( DeleteLfpStoreRequest ) returns ( Empty )

    Deletes a store for a target merchant.

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the OAuth 2.0 Overview .

    GetLfpStore

    rpc GetLfpStore( GetLfpStoreRequest ) returns ( LfpStore )

    Retrieves information about a store.

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the OAuth 2.0 Overview .

    InsertLfpStore

    rpc InsertLfpStore( InsertLfpStoreRequest ) returns ( LfpStore )

    Inserts a store for the target merchant. If the store with the same store code already exists, it will be replaced.

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the OAuth 2.0 Overview .

    ListLfpStores

    rpc ListLfpStores( ListLfpStoresRequest ) returns ( ListLfpStoresResponse )

    Lists the stores of the target merchant, specified by the filter in ListLfpStoresRequest .

    Authorization scopes

    Requires the following OAuth scope:

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

    For more information, see the OAuth 2.0 Overview .

    DeleteLfpStoreRequest

    Request message for the DeleteLfpStore method.

    Fields
    name

    string

    Required. The name of the store to delete for the target merchant account. Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}

    GetLfpMerchantStateRequest

    Request message for the GetLfpMerchantState method.

    Fields
    name

    string

    Required. The name of the state to retrieve. Format: accounts/{account}/lfpMerchantStates/{target_merchant} . For example, accounts/123456/lfpMerchantStates/567890 .

    GetLfpStoreRequest

    Request message for the GetLfpStore method.

    Fields
    name

    string

    Required. The name of the store to retrieve. Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}

    InsertLfpInventoryRequest

    Request message for the InsertLfpInventory method.

    Fields
    parent

    string

    Required. The LFP provider account. Format: accounts/{account}

    lfp_inventory

    LfpInventory

    Required. The inventory to insert.

    InsertLfpSaleRequest

    Request message for the InsertLfpSale method.

    Fields
    parent

    string

    Required. The LFP provider account. Format: accounts/{lfp_partner}

    lfp_sale

    LfpSale

    Required. The sale to insert.

    InsertLfpStoreRequest

    Request message for the InsertLfpStore method.

    Fields
    parent

    string

    Required. The LFP provider account Format: accounts/{account}

    lfp_store

    LfpStore

    Required. The store to insert.

    LfpInventory

    Local Inventory for the merchant.

    Fields
    name

    string

    Output only. Identifier. The name for the LfpInventory resource. Format: accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}

    store_code

    string

    Required. The identifier of the merchant's store. Either the store code inserted through InsertLfpStore or the store code in the Business Profile.
    offer_id

    string

    Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product.

    Note: if the merchant sells the same product new and used, they should have different IDs.
    region_code

    string

    Required. The CLDR territory code for the country where the product is sold.
    content_language

    string

    Required. The two-letter ISO 639-1 language code for the item.
    price

    Price

    Optional. The current price of the product.
    availability

    string

    Required. Availability of the product at this store. For accepted attribute values, see the local product inventory data specification

    collection_time

    Timestamp

    Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.
    gtin

    string

    Optional. The Global Trade Item Number of the product.
    quantity

    int64

    Optional. Quantity of the product available at this store. Must be greater than or equal to zero.
    pickup_method

    string

    Optional. Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with pickupSla . For accepted attribute values, see the local product inventory data specification .
    pickup_sla

    string

    Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod . For accepted attribute values, see the local product inventory data specification .
    feed_label

    string

    Optional. The feed label for the product. If this is not set, it will default to regionCode .

    LfpMerchantState

    The LFP state of a merchant.

    Fields
    name

    string

    Identifier. The name of the LfpMerchantState resource. Format: accounts/{account}/lfpMerchantStates/{target_merchant} . For example, accounts/123456/lfpMerchantStates/567890 .
    linked_gbps

    int64

    Number of GBPs this merchant has access to.
    store_states[]

    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.
    inventory_stats

    InventoryStats

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

    CountrySettings

    Country-specific settings for the merchant.

    CountrySettings

    Country-specific settings for the merchant.

    Fields
    region_code

    string

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

    bool

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

    bool

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

    VerificationState

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

    ProductPageType

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

    VerificationState

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

    VerificationState

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

    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.

    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.

    InventoryStats

    The inventory statistics for a merchant.

    Fields
    submitted_entries

    int64

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

    int64

    Number of submitted in stock entries.
    unsubmitted_entries

    int64

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

    int64

    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.

    LfpStoreState

    The state of a specific merchant's store.

    Fields
    store_code

    string

    Required. Immutable. The identifier of this store.
    matching_state

    StoreMatchingState

    Output only. The store matching state.
    matching_state_hint

    string

    The hint of why the matching has failed (only set if matching_state 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.

    LfpSale

    A sale for the merchant.

    Fields
    name

    string

    Output only. Identifier. The name of the LfpSale resource. Format: accounts/{account}/lfpSales/{sale}

    store_code

    string

    Required. The identifier of the merchant's store. Either a storeCode inserted through the API or the code of the store in the Business Profile.
    offer_id

    string

    Required. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product.

    Note: if the merchant sells the same product new and used, they should have different IDs.
    region_code

    string

    Required. The CLDR territory code for the country where the product is sold.
    content_language

    string

    Required. The two-letter ISO 639-1 language code for the item.
    gtin

    string

    Required. The Global Trade Item Number of the sold product.
    price

    Price

    Required. The unit price of the product.
    quantity

    int64

    Required. The relative change of the available quantity. Negative for items returned.
    sale_time

    Timestamp

    Required. The timestamp for the sale.
    uid

    string

    Output only. System generated globally unique ID for the LfpSale .
    feed_label

    string

    Optional. The feed label for the product. If this is not set, it will default to regionCode .

    LfpStore

    A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used.

    Fields
    name

    string

    Output only. Identifier. The name of the LfpStore resource. Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}

    store_code

    string

    Required. Immutable. A store identifier that is unique for the target merchant.

    store_address

    string

    Required. The street address of the store. Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.

    gcid_category[]

    string

    Optional. Google My Business category id .

    matching_state

    StoreMatchingState

    Optional. Output only. The state of matching to a Google Business Profile. See matchingStateHint for further details if no match is found.

    store_name

    string

    Optional. The merchant or store name.

    phone_number

    string

    Optional. The store phone number in E.164 format. Example: +15556767888

    website_uri

    string

    Optional. The website URL for the store or merchant.

    place_id

    string

    Optional. The Google Place Id of the store location.

    matching_state_hint

    string

    Optional. Output only. The hint of why the matching has failed. This is only set when matchingState = STORE_MATCHING_STATE_FAILED .

    Possible values are:

    • " linked-store-not-found ": There aren't any Google Business Profile stores available for matching.
    • " store-match-not-found ": The provided LfpStore couldn't be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but the LfpStore location address does not match with Google Business Profile stores' addresses. Update the LfpStore address or Google Business Profile store address to match correctly.
    • " store-match-unverified ": The provided LfpStore couldn't be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly.

    StoreMatchingState

    The state of matching LfpStore to a Google Business Profile.

    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.

    ListLfpStoresRequest

    Request message for the ListLfpStores method.

    Fields
    parent

    string

    Required. The LFP partner. Format: accounts/{account}

    page_size

    int32

    Optional. The maximum number of LfpStore resources for the given account to return. The service returns fewer than this value if the number of stores for the given account is less than the pageSize . The default value is 250. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.
    page_token

    string

    Optional. A page token, received from a previous ListLfpStoresRequest call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to ListLfpStoresRequest must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

    ListLfpStoresResponse

    Response message for the ListLfpStores method.

    Fields
    lfp_stores[]

    LfpStore

    The stores from the specified merchant.
    next_page_token

    string

    A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: