Google Shopping Merchant Lfp V1beta Client - Class LfpStore (0.1.0)

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Shopping Merchant Lfp V1beta Client class 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.

Generated from protobuf message google.shopping.merchant.lfp.v1beta.LfpStore

Namespace

Google \ Shopping \ Merchant \ Lfp \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. Identifier. The name of the LfpStore resource. Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}
↳ target_account	int|string Required. The Merchant Center id of the merchant to submit the store for.
↳ 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.
↳ store_name	string Optional. The merchant or store name.
↳ phone_number	string Optional. The store phone number in E.164 format. Example: [phone]
↳ website_uri	string Optional. The website URL for the store or merchant.
↳ gcid_category	array Optional. Google My Business category id.
↳ place_id	string Optional. The Google Place Id of the store location.
↳ matching_state	int Optional. Output only. The state of matching to a Google Business Profile. See matchingStateHint for further details if no match is found.
↳ 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.

getName

Output only. Identifier. The name of the LfpStore resource.

Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}

Returns
Type	Description
string

setName

Output only. Identifier. The name of the LfpStore resource.

Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTargetAccount

Required. The Merchant Center id of the merchant to submit the store for.

Returns
Type	Description
int|string

setTargetAccount

Required. The Merchant Center id of the merchant to submit the store for.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getStoreCode

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

Returns
Type	Description
string

setStoreCode

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getStoreAddress

Required. The street address of the store.

Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.

Returns
Type	Description
string

setStoreAddress

Required. The street address of the store.

Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getStoreName

Optional. The merchant or store name.

Returns
Type	Description
string

hasStoreName

clearStoreName

setStoreName

Optional. The merchant or store name.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPhoneNumber

Optional. The store phone number in E.164 format. Example: [phone]

Returns
Type	Description
string

hasPhoneNumber

clearPhoneNumber

setPhoneNumber

Optional. The store phone number in E.164 format. Example: [phone]

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getWebsiteUri

Optional. The website URL for the store or merchant.

Returns
Type	Description
string

hasWebsiteUri

clearWebsiteUri

setWebsiteUri

Optional. The website URL for the store or merchant.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getGcidCategory

Optional. Google My Business category id.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setGcidCategory

Optional. Google My Business category id.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getPlaceId

Optional. The Google Place Id of the store location.

Returns
Type	Description
string

hasPlaceId

clearPlaceId

setPlaceId

Optional. The Google Place Id of the store location.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMatchingState

Optional. Output only. The state of matching to a Google Business Profile.

See matchingStateHint for further details if no match is found.

Returns
Type	Description
int

setMatchingState

Optional. Output only. The state of matching to a Google Business Profile.

See matchingStateHint for further details if no match is found.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMatchingStateHint

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.

Returns
Type	Description
string

hasMatchingStateHint

clearMatchingStateHint

setMatchingStateHint

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this