public final class LfpStore extends GeneratedMessageV3 implements LfpStoreOrBuilder
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.
Protobuf type google.shopping.merchant.lfp.v1beta.LfpStore
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int GCID_CATEGORY_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int MATCHING_STATE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int MATCHING_STATE_HINT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int PHONE_NUMBER_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int PLACE_ID_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int STORE_ADDRESS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int STORE_CODE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int STORE_NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int TARGET_ACCOUNT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int WEBSITE_URI_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
public static LfpStore getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static LfpStore.Builder newBuilder()
public static LfpStore.Builder newBuilder(LfpStore prototype)
Parameter |
Name |
Description |
prototype |
LfpStore
|
public static LfpStore parseDelimitedFrom(InputStream input)
public static LfpStore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LfpStore parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
public static LfpStore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LfpStore parseFrom(ByteString data)
public static LfpStore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LfpStore parseFrom(CodedInputStream input)
public static LfpStore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LfpStore parseFrom(InputStream input)
public static LfpStore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LfpStore parseFrom(ByteBuffer data)
public static LfpStore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<LfpStore> parser()
Methods
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
public LfpStore getDefaultInstanceForType()
public String getGcidCategory(int index)
Parameter |
Name |
Description |
index |
int
The index of the element to return.
|
Returns |
Type |
Description |
String |
The gcidCategory at the given index.
|
public ByteString getGcidCategoryBytes(int index)
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.
|
public int getGcidCategoryCount()
Returns |
Type |
Description |
int |
The count of gcidCategory.
|
public ProtocolStringList getGcidCategoryList()
public 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];
public 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.
|
public 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.
|
public 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.
|
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.
|
public 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.
|
public Parser<LfpStore> getParserForType()
Overrides
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public String getStoreName()
Optional. The merchant or store name.
optional string store_name = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
String |
The storeName.
|
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public 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.
|
public 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.
|
Returns |
Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public LfpStore.Builder newBuilderForType()
protected LfpStore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
public LfpStore.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides