Interface LfpStoreOrBuilder (0.12.0) 

public interface LfpStoreOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getGcidCategory(int index)

public abstract String getGcidCategory(int index)

Optional. Google My Business category id.

repeated string gcid_category = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The gcidCategory at the given index.

getGcidCategoryBytes(int index)

public abstract ByteString getGcidCategoryBytes(int index)

Optional. Google My Business category id.

repeated string gcid_category = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the gcidCategory at the given index.

getGcidCategoryCount()

public abstract int getGcidCategoryCount()

Optional. Google My Business category id.

repeated string gcid_category = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of gcidCategory.

getGcidCategoryList()

public abstract List<String> getGcidCategoryList()

Optional. Google My Business category id.

repeated string gcid_category = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the gcidCategory.

getMatchingState()

public abstract LfpStore.StoreMatchingState getMatchingState()

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

.google.shopping.merchant.lfp.v1beta.LfpStore.StoreMatchingState matching_state = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
LfpStore.StoreMatchingState

The matchingState.

getMatchingStateHint()

public abstract String 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.

optional string matching_state_hint = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The matchingStateHint.

getMatchingStateHintBytes()

public abstract ByteString getMatchingStateHintBytes()

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.

optional string matching_state_hint = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for matchingStateHint.

getMatchingStateValue()

public abstract int getMatchingStateValue()

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

.google.shopping.merchant.lfp.v1beta.LfpStore.StoreMatchingState matching_state = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for matchingState.

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPhoneNumber()

public abstract String getPhoneNumber()

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

optional string phone_number = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The phoneNumber.

getPhoneNumberBytes()

public abstract ByteString getPhoneNumberBytes()

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

optional string phone_number = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for phoneNumber.

getPlaceId()

public abstract String getPlaceId()

Optional. The Google Place Id of the store location.

optional string place_id = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The placeId.

getPlaceIdBytes()

public abstract ByteString getPlaceIdBytes()

Optional. The Google Place Id of the store location.

optional string place_id = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for placeId.

getStoreAddress()

public abstract String getStoreAddress()

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

string store_address = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The storeAddress.

getStoreAddressBytes()

public abstract ByteString getStoreAddressBytes()

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

string store_address = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for storeAddress.

getStoreCode()

public abstract String getStoreCode()

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

string store_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The storeCode.

getStoreCodeBytes()

public abstract ByteString getStoreCodeBytes()

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

string store_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for storeCode.

getStoreName()

public abstract String getStoreName()

Optional. The merchant or store name.

optional string store_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The storeName.

getStoreNameBytes()

public abstract ByteString getStoreNameBytes()

Optional. The merchant or store name.

optional string store_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for storeName.

getTargetAccount()

public abstract long getTargetAccount()

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

int64 target_account = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
long

The targetAccount.

getWebsiteUri()

public abstract String getWebsiteUri()

Optional. The website URL for the store or merchant.

optional string website_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The websiteUri.

getWebsiteUriBytes()

public abstract ByteString getWebsiteUriBytes()

Optional. The website URL for the store or merchant.

optional string website_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for websiteUri.

hasMatchingStateHint()

public abstract boolean hasMatchingStateHint()

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.

optional string matching_state_hint = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the matchingStateHint field is set.

hasPhoneNumber()

public abstract boolean hasPhoneNumber()

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

optional string phone_number = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the phoneNumber field is set.

hasPlaceId()

public abstract boolean hasPlaceId()

Optional. The Google Place Id of the store location.

optional string place_id = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the placeId field is set.

hasStoreName()

public abstract boolean hasStoreName()

Optional. The merchant or store name.

optional string store_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the storeName field is set.

hasWebsiteUri()

public abstract boolean hasWebsiteUri()

Optional. The website URL for the store or merchant.

optional string website_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the websiteUri field is set.