Class: Google::Apis::RetailV2::GoogleCloudRetailV2RuleForceReturnFacetAction

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

Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is " size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2RuleForceReturnFacetAction

Returns a new instance of GoogleCloudRetailV2RuleForceReturnFacetAction.



4290
4291
4292
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4290

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

Instance Attribute Details

#facet_position_adjustments ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment>

Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. Corresponds to the JSON property facetPositionAdjustments

Returns:



4288
4289
4290
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4288

def facet_position_adjustments
  @facet_position_adjustments
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4295
4296
4297
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4295

def update!(**args)
  @facet_position_adjustments = args[:facet_position_adjustments] if args.key?(:facet_position_adjustments)
end