Retail V2 API - Class Google::Cloud::Retail::V2::SearchResponse::SearchResult (v0.12.0)

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 of the searched Product.

#id=

def id=(value) -> ::String

Parameter

value (::String) — Product.id of the searched Product.

Returns

(::String) — Product.id of the searched Product.

#matching_variant_count

def matching_variant_count() -> ::Integer

Returns

(::Integer) — The count of matched variant {::Google::Cloud::Retail::V2::Product Product}s.

#matching_variant_count=

def matching_variant_count=(value) -> ::Integer

Parameter

value (::Integer) — The count of matched variant {::Google::Cloud::Retail::V2::Product Product}s.

Returns

(::Integer) — The count of matched variant {::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 Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched Product 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 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 Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched Product 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 and the query.

Returns

(::Google::Protobuf::Map{::String => ::Google::Protobuf::FieldMask}) — If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched Product 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 and the query.

#personal_labels

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

Returns

(::Array<::String>) —
Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id.

This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.

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 with same SearchRequest.visitor_id or UserInfo.user_id.

This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.

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 with same SearchRequest.visitor_id or UserInfo.user_id.

This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.

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) — The product data snippet in the search response. Only Product.name is guaranteed to be populated.

Product.variants 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 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) — The product data snippet in the search response. Only Product.name is guaranteed to be populated.

Product.variants 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 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) — The product data snippet in the search response. Only Product.name is guaranteed to be populated.

Product.variants 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 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 Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated Product 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. 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, the rollup values is a double value with type google.protobuf.Value. 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 Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated Product 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. 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, the rollup values is a double value with type google.protobuf.Value. 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 Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated Product 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. 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, the rollup values is a double value with type google.protobuf.Value. For example, {key: "pickupInStore.store1" value { number_value: 10 }} means a there are 10 variants in this product are available in the store "store1".