Reference documentation and code samples for the Google Cloud Retail V2 Client class Rule.
A rule is a condition-action pair
-
A condition defines when a rule is to be triggered.
-
An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH .
Generated from protobuf message google.cloud.retail.v2.Rule
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ boost_action
↳ redirect_action
↳ oneway_synonyms_action
Google\Cloud\Retail\V2\Rule\OnewaySynonymsAction
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
↳ do_not_associate_action
Google\Cloud\Retail\V2\Rule\DoNotAssociateAction
Prevents term from being associated with other terms.
↳ replacement_action
↳ ignore_action
↳ filter_action
↳ twoway_synonyms_action
↳ condition
Google\Cloud\Retail\V2\Condition
Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.
getBoostAction
A boost action.
Generated from protobuf field .google.cloud.retail.v2.Rule.BoostAction boost_action = 2;
hasBoostAction
setBoostAction
A boost action.
Generated from protobuf field .google.cloud.retail.v2.Rule.BoostAction boost_action = 2;
$this
getRedirectAction
Redirects a shopper to a specific page.
Generated from protobuf field .google.cloud.retail.v2.Rule.RedirectAction redirect_action = 3;
hasRedirectAction
setRedirectAction
Redirects a shopper to a specific page.
Generated from protobuf field .google.cloud.retail.v2.Rule.RedirectAction redirect_action = 3;
$this
getOnewaySynonymsAction
Treats specific term as a synonym with a group of terms.
Group of terms will not be treated as synonyms with the specific term.
Generated from protobuf field .google.cloud.retail.v2.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;
hasOnewaySynonymsAction
setOnewaySynonymsAction
Treats specific term as a synonym with a group of terms.
Group of terms will not be treated as synonyms with the specific term.
Generated from protobuf field .google.cloud.retail.v2.Rule.OnewaySynonymsAction oneway_synonyms_action = 6;
$this
getDoNotAssociateAction
Prevents term from being associated with other terms.
Generated from protobuf field .google.cloud.retail.v2.Rule.DoNotAssociateAction do_not_associate_action = 7;
hasDoNotAssociateAction
setDoNotAssociateAction
Prevents term from being associated with other terms.
Generated from protobuf field .google.cloud.retail.v2.Rule.DoNotAssociateAction do_not_associate_action = 7;
$this
getReplacementAction
Replaces specific terms in the query.
Generated from protobuf field .google.cloud.retail.v2.Rule.ReplacementAction replacement_action = 8;
hasReplacementAction
setReplacementAction
Replaces specific terms in the query.
Generated from protobuf field .google.cloud.retail.v2.Rule.ReplacementAction replacement_action = 8;
$this
getIgnoreAction
Ignores specific terms from query during search.
Generated from protobuf field .google.cloud.retail.v2.Rule.IgnoreAction ignore_action = 9;
hasIgnoreAction
setIgnoreAction
Ignores specific terms from query during search.
Generated from protobuf field .google.cloud.retail.v2.Rule.IgnoreAction ignore_action = 9;
$this
getFilterAction
Filters results.
Generated from protobuf field .google.cloud.retail.v2.Rule.FilterAction filter_action = 10;
hasFilterAction
setFilterAction
Filters results.
Generated from protobuf field .google.cloud.retail.v2.Rule.FilterAction filter_action = 10;
$this
getTwowaySynonymsAction
Treats a set of terms as synonyms of one another.
Generated from protobuf field .google.cloud.retail.v2.Rule.TwowaySynonymsAction twoway_synonyms_action = 11;
hasTwowaySynonymsAction
setTwowaySynonymsAction
Treats a set of terms as synonyms of one another.
Generated from protobuf field .google.cloud.retail.v2.Rule.TwowaySynonymsAction twoway_synonyms_action = 11;
$this
getCondition
Required. The condition that triggers the rule.
If the condition is empty, the rule will always apply.
Generated from protobuf field .google.cloud.retail.v2.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];
hasCondition
clearCondition
setCondition
Required. The condition that triggers the rule.
If the condition is empty, the rule will always apply.
Generated from protobuf field .google.cloud.retail.v2.Condition condition = 1 [(.google.api.field_behavior) = REQUIRED];
$this
getAction
string
