# Interface LocalInventoryOrBuilder (1.21.0)

1.21.0 (latest) 1.19.0 1.16.0 1.15.0 1.13.0 1.11.0 1.10.0 1.8.0 1.6.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.46.0 0.44.0 0.43.0 0.40.0 0.39.0 0.38.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0

    public interface LocalInventoryOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getAccount()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The account. |

### getBase64EncodedName()

    public abstract 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`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get).

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The base64EncodedName. |

### getBase64EncodedNameBytes()

    public abstract 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`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get).

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for base64EncodedName. |

### getLocalInventoryAttributes()

    public abstract 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-inventories/latest/com.google.shopping.merchant.inventories.v1.LocalInventoryAttributes` | The localInventoryAttributes. |

### getLocalInventoryAttributesOrBuilder()

    public abstract 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-shopping-merchant-inventories/latest/com.google.shopping.merchant.inventories.v1.LocalInventoryAttributesOrBuilder` |   |

### getName()

    public abstract 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The name. |

### getNameBytes()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for name. |

### getStoreCode()

    public abstract 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](https://support.google.com/merchants/answer/3061342) for
more information.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The storeCode. |

### getStoreCodeBytes()

    public abstract 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](https://support.google.com/merchants/answer/3061342) for
more information.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for storeCode. |

### hasLocalInventoryAttributes()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the localInventoryAttributes field is set. |