public final class LocalInventory extends GeneratedMessage implements LocalInventoryOrBuilder
Local inventory information for the product. Represents in-store information
for a specific product at the store specified by
storeCode.
For a list of all accepted attribute values, see the local product inventory
data specification.
Protobuf type google.shopping.merchant.inventories.v1.LocalInventory
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
public static final int ACCOUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int BASE64_ENCODED_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LOCAL_INVENTORY_ATTRIBUTES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STORE_CODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static LocalInventory getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static LocalInventory.Builder newBuilder()
public static LocalInventory.Builder newBuilder(LocalInventory prototype)
public static LocalInventory parseDelimitedFrom(InputStream input)
public static LocalInventory parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static LocalInventory parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(ByteString data)
public static LocalInventory parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(CodedInputStream input)
public static LocalInventory parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(InputStream input)
public static LocalInventory parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LocalInventory parseFrom(ByteBuffer data)
public static LocalInventory parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<LocalInventory> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
Output only. The account that owns the product. This field will be ignored
if set by the client.
int64 account = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
long |
The account.
|
public String getBase64EncodedName()
Output only. The unpadded base64url encoded name of the LocalInventory
resource. Format:
accounts/{account}/products/{product}/localInventories/{store_code}
where the {product} segment is the unpadded base64url encoded value of
the identifier of the form content_language~feed_label~offer_id. Example:
accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123 for
the decoded product ID en~US~sku/123 and store_code "store123".
Can be used directly as input to the API methods that require the local
product identifier within the local inventory name to be encoded if it
contains special characters, for example
GetLocalInventory.
string base64_encoded_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The base64EncodedName.
|
public ByteString getBase64EncodedNameBytes()
Output only. The unpadded base64url encoded name of the LocalInventory
resource. Format:
accounts/{account}/products/{product}/localInventories/{store_code}
where the {product} segment is the unpadded base64url encoded value of
the identifier of the form content_language~feed_label~offer_id. Example:
accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123 for
the decoded product ID en~US~sku/123 and store_code "store123".
Can be used directly as input to the API methods that require the local
product identifier within the local inventory name to be encoded if it
contains special characters, for example
GetLocalInventory.
string base64_encoded_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for base64EncodedName.
|
public LocalInventory getDefaultInstanceForType()
public LocalInventoryAttributes getLocalInventoryAttributes()
Optional. A list of local inventory attributes.
.google.shopping.merchant.inventories.v1.LocalInventoryAttributes local_inventory_attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
public LocalInventoryAttributesOrBuilder getLocalInventoryAttributesOrBuilder()
Optional. A list of local inventory attributes.
.google.shopping.merchant.inventories.v1.LocalInventoryAttributes local_inventory_attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
Output only. The name of the LocalInventory resource.
Format:
accounts/{account}/products/{product}/localInventories/{store_code}
The {product} segment is a unique identifier for the product.
This identifier must be unique within a merchant account and generally
follows the structure: content_language~feed_label~offer_id. Example:
en~US~sku123 For legacy local products, the structure is:
local~content_language~feed_label~offer_id. Example: local~en~US~sku123
The format of the {product} segment in the URL is automatically detected
by the server, supporting two options:
- Encoded Format: The
{product} segment is an unpadded base64url
encoded string (RFC 4648 Section 5). The decoded string must result
in the content_language~feed_label~offer_id structure. This encoding
MUST be used if any part of the product identifier (like offer_id)
contains characters such as /, %, or ~.
Example: To represent the product ID en~US~sku/123 for
store_code "store123", the {product} segment must be the
base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw.
The full resource name for the local inventory would be
accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123.
Plain Format: The {product} segment is the tilde-separated string
content_language~feed_label~offer_id. This format is suitable only
when content_language, feed_label, and offer_id do not contain
URL-problematic characters like /, %, or ~.
We recommend using the Encoded Format for all product IDs to ensure
correct parsing, especially those containing special characters. The
presence of tilde (~) characters in the {product} segment is used to
differentiate between the two formats.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Output only. The name of the LocalInventory resource.
Format:
accounts/{account}/products/{product}/localInventories/{store_code}
The {product} segment is a unique identifier for the product.
This identifier must be unique within a merchant account and generally
follows the structure: content_language~feed_label~offer_id. Example:
en~US~sku123 For legacy local products, the structure is:
local~content_language~feed_label~offer_id. Example: local~en~US~sku123
The format of the {product} segment in the URL is automatically detected
by the server, supporting two options:
- Encoded Format: The
{product} segment is an unpadded base64url
encoded string (RFC 4648 Section 5). The decoded string must result
in the content_language~feed_label~offer_id structure. This encoding
MUST be used if any part of the product identifier (like offer_id)
contains characters such as /, %, or ~.
Example: To represent the product ID en~US~sku/123 for
store_code "store123", the {product} segment must be the
base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw.
The full resource name for the local inventory would be
accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123.
Plain Format: The {product} segment is the tilde-separated string
content_language~feed_label~offer_id. This format is suitable only
when content_language, feed_label, and offer_id do not contain
URL-problematic characters like /, %, or ~.
We recommend using the Encoded Format for all product IDs to ensure
correct parsing, especially those containing special characters. The
presence of tilde (~) characters in the {product} segment is used to
differentiate between the two formats.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public Parser<LocalInventory> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public String getStoreCode()
Required. Immutable. Store code (the store ID from your Business Profile)
of the physical store the product is sold in. See the Local product
inventory data
specification for
more information.
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. Store code (the store ID from your Business Profile)
of the physical store the product is sold in. See the Local product
inventory data
specification for
more information.
string store_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
ByteString |
The bytes for storeCode.
|
public boolean hasLocalInventoryAttributes()
Optional. A list of local inventory attributes.
.google.shopping.merchant.inventories.v1.LocalInventoryAttributes local_inventory_attributes = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the localInventoryAttributes field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public LocalInventory.Builder newBuilderForType()
protected LocalInventory.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public LocalInventory.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
