Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey

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

Overview

Specifies how a facet is computed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey

Returns a new instance of GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey.



4565
4566
4567
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 4565

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

Instance Attribute Details

#case_insensitive ⇒ Boolean Also known as: case_insensitive?

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. Corresponds to the JSON property caseInsensitive

Returns:

  • (Boolean) 


4486
4487
4488
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 4486

def case_insensitive
  @case_insensitive
end

#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>) 


4495
4496
4497
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 4495

def contains
  @contains
end

#intervals ⇒ Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaInterval>

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:



4502
4503
4504
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 4502

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" * "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)" Corresponds to the JSON property key

Returns:

  • (String) 


4517
4518
4519
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 4517

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) 


4528
4529
4530
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 4528

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>) 


4537
4538
4539
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 4537

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) 


4551
4552
4553
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 4551

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 predefined textual fields, custom textual attributes 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>) 


4563
4564
4565
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 4563

def restricted_values
  @restricted_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 4570

def update!(**args)
  @case_insensitive = args[:case_insensitive] if args.key?(:case_insensitive)
  @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