Class GoogleCloudRetailV2SearchResponseSearchResult

Represents the search results.

Inheritance
object
GoogleCloudRetailV2SearchResponseSearchResult
Implements
Inherited Members
Namespace: Google.Apis.CloudRetail.v2.Data
Assembly: Google.Apis.CloudRetail.v2.dll
Syntax
public class GoogleCloudRetailV2SearchResponseSearchResult : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Id

Product.id of the searched Product.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

MatchingVariantCount

The count of matched variant Products.

Declaration
[JsonProperty("matchingVariantCount")]
public virtual int? MatchingVariantCount { get; set; }
Property Value
Type Description
int?

MatchingVariantFields

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.

Declaration
[JsonProperty("matchingVariantFields")]
public virtual IDictionary<string, object> MatchingVariantFields { get; set; }
Property Value
Type Description
IDictionary<string, object>

PersonalLabels

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.

Declaration
[JsonProperty("personalLabels")]
public virtual IList<string> PersonalLabels { get; set; }
Property Value
Type Description
IList<string>

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.

Declaration
[JsonProperty("product")]
public virtual GoogleCloudRetailV2Product Product { get; set; }
Property Value
Type Description
GoogleCloudRetailV2Product

VariantRollupValues

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".

Declaration
[JsonProperty("variantRollupValues")]
public virtual IDictionary<string, object> VariantRollupValues { get; set; }
Property Value
Type Description
IDictionary<string, object>

Implements