Reference documentation and code samples for the Google Cloud Retail V2 Client class BoostAction.
A boost action to apply to results matching condition specified above.
Generated from protobuf messagegoogle.cloud.retail.v2.Rule.BoostAction
Namespace
Google \ Cloud \ Retail \ V2 \ Rule
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ boost
float
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.
↳ products_filter
string
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. SeeSearchRequest.filterfor detail syntax and limitations. Examples: * * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue":(id: ANY("product_1", "product_2")) AND (colorFamilies: ANY("Red", "Blue"))
getBoost
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.
Returns
Type
Description
float
setBoost
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.
Parameter
Name
Description
var
float
Returns
Type
Description
$this
getProductsFilter
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. SeeSearchRequest.filterfor
detail syntax and limitations.
Examples:
To boost products with product ID "product_1" or "product_2", and
color
"Red" or "Blue": (id: ANY("product_1", "product_2")) AND (colorFamilies: ANY("Red", "Blue"))
Returns
Type
Description
string
setProductsFilter
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. SeeSearchRequest.filterfor
detail syntax and limitations.
Examples:
To boost products with product ID "product_1" or "product_2", and
color
"Red" or "Blue": (id: ANY("product_1", "product_2")) AND (colorFamilies: ANY("Red", "Blue"))
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Retail V2 Client - Class BoostAction (2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/php/docs/reference/cloud-retail/latest/V2.Rule.BoostAction)\n- [2.3.0](/php/docs/reference/cloud-retail/2.3.0/V2.Rule.BoostAction)\n- [2.2.1](/php/docs/reference/cloud-retail/2.2.1/V2.Rule.BoostAction)\n- [2.1.3](/php/docs/reference/cloud-retail/2.1.3/V2.Rule.BoostAction)\n- [2.0.0](/php/docs/reference/cloud-retail/2.0.0/V2.Rule.BoostAction)\n- [1.7.0](/php/docs/reference/cloud-retail/1.7.0/V2.Rule.BoostAction)\n- [1.6.4](/php/docs/reference/cloud-retail/1.6.4/V2.Rule.BoostAction)\n- [1.5.0](/php/docs/reference/cloud-retail/1.5.0/V2.Rule.BoostAction)\n- [1.4.2](/php/docs/reference/cloud-retail/1.4.2/V2.Rule.BoostAction)\n- [1.3.1](/php/docs/reference/cloud-retail/1.3.1/V2.Rule.BoostAction)\n- [1.2.1](/php/docs/reference/cloud-retail/1.2.1/V2.Rule.BoostAction)\n- [1.1.1](/php/docs/reference/cloud-retail/1.1.1/V2.Rule.BoostAction)\n- [1.0.1](/php/docs/reference/cloud-retail/1.0.1/V2.Rule.BoostAction) \nReference documentation and code samples for the Google Cloud Retail V2 Client class BoostAction.\n\nA boost action to apply to results matching condition specified above.\n\nGenerated from protobuf message `google.cloud.retail.v2.Rule.BoostAction`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Retail \\\\ V2 \\\\ Rule\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBoost\n\nStrength of the condition boost, which must be in \\[-1, 1\\]. Negative\nboost means demotion. Default is 0.0.\n\nSetting to 1.0 gives the item a big promotion. However, it does not\nnecessarily mean that the boosted item will be the top result at all\ntimes, nor that other items will be excluded. Results could still be\nshown even when none of them matches the condition. And results that\nare significantly more relevant to the search query can still trump\nyour heavily favored but irrelevant items.\nSetting to -1.0 gives the item a big demotion. However, results that\nare deeply relevant might still be shown. The item will have an\nupstream battle to get a fairly high ranking, but it is not blocked out\ncompletely.\nSetting to 0.0 means no boost applied. The boosting condition is\nignored.\n\n### setBoost\n\nStrength of the condition boost, which must be in \\[-1, 1\\]. Negative\nboost means demotion. Default is 0.0.\n\nSetting to 1.0 gives the item a big promotion. However, it does not\nnecessarily mean that the boosted item will be the top result at all\ntimes, nor that other items will be excluded. Results could still be\nshown even when none of them matches the condition. And results that\nare significantly more relevant to the search query can still trump\nyour heavily favored but irrelevant items.\nSetting to -1.0 gives the item a big demotion. However, results that\nare deeply relevant might still be shown. The item will have an\nupstream battle to get a fairly high ranking, but it is not blocked out\ncompletely.\nSetting to 0.0 means no boost applied. The boosting condition is\nignored.\n\n### getProductsFilter\n\nThe filter can have a max size of 5000 characters.\n\nAn expression which specifies which products to apply an action to.\nThe syntax and supported fields are the same as a filter expression. See\n[SearchRequest.filter](/php/docs/reference/cloud-retail/latest/V2.SearchRequest#_Google_Cloud_Retail_V2_SearchRequest__getFilter__) for\ndetail syntax and limitations.\nExamples:\n\n- To boost products with product ID \"product_1\" or \"product_2\", and color \"Red\" or \"Blue\": \n *(id: ANY(\"product_1\", \"product_2\"))* *AND* *(colorFamilies: ANY(\"Red\", \"Blue\"))*\n\n### setProductsFilter\n\nThe filter can have a max size of 5000 characters.\n\nAn expression which specifies which products to apply an action to.\nThe syntax and supported fields are the same as a filter expression. See\n[SearchRequest.filter](/php/docs/reference/cloud-retail/latest/V2.SearchRequest#_Google_Cloud_Retail_V2_SearchRequest__getFilter__) for\ndetail syntax and limitations.\nExamples:\n\n- To boost products with product ID \"product_1\" or \"product_2\", and color \"Red\" or \"Blue\": \n *(id: ANY(\"product_1\", \"product_2\"))* *AND* *(colorFamilies: ANY(\"Red\", \"Blue\"))*"]]
