Class RegionalInventory.Builder (1.19.0) 

public static final class RegionalInventory.Builder extends GeneratedMessage.Builder<RegionalInventory.Builder> implements RegionalInventoryOrBuilder

Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific region. For a list of all accepted attribute values, see the regional product inventory data specification.

Protobuf type google.shopping.merchant.inventories.v1.RegionalInventory

Inheritance

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

Static Methods

getDescriptor()

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

Methods

build()

public RegionalInventory build()
Returns
Type Description
RegionalInventory

buildPartial()

public RegionalInventory buildPartial()
Returns
Type Description
RegionalInventory

clear()

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

clearAccount()

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

This builder for chaining.

clearBase64EncodedName()

public RegionalInventory.Builder clearBase64EncodedName()

Output only. The unpadded base64url encoded name of the RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region} 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/regionalInventories/region123 for the decoded product ID en~US~sku/123 and region "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example GetRegionalInventory.

string base64_encoded_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RegionalInventory.Builder

This builder for chaining.

clearName()

public RegionalInventory.Builder clearName()

Output only. The name of the RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region}

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 region "region123", the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the regional inventory would be accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123.

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

This builder for chaining.

clearRegion()

public RegionalInventory.Builder clearRegion()

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.

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

Returns
Type Description
RegionalInventory.Builder

This builder for chaining.

clearRegionalInventoryAttributes()

public RegionalInventory.Builder clearRegionalInventoryAttributes()

Optional. A list of regional inventory attributes.

.google.shopping.merchant.inventories.v1.RegionalInventoryAttributes regional_inventory_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RegionalInventory.Builder

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 RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region} 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/regionalInventories/region123 for the decoded product ID en~US~sku/123 and region "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example GetRegionalInventory.

string base64_encoded_name = 10 [(.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 RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region} 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/regionalInventories/region123 for the decoded product ID en~US~sku/123 and region "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example GetRegionalInventory.

string base64_encoded_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for base64EncodedName.

getDefaultInstanceForType()

public RegionalInventory getDefaultInstanceForType()
Returns
Type Description
RegionalInventory

getDescriptorForType()

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

getName()

public String getName()

Output only. The name of the RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region}

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 region "region123", the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the regional inventory would be accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123.

  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 RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region}

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 region "region123", the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the regional inventory would be accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123.

  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.

getRegion()

public String getRegion()

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.

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

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.

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

Returns
Type Description
ByteString

The bytes for region.

getRegionalInventoryAttributes()

public RegionalInventoryAttributes getRegionalInventoryAttributes()

Optional. A list of regional inventory attributes.

.google.shopping.merchant.inventories.v1.RegionalInventoryAttributes regional_inventory_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RegionalInventoryAttributes

The regionalInventoryAttributes.

getRegionalInventoryAttributesBuilder()

public RegionalInventoryAttributes.Builder getRegionalInventoryAttributesBuilder()

Optional. A list of regional inventory attributes.

.google.shopping.merchant.inventories.v1.RegionalInventoryAttributes regional_inventory_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RegionalInventoryAttributes.Builder

getRegionalInventoryAttributesOrBuilder()

public RegionalInventoryAttributesOrBuilder getRegionalInventoryAttributesOrBuilder()

Optional. A list of regional inventory attributes.

.google.shopping.merchant.inventories.v1.RegionalInventoryAttributes regional_inventory_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RegionalInventoryAttributesOrBuilder

hasRegionalInventoryAttributes()

public boolean hasRegionalInventoryAttributes()

Optional. A list of regional inventory attributes.

.google.shopping.merchant.inventories.v1.RegionalInventoryAttributes regional_inventory_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the regionalInventoryAttributes 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 RegionalInventory.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RegionalInventory.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(RegionalInventory other)

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

mergeRegionalInventoryAttributes(RegionalInventoryAttributes value)

public RegionalInventory.Builder mergeRegionalInventoryAttributes(RegionalInventoryAttributes value)

Optional. A list of regional inventory attributes.

.google.shopping.merchant.inventories.v1.RegionalInventoryAttributes regional_inventory_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value RegionalInventoryAttributes
Returns
Type Description
RegionalInventory.Builder

setAccount(long value)

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

This builder for chaining.

setBase64EncodedName(String value)

public RegionalInventory.Builder setBase64EncodedName(String value)

Output only. The unpadded base64url encoded name of the RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region} 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/regionalInventories/region123 for the decoded product ID en~US~sku/123 and region "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example GetRegionalInventory.

string base64_encoded_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The base64EncodedName to set.
Returns
Type Description
RegionalInventory.Builder

This builder for chaining.

setBase64EncodedNameBytes(ByteString value)

public RegionalInventory.Builder setBase64EncodedNameBytes(ByteString value)

Output only. The unpadded base64url encoded name of the RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region} 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/regionalInventories/region123 for the decoded product ID en~US~sku/123 and region "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example GetRegionalInventory.

string base64_encoded_name = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

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

This builder for chaining.

setName(String value)

public RegionalInventory.Builder setName(String value)

Output only. The name of the RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region}

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 region "region123", the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the regional inventory would be accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123.

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

This builder for chaining.

setNameBytes(ByteString value)

public RegionalInventory.Builder setNameBytes(ByteString value)

Output only. The name of the RegionalInventory resource. Format: accounts/{account}/products/{product}/regionalInventories/{region}

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 region "region123", the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the regional inventory would be accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123.

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

This builder for chaining.

setRegion(String value)

public RegionalInventory.Builder setRegion(String value)

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.

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

Parameter
Name Description
value String

The region to set.
Returns
Type Description
RegionalInventory.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public RegionalInventory.Builder setRegionBytes(ByteString value)

Required. Immutable. ID of the region for this RegionalInventory resource. See the Regional availability and pricing for more details.

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

Parameter
Name Description
value ByteString

The bytes for region to set.
Returns
Type Description
RegionalInventory.Builder

This builder for chaining.

setRegionalInventoryAttributes(RegionalInventoryAttributes value)

public RegionalInventory.Builder setRegionalInventoryAttributes(RegionalInventoryAttributes value)

Optional. A list of regional inventory attributes.

.google.shopping.merchant.inventories.v1.RegionalInventoryAttributes regional_inventory_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value RegionalInventoryAttributes
Returns
Type Description
RegionalInventory.Builder

setRegionalInventoryAttributes(RegionalInventoryAttributes.Builder builderForValue)

public RegionalInventory.Builder setRegionalInventoryAttributes(RegionalInventoryAttributes.Builder builderForValue)

Optional. A list of regional inventory attributes.

.google.shopping.merchant.inventories.v1.RegionalInventoryAttributes regional_inventory_attributes = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue RegionalInventoryAttributes.Builder
Returns
Type Description
RegionalInventory.Builder