View Source GoogleApi.Retail.V2.Model.GoogleCloudRetailV2RuleForceReturnFacetAction (google_api_retail v0.19.1)

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.

Attributes

  • facetPositionAdjustments (type: list(GoogleApi.Retail.V2.Model.GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment.t), default: nil) - Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Retail.V2.Model.GoogleCloudRetailV2RuleForceReturnFacetAction{
  facetPositionAdjustments:
    [
      GoogleApi.Retail.V2.Model.GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment.t()
    ]
    | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.