Struct googapis::google::cloud::retail::v2::search_request::facet_spec::FacetKey [−][src]
pub struct FacetKey {
pub key: String,
pub intervals: Vec<Interval>,
pub restricted_values: Vec<String>,
pub prefixes: Vec<String>,
pub contains: Vec<String>,
pub order_by: String,
pub query: String,
}
Expand description
Specifies how a facet is computed.
Fields
key: String
Required. Supported textual and numerical facet keys in [Product][google.cloud.retail.v2.Product] object, over which the facet values are computed. Facet key is case-sensitive.
Allowed facet keys when [FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query] is not specified:
-
textual_field =
- “brands”
- “categories”
- “genders”
- “ageGroups”
- “availability”
- “colorFamilies”
- “colors”
- “sizes”
- “materials”
- “patterns”
- “conditions”
- “attributes.key”
- “pickupInStore”
- “shipToStore”
- “sameDayDelivery”
- “nextDayDelivery”
- “customFulfillment1”
- “customFulfillment2”
- “customFulfillment3”
- “customFulfillment4”
- “customFulfillment5”
- “inventory(place_id,attributes.key)”
-
numerical_field =
- “price”
- “discount”
- “rating”
- “ratingCount”
- “attributes.key”
- “inventory(place_id,price)”
- “inventory(place_id,attributes.key)”
intervals: Vec<Interval>
Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
restricted_values: Vec<String>
Only get facet for the given restricted values. For example, when using “pickupInStore” as key and set restricted values to [“store123”, “store456”], only facets for “store123” and “store456” are returned. Only supported on textual fields and fulfillments. Maximum is 20.
Must be set for the fulfillment facet keys:
-
pickupInStore
-
shipToStore
-
sameDayDelivery
-
nextDayDelivery
-
customFulfillment1
-
customFulfillment2
-
customFulfillment3
-
customFulfillment4
-
customFulfillment5
prefixes: Vec<String>
Only get facet values that start with the given string prefix. For example, suppose “categories” has three values “Women > Shoe”, “Women > Dress” and “Men > Shoe”. If set “prefixes” to “Women”, the “categories” facet will give only “Women > Shoe” and “Women > Dress”. Only supported on textual fields. Maximum is 10.
contains: Vec<String>
Only get facet values that contains the given strings. For example, suppose “categories” has three values “Women > Shoe”, “Women > Dress” and “Men > Shoe”. If set “contains” to “Shoe”, the “categories” facet will give only “Women > Shoe” and “Men > Shoe”. Only supported on textual fields. Maximum is 10.
order_by: String
The order in which [Facet.values][] are returned.
Allowed values are:
-
“count desc”, which means order by [Facet.FacetValue.count][] descending.
-
“value desc”, which means order by [Facet.FacetValue.value][] descending. Only applies to textual facets.
If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by [FacetSpec.FacetKey.intervals][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.intervals]; [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids] are sorted in the order given by [FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.restricted_values].
query: String
The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter expression. See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter] for detail syntax and limitations. Notice that there is no limitation on [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key] when query is specified.
In the response, [FacetValue.value][] will be always “1” and [FacetValue.count][] will be the number of results that matches the query.
For example, you can set a customized facet for “shipToStore”, where [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key] is “customizedShipToStore”, and [FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query] is “availability: ANY("IN_STOCK") AND shipToStore: ANY("123")”. Then the facet will count the products that are both in stock and ship to store “123”.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
Auto Trait Implementations
impl RefUnwindSafe for FacetKey
impl UnwindSafe for FacetKey
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more