Google Cloud Retail V2 Client - Class ForceReturnFacetAction (2.1.0)

Reference documentation and code samples for the Google Cloud Retail V2 Client class ForceReturnFacetAction.

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.

Generated from protobuf message google.cloud.retail.v2.Rule.ForceReturnFacetAction

Namespace

Google \ Cloud \ Retail \ V2 \ Rule

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ facet_position_adjustments`	`array<Google\Cloud\Retail\V2\Rule\ForceReturnFacetAction\FacetPositionAdjustment>` Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

Parameter
Name	Description
`var`	`array<Google\Cloud\Retail\V2\Rule\ForceReturnFacetAction\FacetPositionAdjustment>`

Returns
Type	Description
`$this`