Class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestFacetSpecFacetKey

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

Specifies how a facet is computed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2SearchRequestFacetSpecFacetKey

Returns a new instance of GoogleCloudRetailV2SearchRequestFacetSpecFacetKey.



2710
2711
2712
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2710

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#contains ⇒ Array<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. Corresponds to the JSON property contains

Returns:

  • (Array<String>) 


2642
2643
2644
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2642

def contains
  @contains
end

#intervals ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2Interval>

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. Corresponds to the JSON property intervals

Returns:



2649
2650
2651
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2649

def intervals
  @intervals
end

#key ⇒ String

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" * numerical_field = * "price" * " discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id, price)" Corresponds to the JSON property key

Returns:

  • (String) 


2663
2664
2665
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2663

def key
  @key
end

#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; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values. Corresponds to the JSON property orderBy

Returns:

  • (String) 


2674
2675
2676
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2674

def order_by
  @order_by
end

#prefixes ⇒ Array<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. Corresponds to the JSON property prefixes

Returns:

  • (Array<String>) 


2683
2684
2685
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2683

def prefixes
  @prefixes
end

#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 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". Corresponds to the JSON property query

Returns:

  • (String) 


2697
2698
2699
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2697

def query
  @query
end

#restricted_values ⇒ Array<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 Corresponds to the JSON property restrictedValues

Returns:

  • (Array<String>) 


2708
2709
2710
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2708

def restricted_values
  @restricted_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2715
2716
2717
2718
2719
2720
2721
2722
2723
 
# File 'lib/google/apis/retail_v2/classes.rb', line 2715

def update!(**args)
  @contains = args[:contains] if args.key?(:contains)
  @intervals = args[:intervals] if args.key?(:intervals)
  @key = args[:key] if args.key?(:key)
  @order_by = args[:order_by] if args.key?(:order_by)
  @prefixes = args[:prefixes] if args.key?(:prefixes)
  @query = args[:query] if args.key?(:query)
  @restricted_values = args[:restricted_values] if args.key?(:restricted_values)
end