Class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestFacetSpecFacetKey

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

Overview

Specifies how a facet is computed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2betaSearchRequestFacetSpecFacetKey

Returns a new instance of GoogleCloudRetailV2betaSearchRequestFacetSpecFacetKey.



3601
3602
3603
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3601

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


3514
3515
3516
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3514

def contains
  @contains
end

#intervals ⇒ Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaInterval>

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:



3521
3522
3523
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3521

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 = *# The Product.brands. * "brands"; *# The Product.categories. * "categories"; *# The Audience.genders. * | "genders"; *# The Audience.age_groups. * | "ageGroups"; *

The Product.availability. Value is one of * *# "IN_STOCK", "OUT_OF_STOCK",

PREORDER", "BACKORDER". * | "availability"; *# The ColorInfo.color_families. * | "colorFamilies"; *# The ColorInfo.colors. * | "colors"; *# The Product.sizes.

  • | "sizes"; *# The Product.materials. * | "materials"; *# The Product. patterns. * | "patterns"; *# The Product.conditions. * | "conditions"; *# The textual custom attribute in Product object. Key can * *# be any key in the Product.attributes map * *# if the attribute values are textual. * *# map. * | "attributes.key"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.Type. PICKUP_IN_STORE. * | "pickupInStore"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.Type.SHIP_TO_STORE. * | "shipToStore"; *# The FulfillmentInfo. ids for type *# FulfillmentInfo.Type.SAME_DAY_DELIVERY. * | "sameDayDelivery"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.Type.NEXT_DAY_DELIVERY.
  • | "nextDayDelivery"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo. Type.CUSTOM_TYPE_1. * | "customFulfillment1"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.Type.CUSTOM_TYPE_2. * | "customFulfillment2"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.Type.CUSTOM_TYPE_3. * | " customFulfillment3"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo. Type.CUSTOM_TYPE_4. * | "customFulfillment4"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.Type.CUSTOM_TYPE_5. * | "customFulfillment5"; * numerical_field = *# The PriceInfo.price. * "price"; *# The discount. Computed by (original_price-price)/price * "discount"; *# The Rating.average_rating. * " rating"; *# The Rating.rating_count. * "ratingCount"; *# The numerical custom attribute in Product object. Key can * *# be any key in the Product.attributes map * *# if the attribute values are numerical. * | "attributes.key"; Corresponds to the JSON property key

Returns:

  • (String) 


3554
3555
3556
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3554

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

Returns:

  • (String) 


3565
3566
3567
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3565

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


3574
3575
3576
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3574

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) 


3588
3589
3590
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3588

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


3599
3600
3601
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3599

def restricted_values
  @restricted_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3606
3607
3608
3609
3610
3611
3612
3613
3614
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3606

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