Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec

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

A facet specification to perform faceted search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaSearchRequestFacetSpec

Returns a new instance of GoogleCloudRetailV2alphaSearchRequestFacetSpec.



3333
3334
3335
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3333

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

Instance Attribute Details

#enable_dynamic_position ⇒ Boolean Also known as: enable_dynamic_position?

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * " brands", enable_dynamic_position = false And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or (" price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false. Corresponds to the JSON property enableDynamicPosition

Returns:

  • (Boolean) 


3305
3306
3307
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3305

def enable_dynamic_position
  @enable_dynamic_position
end

#excluded_filter_keys ⇒ Array<String>

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. For example, suppose there are 100 products with color facet "Red" and 200 products with color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and have "colorFamilies" as FacetKey.key will by default return the "Red" with count 100. If this field contains "colorFamilies", then the query returns both the "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property excludedFilterKeys

Returns:

  • (Array<String>) 


3319
3320
3321
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3319

def excluded_filter_keys
  @excluded_filter_keys
end

#facet_key ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey

Specifies how a facet is computed. Corresponds to the JSON property facetKey

Returns:



3324
3325
3326
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3324

def facet_key
  @facet_key
end

#limit ⇒ Fixnum

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


3331
3332
3333
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3331

def limit
  @limit
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3338
3339
3340
3341
3342
3343
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3338

def update!(**args)
  @enable_dynamic_position = args[:enable_dynamic_position] if args.key?(:enable_dynamic_position)
  @excluded_filter_keys = args[:excluded_filter_keys] if args.key?(:excluded_filter_keys)
  @facet_key = args[:facet_key] if args.key?(:facet_key)
  @limit = args[:limit] if args.key?(:limit)
end