Class FacetKey (1.7.0)

Version 1.7.0

• 1.24.0 (latest)
• 1.23.1
• 1.22.0
• 1.21.2
• 1.20.1
• 1.19.1
• 1.18.0
• 1.17.0
• 1.16.3
• 1.15.1
• 1.14.1
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.2
• 0.4.2
• 0.3.1
• 0.2.0
• 0.1.0

FacetKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Specifies how a facet is computed.

Attributes
Name	Description
key	str Required. Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when 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,original_price)" - "inventory(place_id,attributes.key)".
intervals	Sequence[google.cloud.retail_v2alpha.types.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	Sequence[str] 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	Sequence[str] 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	Sequence[str] 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	str 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
query	str 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 for detail syntax and limitations. Notice that there is no limitation on 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 is "customizedShipToStore", and 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".