public sealed class BoostAction : IMessage<Rule.Types.BoostAction>, IEquatable<Rule.Types.BoostAction>, IDeepCloneable<Rule.Types.BoostAction>, IBufferMessage, IMessage
Reference documentation and code samples for the Retail v2 API class Rule.Types.BoostAction.
A boost action to apply to results matching condition specified above.
Strength of the condition boost, which must be in [-1, 1]. Negative
boost means demotion. Default is 0.0.
Setting to 1.0 gives the item a big promotion. However, it does not
necessarily mean that the boosted item will be the top result at all
times, nor that other items will be excluded. Results could still be
shown even when none of them matches the condition. And results that
are significantly more relevant to the search query can still trump
your heavily favored but irrelevant items.
Setting to -1.0 gives the item a big demotion. However, results that
are deeply relevant might still be shown. The item will have an
upstream battle to get a fairly high ranking, but it is not blocked out
completely.
Setting to 0.0 means no boost applied. The boosting condition is
ignored.
The filter can have a max size of 5000 characters.
An expression which specifies which products to apply an action to.
The syntax and supported fields are the same as a filter expression. See
[SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter] for
detail syntax and limitations.
Examples:
To boost products with product ID "product_1" or "product_2", and
color
"Red" or "Blue":<br>
(id: ANY("product_1", "product_2"))<br>AND<br>(colorFamilies: ANY("Red", "Blue"))<br>
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis webpage provides reference documentation for the \u003ccode\u003eRule.Types.BoostAction\u003c/code\u003e class in the Google Cloud Retail V2 API, specifically within the .NET environment, with the latest version being 2.12.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBoostAction\u003c/code\u003e class is used to apply a boost or demotion to search results that meet specific conditions, and it implements several interfaces such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe page details the inheritance structure of \u003ccode\u003eBoostAction\u003c/code\u003e, which inherits from \u003ccode\u003eObject\u003c/code\u003e, along with its implemented interfaces and inherited members.\u003c/p\u003e\n"],["\u003cp\u003eIt outlines the properties of the \u003ccode\u003eBoostAction\u003c/code\u003e class, including \u003ccode\u003eBoost\u003c/code\u003e, which determines the strength of the boost or demotion, and \u003ccode\u003eProductsFilter\u003c/code\u003e, which allows for specifying the products to which the action applies.\u003c/p\u003e\n"],["\u003cp\u003eThe content shows 20 versions of the \u003ccode\u003eRule.Types.BoostAction\u003c/code\u003e class, including the latest version, and all the versions that have came before it.\u003c/p\u003e\n"]]],[],null,[]]
