View Source GoogleApi.Retail.V2.Model.GoogleCloudRetailV2SearchRequestFacetSpecFacetKey (google_api_retail v0.3.0)

Specifies how a facet is computed.

Attributes

  • contains (type: list(String.t), default: nil) - 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.
  • intervals (type: list(GoogleApi.Retail.V2.Model.GoogleCloudRetailV2Interval.t), default: nil) - 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.
  • key (type: String.t, default: nil) - 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)"
  • orderBy (type: String.t, default: nil) - 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; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
  • prefixes (type: list(String.t), default: nil) - 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.
  • query (type: String.t, default: nil) - 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".
  • restrictedValues (type: list(String.t), default: nil) - 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

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() ::
  %GoogleApi.Retail.V2.Model.GoogleCloudRetailV2SearchRequestFacetSpecFacetKey{
    contains: [String.t()] | nil,
    intervals:
      [GoogleApi.Retail.V2.Model.GoogleCloudRetailV2Interval.t()] | nil,
    key: String.t() | nil,
    orderBy: String.t() | nil,
    prefixes: [String.t()] | nil,
    query: String.t() | nil,
    restrictedValues: [String.t()] | nil
  }

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.