- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static interface SearchResponse.SearchResultOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsMatchingVariantFields(String key)
public abstract boolean containsMatchingVariantFields(String key)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.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Name | Description |
| key | String |
| Type | Description |
| boolean |
containsVariantRollupValues(String key)
public abstract boolean containsVariantRollupValues(String key) 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".
map<string, .google.protobuf.Value> variant_rollup_values = 5;
| Name | Description |
| key | String |
| Type | Description |
| boolean |
getId()
public abstract String getId()Product.id of the searched Product.
string id = 1;
| Type | Description |
| String | The id. |
getIdBytes()
public abstract ByteString getIdBytes()Product.id of the searched Product.
string id = 1;
| Type | Description |
| ByteString | The bytes for id. |
getMatchingVariantCount()
public abstract int getMatchingVariantCount()The count of matched variant Products.
int32 matching_variant_count = 3;
| Type | Description |
| int | The matchingVariantCount. |
getMatchingVariantFields()
public abstract Map<String,FieldMask> getMatchingVariantFields()Use #getMatchingVariantFieldsMap() instead.
| Type | Description |
| Map<String,FieldMask> |
getMatchingVariantFieldsCount()
public abstract int getMatchingVariantFieldsCount()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.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Type | Description |
| int |
getMatchingVariantFieldsMap()
public abstract Map<String,FieldMask> getMatchingVariantFieldsMap()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.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Type | Description |
| Map<String,FieldMask> |
getMatchingVariantFieldsOrDefault(String key, FieldMask defaultValue)
public abstract FieldMask getMatchingVariantFieldsOrDefault(String key, FieldMask defaultValue)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.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Name | Description |
| key | String |
| defaultValue | FieldMask |
| Type | Description |
| FieldMask |
getMatchingVariantFieldsOrThrow(String key)
public abstract FieldMask getMatchingVariantFieldsOrThrow(String key)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.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Name | Description |
| key | String |
| Type | Description |
| FieldMask |
getPersonalLabels(int index)
public abstract String getPersonalLabels(int index)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.
repeated string personal_labels = 7;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The personalLabels at the given index. |
getPersonalLabelsBytes(int index)
public abstract ByteString getPersonalLabelsBytes(int index)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.
repeated string personal_labels = 7;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the personalLabels at the given index. |
getPersonalLabelsCount()
public abstract int getPersonalLabelsCount()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.
repeated string personal_labels = 7;
| Type | Description |
| int | The count of personalLabels. |
getPersonalLabelsList()
public abstract List<String> getPersonalLabelsList()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.
repeated string personal_labels = 7;
| Type | Description |
| List<String> | A list containing the personalLabels. |
getProduct()
public abstract Product 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.
.google.cloud.retail.v2alpha.Product product = 2;
| Type | Description |
| Product | The product. |
getProductOrBuilder()
public abstract ProductOrBuilder getProductOrBuilder()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.
.google.cloud.retail.v2alpha.Product product = 2;
| Type | Description |
| ProductOrBuilder |
getVariantRollupValues()
public abstract Map<String,Value> getVariantRollupValues()Use #getVariantRollupValuesMap() instead.
| Type | Description |
| Map<String,Value> |
getVariantRollupValuesCount()
public abstract int getVariantRollupValuesCount() 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".
map<string, .google.protobuf.Value> variant_rollup_values = 5;
| Type | Description |
| int |
getVariantRollupValuesMap()
public abstract Map<String,Value> getVariantRollupValuesMap() 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".
map<string, .google.protobuf.Value> variant_rollup_values = 5;
| Type | Description |
| Map<String,Value> |
getVariantRollupValuesOrDefault(String key, Value defaultValue)
public abstract Value getVariantRollupValuesOrDefault(String key, Value defaultValue) 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".
map<string, .google.protobuf.Value> variant_rollup_values = 5;
| Name | Description |
| key | String |
| defaultValue | Value |
| Type | Description |
| Value |
getVariantRollupValuesOrThrow(String key)
public abstract Value getVariantRollupValuesOrThrow(String key) 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".
map<string, .google.protobuf.Value> variant_rollup_values = 5;
| Name | Description |
| key | String |
| Type | Description |
| Value |
hasProduct()
public abstract boolean hasProduct()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.
.google.cloud.retail.v2alpha.Product product = 2;
| Type | Description |
| boolean | Whether the product field is set. |