Class ForceReturnFacetAction (1.21.2)

Version latest

• 1.21.2 (latest)
• 1.21.1
• 1.20.1
• 1.19.1
• 1.18.0
• 1.17.0
• 1.16.3
• 1.15.1
• 1.14.1
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.2
• 0.4.2
• 0.3.1
• 0.2.0
• 0.1.0

ForceReturnFacetAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attribute
Name	Description
facet_position_adjustments	MutableSequence[google.cloud.retail_v2beta.types.Rule.ForceReturnFacetAction.FacetPositionAdjustment] Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.

Classes

FacetPositionAdjustment

FacetPositionAdjustment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.