Class LfpStore (0.5.0) 

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > LfpStore

Implements

LfpStoreOrBuilder

Static Fields

GCID_CATEGORY_FIELD_NUMBER

public static final int GCID_CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

MATCHING_STATE_FIELD_NUMBER

public static final int MATCHING_STATE_FIELD_NUMBER
Field Value
Type Description
int

MATCHING_STATE_HINT_FIELD_NUMBER

public static final int MATCHING_STATE_HINT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PHONE_NUMBER_FIELD_NUMBER

public static final int PHONE_NUMBER_FIELD_NUMBER
Field Value
Type Description
int

PLACE_ID_FIELD_NUMBER

public static final int PLACE_ID_FIELD_NUMBER
Field Value
Type Description
int

STORE_ADDRESS_FIELD_NUMBER

public static final int STORE_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

STORE_CODE_FIELD_NUMBER

public static final int STORE_CODE_FIELD_NUMBER
Field Value
Type Description
int

STORE_NAME_FIELD_NUMBER

public static final int STORE_NAME_FIELD_NUMBER
Field Value
Type Description
int

TARGET_ACCOUNT_FIELD_NUMBER

public static final int TARGET_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

WEBSITE_URI_FIELD_NUMBER

public static final int WEBSITE_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LfpStore getDefaultInstance()
Returns
Type Description
LfpStore

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static LfpStore.Builder newBuilder()
Returns
Type Description
LfpStore.Builder

newBuilder(LfpStore prototype)

public static LfpStore.Builder newBuilder(LfpStore prototype)
Parameter
Name Description
prototype LfpStore
Returns
Type Description
LfpStore.Builder

parseDelimitedFrom(InputStream input)

public static LfpStore parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LfpStore
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LfpStore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LfpStore
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LfpStore parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LfpStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LfpStore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LfpStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LfpStore parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LfpStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LfpStore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LfpStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LfpStore parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LfpStore
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LfpStore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LfpStore
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LfpStore parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LfpStore
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LfpStore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LfpStore
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LfpStore parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LfpStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LfpStore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LfpStore
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LfpStore> parser()
Returns
Type Description
Parser<LfpStore>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public LfpStore getDefaultInstanceForType()
Returns
Type Description
LfpStore

getGcidCategory(int index)

public 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 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 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 ProtocolStringList getGcidCategoryList()

Optional. Google My Business category id.

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

Returns
Type Description
ProtocolStringList

A list containing the gcidCategory.

getMatchingState()

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];

Returns
Type Description
LfpStore.StoreMatchingState

The matchingState.

getMatchingStateHint()

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.

getMatchingStateHintBytes()

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.

getMatchingStateValue()

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.

getName()

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

getParserForType()

public Parser<LfpStore> getParserForType()
Returns
Type Description
Parser<LfpStore>
Overrides

getPhoneNumber()

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.

getPhoneNumberBytes()

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.

getPlaceId()

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.

getPlaceIdBytes()

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStoreAddress()

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.

getStoreAddressBytes()

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.

getStoreCode()

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.

getStoreCodeBytes()

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.

getStoreName()

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.

getStoreNameBytes()

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.

getTargetAccount()

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.

getWebsiteUri()

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.

getWebsiteUriBytes()

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.

hasMatchingStateHint()

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.

hasPhoneNumber()

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.

hasPlaceId()

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.

hasStoreName()

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.

hasWebsiteUri()

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LfpStore.Builder newBuilderForType()
Returns
Type Description
LfpStore.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LfpStore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LfpStore.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LfpStore.Builder toBuilder()
Returns
Type Description
LfpStore.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException