# Retail V2 API - Class Google::Cloud::Retail::V2::ListProductsRequest (v2.9.0)

2.9.0 (latest) 2.8.1 2.7.0 2.6.1 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.3.0 1.2.0 1.1.0 1.0.1 0.21.0 0.20.0 0.19.0 0.18.2 0.17.0 0.16.1 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.6.4 Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::ListProductsRequest.

Request message for
[ProductService.ListProducts](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ProductService-Client#Google__Cloud__Retail__V2__ProductService__Client_list_products_instance_ "Google::Cloud::Retail::V2::ProductService::Client#list_products (method)")
method.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #filter

    def filter() -> ::String

**Returns**

- (::String) --- A filter to apply on the list results. Supported features:

  - List all the products under the parent branch if [filter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ListProductsRequest#Google__Cloud__Retail__V2__ListProductsRequest_filter_instance_ "Google::Cloud::Retail::V2::ListProductsRequest#filter (method)") is unset.
  - List [Product.Type.VARIANT](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__VARIANT "Google::Cloud::Retail::V2::Product::Type::VARIANT (constant)") [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s sharing the same [Product.Type.PRIMARY](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__PRIMARY "Google::Cloud::Retail::V2::Product::Type::PRIMARY (constant)") [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)"). For example: `primary_product_id = "some_product_id"`
  - List [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s bundled in a [Product.Type.COLLECTION](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__COLLECTION "Google::Cloud::Retail::V2::Product::Type::COLLECTION (constant)") [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)"). For example: `collection_product_id = "some_product_id"`
  - List [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s with a partibular type. For example: `type = "PRIMARY"` `type = "VARIANT"` `type = "COLLECTION"`

  If the field is unrecognizable, an INVALID_ARGUMENT error is returned.

  If the specified
  [Product.Type.PRIMARY](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__PRIMARY "Google::Cloud::Retail::V2::Product::Type::PRIMARY (constant)")
  [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") or
  [Product.Type.COLLECTION](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__COLLECTION "Google::Cloud::Retail::V2::Product::Type::COLLECTION (constant)")
  [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") does not exist, a NOT_FOUND error
  is returned.

### #filter=

    def filter=(value) -> ::String

**Parameter**

- **value** (::String) --- A filter to apply on the list results. Supported features:


  - List all the products under the parent branch if [filter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ListProductsRequest#Google__Cloud__Retail__V2__ListProductsRequest_filter_instance_ "Google::Cloud::Retail::V2::ListProductsRequest#filter (method)") is unset.
  - List [Product.Type.VARIANT](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__VARIANT "Google::Cloud::Retail::V2::Product::Type::VARIANT (constant)") [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s sharing the same [Product.Type.PRIMARY](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__PRIMARY "Google::Cloud::Retail::V2::Product::Type::PRIMARY (constant)") [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)"). For example: `primary_product_id = "some_product_id"`
  - List [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s bundled in a [Product.Type.COLLECTION](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__COLLECTION "Google::Cloud::Retail::V2::Product::Type::COLLECTION (constant)") [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)"). For example: `collection_product_id = "some_product_id"`
  - List [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s with a partibular type. For example: `type = "PRIMARY"` `type = "VARIANT"` `type = "COLLECTION"`

  If the field is unrecognizable, an INVALID_ARGUMENT error is returned.

  If the specified
  [Product.Type.PRIMARY](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__PRIMARY "Google::Cloud::Retail::V2::Product::Type::PRIMARY (constant)")
  [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") or
  [Product.Type.COLLECTION](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__COLLECTION "Google::Cloud::Retail::V2::Product::Type::COLLECTION (constant)")
  [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") does not exist, a NOT_FOUND error
  is returned.
**Returns**

- (::String) --- A filter to apply on the list results. Supported features:

  - List all the products under the parent branch if [filter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ListProductsRequest#Google__Cloud__Retail__V2__ListProductsRequest_filter_instance_ "Google::Cloud::Retail::V2::ListProductsRequest#filter (method)") is unset.
  - List [Product.Type.VARIANT](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__VARIANT "Google::Cloud::Retail::V2::Product::Type::VARIANT (constant)") [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s sharing the same [Product.Type.PRIMARY](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__PRIMARY "Google::Cloud::Retail::V2::Product::Type::PRIMARY (constant)") [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)"). For example: `primary_product_id = "some_product_id"`
  - List [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s bundled in a [Product.Type.COLLECTION](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__COLLECTION "Google::Cloud::Retail::V2::Product::Type::COLLECTION (constant)") [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)"). For example: `collection_product_id = "some_product_id"`
  - List [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s with a partibular type. For example: `type = "PRIMARY"` `type = "VARIANT"` `type = "COLLECTION"`

  If the field is unrecognizable, an INVALID_ARGUMENT error is returned.

  If the specified
  [Product.Type.PRIMARY](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__PRIMARY "Google::Cloud::Retail::V2::Product::Type::PRIMARY (constant)")
  [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") or
  [Product.Type.COLLECTION](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product-Type#Google__Cloud__Retail__V2__Product__Type__COLLECTION "Google::Cloud::Retail::V2::Product::Type::COLLECTION (constant)")
  [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") does not exist, a NOT_FOUND error
  is returned.

### #page_size

    def page_size() -> ::Integer

**Returns**

- (::Integer) --- Maximum number of [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.


  If this field is negative, an INVALID_ARGUMENT error is returned.

### #page_size=

    def page_size=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Maximum number of [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.


  If this field is negative, an INVALID_ARGUMENT error is returned.
**Returns**

- (::Integer) --- Maximum number of [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)")s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.


  If this field is negative, an INVALID_ARGUMENT error is returned.

### #page_token

    def page_token() -> ::String

**Returns**

- (::String) --- A page token [ListProductsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ListProductsResponse#Google__Cloud__Retail__V2__ListProductsResponse_next_page_token_instance_ "Google::Cloud::Retail::V2::ListProductsResponse#next_page_token (method)"), received from a previous [ProductService.ListProducts](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ProductService-Client#Google__Cloud__Retail__V2__ProductService__Client_list_products_instance_ "Google::Cloud::Retail::V2::ProductService::Client#list_products (method)") call. Provide this to retrieve the subsequent page.


  When paginating, all other parameters provided to
  [ProductService.ListProducts](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ProductService-Client#Google__Cloud__Retail__V2__ProductService__Client_list_products_instance_ "Google::Cloud::Retail::V2::ProductService::Client#list_products (method)")
  must match the call that provided the page token. Otherwise, an
  INVALID_ARGUMENT error is returned.

### #page_token=

    def page_token=(value) -> ::String

**Parameter**

- **value** (::String) --- A page token [ListProductsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ListProductsResponse#Google__Cloud__Retail__V2__ListProductsResponse_next_page_token_instance_ "Google::Cloud::Retail::V2::ListProductsResponse#next_page_token (method)"), received from a previous [ProductService.ListProducts](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ProductService-Client#Google__Cloud__Retail__V2__ProductService__Client_list_products_instance_ "Google::Cloud::Retail::V2::ProductService::Client#list_products (method)") call. Provide this to retrieve the subsequent page.


  When paginating, all other parameters provided to
  [ProductService.ListProducts](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ProductService-Client#Google__Cloud__Retail__V2__ProductService__Client_list_products_instance_ "Google::Cloud::Retail::V2::ProductService::Client#list_products (method)")
  must match the call that provided the page token. Otherwise, an
  INVALID_ARGUMENT error is returned.
**Returns**

- (::String) --- A page token [ListProductsResponse.next_page_token](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ListProductsResponse#Google__Cloud__Retail__V2__ListProductsResponse_next_page_token_instance_ "Google::Cloud::Retail::V2::ListProductsResponse#next_page_token (method)"), received from a previous [ProductService.ListProducts](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ProductService-Client#Google__Cloud__Retail__V2__ProductService__Client_list_products_instance_ "Google::Cloud::Retail::V2::ProductService::Client#list_products (method)") call. Provide this to retrieve the subsequent page.


  When paginating, all other parameters provided to
  [ProductService.ListProducts](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ProductService-Client#Google__Cloud__Retail__V2__ProductService__Client_list_products_instance_ "Google::Cloud::Retail::V2::ProductService::Client#list_products (method)")
  must match the call that provided the page token. Otherwise, an
  INVALID_ARGUMENT error is returned.

### #parent

    def parent() -> ::String

**Returns**

- (::String) --- Required. The parent branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use `default_branch` as the branch ID, to list products under the default branch.


  If the caller does not have permission to list
  {::Google::Cloud::Retail::V2::Product Product}s under this branch, regardless of
  whether or not this branch exists, a PERMISSION_DENIED error is returned.

### #parent=

    def parent=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The parent branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use `default_branch` as the branch ID, to list products under the default branch.


  If the caller does not have permission to list
  {::Google::Cloud::Retail::V2::Product Product}s under this branch, regardless of
  whether or not this branch exists, a PERMISSION_DENIED error is returned.
**Returns**

- (::String) --- Required. The parent branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use `default_branch` as the branch ID, to list products under the default branch.


  If the caller does not have permission to list
  {::Google::Cloud::Retail::V2::Product Product}s under this branch, regardless of
  whether or not this branch exists, a PERMISSION_DENIED error is returned.

### #read_mask

    def read_mask() -> ::Google::Protobuf::FieldMask

**Returns**

- ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Protobuf-FieldMask)) --- The fields of [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") to return in the responses. If not set or empty, the following fields are returned:


  - [Product.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_name_instance_ "Google::Cloud::Retail::V2::Product#name (method)")
  - [Product.id](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_id_instance_ "Google::Cloud::Retail::V2::Product#id (method)")
  - [Product.title](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_title_instance_ "Google::Cloud::Retail::V2::Product#title (method)")
  - [Product.uri](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_uri_instance_ "Google::Cloud::Retail::V2::Product#uri (method)")
  - [Product.images](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_images_instance_ "Google::Cloud::Retail::V2::Product#images (method)")
  - [Product.price_info](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_price_info_instance_ "Google::Cloud::Retail::V2::Product#price_info (method)")
  - [Product.brands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_brands_instance_ "Google::Cloud::Retail::V2::Product#brands (method)")

  If "\*" is provided, all fields are returned.
  [Product.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_name_instance_ "Google::Cloud::Retail::V2::Product#name (method)") is always returned no
  matter what mask is set.

  If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
  is returned.

### #read_mask=

    def read_mask=(value) -> ::Google::Protobuf::FieldMask

**Parameter**

- **value** ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Protobuf-FieldMask)) --- The fields of [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") to return in the responses. If not set or empty, the following fields are returned:


  - [Product.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_name_instance_ "Google::Cloud::Retail::V2::Product#name (method)")
  - [Product.id](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_id_instance_ "Google::Cloud::Retail::V2::Product#id (method)")
  - [Product.title](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_title_instance_ "Google::Cloud::Retail::V2::Product#title (method)")
  - [Product.uri](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_uri_instance_ "Google::Cloud::Retail::V2::Product#uri (method)")
  - [Product.images](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_images_instance_ "Google::Cloud::Retail::V2::Product#images (method)")
  - [Product.price_info](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_price_info_instance_ "Google::Cloud::Retail::V2::Product#price_info (method)")
  - [Product.brands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_brands_instance_ "Google::Cloud::Retail::V2::Product#brands (method)")

  If "\*" is provided, all fields are returned.
  [Product.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_name_instance_ "Google::Cloud::Retail::V2::Product#name (method)") is always returned no
  matter what mask is set.

  If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
  is returned.
**Returns**

- ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Protobuf-FieldMask)) --- The fields of [Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product "Google::Cloud::Retail::V2::Product (class)") to return in the responses. If not set or empty, the following fields are returned:


  - [Product.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_name_instance_ "Google::Cloud::Retail::V2::Product#name (method)")
  - [Product.id](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_id_instance_ "Google::Cloud::Retail::V2::Product#id (method)")
  - [Product.title](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_title_instance_ "Google::Cloud::Retail::V2::Product#title (method)")
  - [Product.uri](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_uri_instance_ "Google::Cloud::Retail::V2::Product#uri (method)")
  - [Product.images](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_images_instance_ "Google::Cloud::Retail::V2::Product#images (method)")
  - [Product.price_info](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_price_info_instance_ "Google::Cloud::Retail::V2::Product#price_info (method)")
  - [Product.brands](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_brands_instance_ "Google::Cloud::Retail::V2::Product#brands (method)")

  If "\*" is provided, all fields are returned.
  [Product.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_name_instance_ "Google::Cloud::Retail::V2::Product#name (method)") is always returned no
  matter what mask is set.

  If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
  is returned.