Class LocalInventory.Builder (1.19.0) 

public static final class LocalInventory.Builder extends GeneratedMessage.Builder<LocalInventory.Builder> 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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > LocalInventory.Builder

Static Methods

getDescriptor()

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

Methods

build()

public LocalInventory build()
Returns
Type Description
LocalInventory

buildPartial()

public LocalInventory buildPartial()
Returns
Type Description
LocalInventory

clear()

public LocalInventory.Builder clear()
Returns
Type Description
LocalInventory.Builder
Overrides

clearAccount()

public LocalInventory.Builder clearAccount()

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
LocalInventory.Builder

This builder for chaining.

clearBase64EncodedName()

public LocalInventory.Builder clearBase64EncodedName()

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
LocalInventory.Builder

This builder for chaining.

clearLocalInventoryAttributes()

public LocalInventory.Builder clearLocalInventoryAttributes()

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
LocalInventory.Builder

clearName()

public LocalInventory.Builder clearName()

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:

  1. 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 ~.

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

  3. 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
LocalInventory.Builder

This builder for chaining.

clearStoreCode()

public LocalInventory.Builder clearStoreCode()

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
LocalInventory.Builder

This builder for chaining.

getAccount()

public long getAccount()

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.

getBase64EncodedName()

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.

getBase64EncodedNameBytes()

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.

getDefaultInstanceForType()

public LocalInventory getDefaultInstanceForType()
Returns
Type Description
LocalInventory

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLocalInventoryAttributes()

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

Returns
Type Description
LocalInventoryAttributes

The localInventoryAttributes.

getLocalInventoryAttributesBuilder()

public LocalInventoryAttributes.Builder getLocalInventoryAttributesBuilder()

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
LocalInventoryAttributes.Builder

getLocalInventoryAttributesOrBuilder()

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

Returns
Type Description
LocalInventoryAttributesOrBuilder

getName()

public String getName()

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:

  1. 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 ~.

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

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

getNameBytes()

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:

  1. 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 ~.

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

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

getStoreCode()

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.

getStoreCodeBytes()

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.

hasLocalInventoryAttributes()

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LocalInventory.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LocalInventory.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LocalInventory.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LocalInventory.Builder
Overrides

mergeFrom(LocalInventory other)

public LocalInventory.Builder mergeFrom(LocalInventory other)
Parameter
Name Description
other LocalInventory
Returns
Type Description
LocalInventory.Builder

mergeLocalInventoryAttributes(LocalInventoryAttributes value)

public LocalInventory.Builder mergeLocalInventoryAttributes(LocalInventoryAttributes value)

Optional. A list of local inventory attributes.

.google.shopping.merchant.inventories.v1.LocalInventoryAttributes local_inventory_attributes = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LocalInventoryAttributes
Returns
Type Description
LocalInventory.Builder

setAccount(long value)

public LocalInventory.Builder setAccount(long value)

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

Parameter
Name Description
value long

The account to set.
Returns
Type Description
LocalInventory.Builder

This builder for chaining.

setBase64EncodedName(String value)

public LocalInventory.Builder setBase64EncodedName(String value)

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

Parameter
Name Description
value String

The base64EncodedName to set.
Returns
Type Description
LocalInventory.Builder

This builder for chaining.

setBase64EncodedNameBytes(ByteString value)

public LocalInventory.Builder setBase64EncodedNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for base64EncodedName to set.
Returns
Type Description
LocalInventory.Builder

This builder for chaining.

setLocalInventoryAttributes(LocalInventoryAttributes value)

public LocalInventory.Builder setLocalInventoryAttributes(LocalInventoryAttributes value)

Optional. A list of local inventory attributes.

.google.shopping.merchant.inventories.v1.LocalInventoryAttributes local_inventory_attributes = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value LocalInventoryAttributes
Returns
Type Description
LocalInventory.Builder

setLocalInventoryAttributes(LocalInventoryAttributes.Builder builderForValue)

public LocalInventory.Builder setLocalInventoryAttributes(LocalInventoryAttributes.Builder builderForValue)

Optional. A list of local inventory attributes.

.google.shopping.merchant.inventories.v1.LocalInventoryAttributes local_inventory_attributes = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue LocalInventoryAttributes.Builder
Returns
Type Description
LocalInventory.Builder

setName(String value)

public LocalInventory.Builder setName(String value)

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:

  1. 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 ~.

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

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
LocalInventory.Builder

This builder for chaining.

setNameBytes(ByteString value)

public LocalInventory.Builder setNameBytes(ByteString value)

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:

  1. 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 ~.

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
LocalInventory.Builder

This builder for chaining.

setStoreCode(String value)

public LocalInventory.Builder setStoreCode(String value)

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

Parameter
Name Description
value String

The storeCode to set.
Returns
Type Description
LocalInventory.Builder

This builder for chaining.

setStoreCodeBytes(ByteString value)

public LocalInventory.Builder setStoreCodeBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for storeCode to set.
Returns
Type Description
LocalInventory.Builder

This builder for chaining.