# Retail V2 API - Class Google::Cloud::Retail::V2::SearchResponse::SearchResult (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::SearchResponse::SearchResult.

Represents the search results.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #id

    def id() -> ::String

**Returns**

- (::String) --- [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)") of the searched [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)").

### #id=

    def id=(value) -> ::String

**Parameter**

- **value** (::String) --- [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)") of the searched [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)").
**Returns**

- (::String) --- [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)") of the searched [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)").

### #matching_variant_count

    def matching_variant_count() -> ::Integer

**Returns**

- (::Integer) --- The count of matched [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)") {::Google::Cloud::Retail::V2::Product Product}s.

### #matching_variant_count=

    def matching_variant_count=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- The count of matched [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)") {::Google::Cloud::Retail::V2::Product Product}s.
**Returns**

- (::Integer) --- The count of matched [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)") {::Google::Cloud::Retail::V2::Product Product}s.

### #matching_variant_fields

    def matching_variant_fields() -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::FieldMask}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Protobuf::FieldMask}) --- If a [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)") matches the search query, this map indicates which [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)") fields are matched. The key is the [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)"), the value is a field mask of the matched [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)") fields. If matched attributes cannot be determined, this map will be empty.


  For example, a key "sku1" with field mask
  "products.color_info" indicates there is a match between
  "sku1" [ColorInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ColorInfo "Google::Cloud::Retail::V2::ColorInfo (class)") and the query.

### #matching_variant_fields=

    def matching_variant_fields=(value) -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::FieldMask}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::Google::Protobuf::FieldMask}) --- If a [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)") matches the search query, this map indicates which [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)") fields are matched. The key is the [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)"), the value is a field mask of the matched [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)") fields. If matched attributes cannot be determined, this map will be empty.


  For example, a key "sku1" with field mask
  "products.color_info" indicates there is a match between
  "sku1" [ColorInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ColorInfo "Google::Cloud::Retail::V2::ColorInfo (class)") and the query.
**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Protobuf::FieldMask}) --- If a [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)") matches the search query, this map indicates which [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)") fields are matched. The key is the [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)"), the value is a field mask of the matched [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)") fields. If matched attributes cannot be determined, this map will be empty.


  For example, a key "sku1" with field mask
  "products.color_info" indicates there is a match between
  "sku1" [ColorInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-ColorInfo "Google::Cloud::Retail::V2::ColorInfo (class)") and the query.

### #model_scores

    def model_scores() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::DoubleList}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Cloud::Retail::V2::DoubleList}) --- Google provided available scores.

### #model_scores=

    def model_scores=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::DoubleList}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::Google::Cloud::Retail::V2::DoubleList}) --- Google provided available scores.
**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Cloud::Retail::V2::DoubleList}) --- Google provided available scores.

