Reference documentation and code samples for the Google Cloud Retail V2 Client class SearchResult.
Represents the search results.
Generated from protobuf message google.cloud.retail.v2.SearchResponse.SearchResult
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
Product.id of the searched Product. |
↳ product |
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. |
↳ matching_variant_count |
int
|
↳ matching_variant_fields |
array|Google\Protobuf\Internal\MapField
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. |
↳ variant_rollup_values |
array|Google\Protobuf\Internal\MapField
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, |
↳ personal_labels |
array
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: * |
getId
Product.id of the searched Product.
Generated from protobuf field string id = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setId
Product.id of the searched Product.
Generated from protobuf field string id = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProduct
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.
Generated from protobuf field .google.cloud.retail.v2.Product product = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Retail\V2\Product|null | |
hasProduct
clearProduct
setProduct
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.
Generated from protobuf field .google.cloud.retail.v2.Product product = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Retail\V2\Product
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMatchingVariantCount
The count of matched variant Products.
Generated from protobuf field int32 matching_variant_count = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
setMatchingVariantCount
The count of matched variant Products.
Generated from protobuf field int32 matching_variant_count = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMatchingVariantFields
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.
Generated from protobuf field map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setMatchingVariantFields
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.
Generated from protobuf field map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVariantRollupValues
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".
Generated from protobuf field map<string, .google.protobuf.Value> variant_rollup_values = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setVariantRollupValues
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".
Generated from protobuf field map<string, .google.protobuf.Value> variant_rollup_values = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPersonalLabels
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.
Generated from protobuf field repeated string personal_labels = 7;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPersonalLabels
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.
Generated from protobuf field repeated string personal_labels = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |