# Interface GetProductRequestOrBuilder (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.26.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

    public interface GetProductRequestOrBuilder extends MessageOrBuilder

## Implements

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

## Methods

### getName()

    public abstract String getName()

Required. The name of the product.
Format: `accounts/{account}/products/{product}`

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

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.

   Note: For calls to the v1beta version, the plain format is
   `channel~content_language~feed_label~offer_id`, for example:
   `accounts/123/products/online~en~US~sku123`.

`
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

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

### getNameBytes()

    public abstract ByteString getNameBytes()

Required. The name of the product.
Format: `accounts/{account}/products/{product}`

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

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.

   Note: For calls to the v1beta version, the plain format is
   `channel~content_language~feed_label~offer_id`, for example:
   `accounts/123/products/online~en~US~sku123`.

`
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

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