### #personal_labels

    def personal_labels() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- Specifies previous events related to this product for this user based on
  [UserEvent](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-UserEvent "Google::Cloud::Retail::V2::UserEvent (class)") with same
  [SearchRequest.visitor_id](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest#Google__Cloud__Retail__V2__SearchRequest_visitor_id_instance_ "Google::Cloud::Retail::V2::SearchRequest#visitor_id (method)")
  or [UserInfo.user_id](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-UserInfo#Google__Cloud__Retail__V2__UserInfo_user_id_instance_ "Google::Cloud::Retail::V2::UserInfo#user_id (method)").

  This is set only when
  [SearchRequest.PersonalizationSpec.mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest-PersonalizationSpec#Google__Cloud__Retail__V2__SearchRequest__PersonalizationSpec_mode_instance_ "Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec#mode (method)")
  is
  [SearchRequest.PersonalizationSpec.Mode.AUTO](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest-PersonalizationSpec-Mode#Google__Cloud__Retail__V2__SearchRequest__PersonalizationSpec__Mode__AUTO "Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec::Mode::AUTO (constant)").

  Possible values:
  - `purchased`: Indicates that this product has been purchased before.

### #personal_labels=

    def personal_labels=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) ---

  Specifies previous events related to this product for this user based on
  [UserEvent](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-UserEvent "Google::Cloud::Retail::V2::UserEvent (class)") with same
  [SearchRequest.visitor_id](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest#Google__Cloud__Retail__V2__SearchRequest_visitor_id_instance_ "Google::Cloud::Retail::V2::SearchRequest#visitor_id (method)")
  or [UserInfo.user_id](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-UserInfo#Google__Cloud__Retail__V2__UserInfo_user_id_instance_ "Google::Cloud::Retail::V2::UserInfo#user_id (method)").

  This is set only when
  [SearchRequest.PersonalizationSpec.mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest-PersonalizationSpec#Google__Cloud__Retail__V2__SearchRequest__PersonalizationSpec_mode_instance_ "Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec#mode (method)")
  is
  [SearchRequest.PersonalizationSpec.Mode.AUTO](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest-PersonalizationSpec-Mode#Google__Cloud__Retail__V2__SearchRequest__PersonalizationSpec__Mode__AUTO "Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec::Mode::AUTO (constant)").

  Possible values:
  - `purchased`: Indicates that this product has been purchased before.
**Returns**

- (::Array\<::String\>) --- Specifies previous events related to this product for this user based on
  [UserEvent](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-UserEvent "Google::Cloud::Retail::V2::UserEvent (class)") with same
  [SearchRequest.visitor_id](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest#Google__Cloud__Retail__V2__SearchRequest_visitor_id_instance_ "Google::Cloud::Retail::V2::SearchRequest#visitor_id (method)")
  or [UserInfo.user_id](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-UserInfo#Google__Cloud__Retail__V2__UserInfo_user_id_instance_ "Google::Cloud::Retail::V2::UserInfo#user_id (method)").

  This is set only when
  [SearchRequest.PersonalizationSpec.mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest-PersonalizationSpec#Google__Cloud__Retail__V2__SearchRequest__PersonalizationSpec_mode_instance_ "Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec#mode (method)")
  is
  [SearchRequest.PersonalizationSpec.Mode.AUTO](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest-PersonalizationSpec-Mode#Google__Cloud__Retail__V2__SearchRequest__PersonalizationSpec__Mode__AUTO "Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec::Mode::AUTO (constant)").

  Possible values:
  - `purchased`: Indicates that this product has been purchased before.

### #product

    def product() -> ::Google::Cloud::Retail::V2::Product

**Returns**

- ([::Google::Cloud::Retail::V2::Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product)) --- The product data snippet in the search response. Only [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 guaranteed to be populated.


  [Product.variants](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_variants_instance_ "Google::Cloud::Retail::V2::Product#variants (method)") contains the
  product variants that match the search query. If there are multiple
  product variants matching the query, top 5 most relevant product variants
  are returned and ordered by relevancy.

  If relevancy can be deternmined, use
  [matching_variant_fields](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchResponse-SearchResult#Google__Cloud__Retail__V2__SearchResponse__SearchResult_matching_variant_fields_instance_ "Google::Cloud::Retail::V2::SearchResponse::SearchResult#matching_variant_fields (method)")
  to look up matched product variants fields. If relevancy cannot be
  determined, e.g. when searching "shoe" all products in a shoe product can
  be a match, 5 product variants are returned but order is meaningless.

### #product=

    def product=(value) -> ::Google::Cloud::Retail::V2::Product

**Parameter**

- **value** ([::Google::Cloud::Retail::V2::Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product)) --- The product data snippet in the search response. Only [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 guaranteed to be populated.


  [Product.variants](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_variants_instance_ "Google::Cloud::Retail::V2::Product#variants (method)") contains the
  product variants that match the search query. If there are multiple
  product variants matching the query, top 5 most relevant product variants
  are returned and ordered by relevancy.

  If relevancy can be deternmined, use
  [matching_variant_fields](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchResponse-SearchResult#Google__Cloud__Retail__V2__SearchResponse__SearchResult_matching_variant_fields_instance_ "Google::Cloud::Retail::V2::SearchResponse::SearchResult#matching_variant_fields (method)")
  to look up matched product variants fields. If relevancy cannot be
  determined, e.g. when searching "shoe" all products in a shoe product can
  be a match, 5 product variants are returned but order is meaningless.
**Returns**

- ([::Google::Cloud::Retail::V2::Product](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product)) --- The product data snippet in the search response. Only [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 guaranteed to be populated.


  [Product.variants](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-Product#Google__Cloud__Retail__V2__Product_variants_instance_ "Google::Cloud::Retail::V2::Product#variants (method)") contains the
  product variants that match the search query. If there are multiple
  product variants matching the query, top 5 most relevant product variants
  are returned and ordered by relevancy.

  If relevancy can be deternmined, use
  [matching_variant_fields](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchResponse-SearchResult#Google__Cloud__Retail__V2__SearchResponse__SearchResult_matching_variant_fields_instance_ "Google::Cloud::Retail::V2::SearchResponse::SearchResult#matching_variant_fields (method)")
  to look up matched product variants fields. If relevancy cannot be
  determined, e.g. when searching "shoe" all products in a shoe product can
  be a match, 5 product variants are returned but order is meaningless.

### #variant_rollup_values

    def variant_rollup_values() -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Protobuf::Value}) --- The rollup matching [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)") attributes. The key is one of the [SearchRequest.variant_rollup_keys](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest#Google__Cloud__Retail__V2__SearchRequest_variant_rollup_keys_instance_ "Google::Cloud::Retail::V2::SearchRequest#variant_rollup_keys (method)"). The values are the merged and de-duplicated [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)") attributes. Notice that the rollup values are respect filter. For example, when filtering by "colorFamilies:ANY(\\"red\\")" and rollup "colorFamilies", only "red" is returned.


  For textual and numerical attributes, the rollup values is a list of
  string or double values with type
  [google.protobuf.ListValue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Protobuf-ListValue "Google::Protobuf::ListValue (class)"). For example, if
  there are two variants with colors "red" and "blue", the rollup values
  are

      { key: "colorFamilies"
        value {
          list_value {
            values { string_value: "red" }
            values { string_value: "blue" }
           }
        }
      }

  For [FulfillmentInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-FulfillmentInfo "Google::Cloud::Retail::V2::FulfillmentInfo (class)"), the rollup
  values is a double value with type
  [google.protobuf.Value](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Protobuf-Value "Google::Protobuf::Value (class)"). For example,
  `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
  are 10 variants in this product are available in the store "store1".

### #variant_rollup_values=

    def variant_rollup_values=(value) -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::Google::Protobuf::Value}) --- The rollup matching [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)") attributes. The key is one of the [SearchRequest.variant_rollup_keys](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest#Google__Cloud__Retail__V2__SearchRequest_variant_rollup_keys_instance_ "Google::Cloud::Retail::V2::SearchRequest#variant_rollup_keys (method)"). The values are the merged and de-duplicated [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)") attributes. Notice that the rollup values are respect filter. For example, when filtering by "colorFamilies:ANY(\\"red\\")" and rollup "colorFamilies", only "red" is returned.


  For textual and numerical attributes, the rollup values is a list of
  string or double values with type
  [google.protobuf.ListValue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Protobuf-ListValue "Google::Protobuf::ListValue (class)"). For example, if
  there are two variants with colors "red" and "blue", the rollup values
  are

      { key: "colorFamilies"
        value {
          list_value {
            values { string_value: "red" }
            values { string_value: "blue" }
           }
        }
      }

  For [FulfillmentInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-FulfillmentInfo "Google::Cloud::Retail::V2::FulfillmentInfo (class)"), the rollup
  values is a double value with type
  [google.protobuf.Value](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Protobuf-Value "Google::Protobuf::Value (class)"). For example,
  `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
  are 10 variants in this product are available in the store "store1".
**Returns**

- (::Google::Protobuf::Map{::String =\> ::Google::Protobuf::Value}) --- The rollup matching [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)") attributes. The key is one of the [SearchRequest.variant_rollup_keys](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-SearchRequest#Google__Cloud__Retail__V2__SearchRequest_variant_rollup_keys_instance_ "Google::Cloud::Retail::V2::SearchRequest#variant_rollup_keys (method)"). The values are the merged and de-duplicated [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)") attributes. Notice that the rollup values are respect filter. For example, when filtering by "colorFamilies:ANY(\\"red\\")" and rollup "colorFamilies", only "red" is returned.


  For textual and numerical attributes, the rollup values is a list of
  string or double values with type
  [google.protobuf.ListValue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Protobuf-ListValue "Google::Protobuf::ListValue (class)"). For example, if
  there are two variants with colors "red" and "blue", the rollup values
  are

      { key: "colorFamilies"
        value {
          list_value {
            values { string_value: "red" }
            values { string_value: "blue" }
           }
        }
      }

  For [FulfillmentInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Cloud-Retail-V2-FulfillmentInfo "Google::Cloud::Retail::V2::FulfillmentInfo (class)"), the rollup
  values is a double value with type
  [google.protobuf.Value](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest/Google-Protobuf-Value "Google::Protobuf::Value (class)"). For example,
  `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
  are 10 variants in this product are available in the store "store1".