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 \ V1betaMethods
__construct
Constructor.
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
↳ website_uri
string
Optional. The website URL for the store or merchant.
↳ gcid_category
↳ place_id
↳ 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}
string
setName
Output only. Identifier. The name of the LfpStore
resource.
Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}
var
string
$this
getTargetAccount
Required. The Merchant Center id of the merchant to submit the store for.
int|string
setTargetAccount
Required. The Merchant Center id of the merchant to submit the store for.
var
int|string
$this
getStoreCode
Required. Immutable. A store identifier that is unique for the target merchant.
string
setStoreCode
Required. Immutable. A store identifier that is unique for the target merchant.
var
string
$this
getStoreAddress
Required. The street address of the store.
Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
string
setStoreAddress
Required. The street address of the store.
Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.
var
string
$this
getStoreName
Optional. The merchant or store name.
string
hasStoreName
clearStoreName
setStoreName
Optional. The merchant or store name.
var
string
$this
getPhoneNumber
Optional. The store phone number in E.164
format. Example: +15556767888
string
hasPhoneNumber
clearPhoneNumber
setPhoneNumber
Optional. The store phone number in E.164
format. Example: +15556767888
var
string
$this
getWebsiteUri
Optional. The website URL for the store or merchant.
string
hasWebsiteUri
clearWebsiteUri
setWebsiteUri
Optional. The website URL for the store or merchant.
var
string
$this
getGcidCategory
Optional. Google My Business category id .
setGcidCategory
Optional. Google My Business category id .
var
string[]
$this
getPlaceId
Optional. The Google Place Id of the store location.
string
hasPlaceId
clearPlaceId
setPlaceId
Optional. The Google Place Id of the store location.
var
string
$this
getMatchingState
Optional. Output only. The state of matching to a Google Business Profile.
See matchingStateHint for further details if no match is found.
int
setMatchingState
Optional. Output only. The state of matching to a Google Business Profile.
See matchingStateHint for further details if no match is found.
var
int
$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 providedLfpStorecouldn'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 theLfpStorelocation address does not match with Google Business Profile stores' addresses. Update theLfpStoreaddress or Google Business Profile store address to match correctly. - "
store-match-unverified": The providedLfpStorecouldn'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.
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 providedLfpStorecouldn'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 theLfpStorelocation address does not match with Google Business Profile stores' addresses. Update theLfpStoreaddress or Google Business Profile store address to match correctly. - "
store-match-unverified": The providedLfpStorecouldn'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.
var
string
$this
