Google Cloud Retail V2 Client - Class Rule (2.5.1)

Version latest

• 2.5.1 (latest)
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.1
• 2.1.3
• 2.0.0
• 1.7.0
• 1.6.4
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.1
• 1.1.1
• 1.0.1

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

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ boost_action	Rule\BoostAction A boost action.
↳ redirect_action	Rule\RedirectAction Redirects a shopper to a specific page.
↳ oneway_synonyms_action	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	Rule\DoNotAssociateAction Prevents term from being associated with other terms.
↳ replacement_action	Rule\ReplacementAction Replaces specific terms in the query.
↳ ignore_action	Rule\IgnoreAction Ignores specific terms from query during search.
↳ filter_action	Rule\FilterAction Filters results.
↳ twoway_synonyms_action	Rule\TwowaySynonymsAction Treats a set of terms as synonyms of one another.
↳ force_return_facet_action	Rule\ForceReturnFacetAction Force returns an attribute as a facet in the request.
↳ remove_facet_action	Rule\RemoveFacetAction Remove an attribute as a facet in the request (if present).
↳ pin_action	Rule\PinAction Pins one or more specified products to a specific position in the results.
↳ condition	Condition Required. The condition that triggers the rule. If the condition is empty, the rule will always apply.

getBoostAction

A boost action.

Returns
Type	Description
Rule\BoostAction|null

hasBoostAction

setBoostAction

A boost action.

Parameter
Name	Description
var	Rule\BoostAction

Returns
Type	Description
$this

getRedirectAction

Redirects a shopper to a specific page.

Returns
Type	Description
Rule\RedirectAction|null

hasRedirectAction

setRedirectAction

Redirects a shopper to a specific page.

Parameter
Name	Description
var	Rule\RedirectAction

Returns
Type	Description
$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.

Returns
Type	Description
Rule\OnewaySynonymsAction|null

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.

Parameter
Name	Description
var	Rule\OnewaySynonymsAction

Returns
Type	Description
$this

getDoNotAssociateAction

Prevents term from being associated with other terms.

Returns
Type	Description
Rule\DoNotAssociateAction|null

hasDoNotAssociateAction

setDoNotAssociateAction

Prevents term from being associated with other terms.

Parameter
Name	Description
var	Rule\DoNotAssociateAction

Returns
Type	Description
$this

getReplacementAction

Replaces specific terms in the query.

Returns
Type	Description
Rule\ReplacementAction|null

hasReplacementAction

setReplacementAction

Replaces specific terms in the query.

Parameter
Name	Description
var	Rule\ReplacementAction

Returns
Type	Description
$this

getIgnoreAction

Ignores specific terms from query during search.

Returns
Type	Description
Rule\IgnoreAction|null

hasIgnoreAction

setIgnoreAction

Ignores specific terms from query during search.

Parameter
Name	Description
var	Rule\IgnoreAction

Returns
Type	Description
$this

getFilterAction

Filters results.

Returns
Type	Description
Rule\FilterAction|null

hasFilterAction

setFilterAction

Filters results.

Parameter
Name	Description
var	Rule\FilterAction

Returns
Type	Description
$this

getTwowaySynonymsAction

Treats a set of terms as synonyms of one another.

Returns
Type	Description
Rule\TwowaySynonymsAction|null

hasTwowaySynonymsAction

setTwowaySynonymsAction

Treats a set of terms as synonyms of one another.

Parameter
Name	Description
var	Rule\TwowaySynonymsAction

Returns
Type	Description
$this

getForceReturnFacetAction

Force returns an attribute as a facet in the request.

Returns
Type	Description
Rule\ForceReturnFacetAction|null

hasForceReturnFacetAction

setForceReturnFacetAction

Force returns an attribute as a facet in the request.

Parameter
Name	Description
var	Rule\ForceReturnFacetAction

Returns
Type	Description
$this

getRemoveFacetAction

Remove an attribute as a facet in the request (if present).

Returns
Type	Description
Rule\RemoveFacetAction|null

hasRemoveFacetAction

setRemoveFacetAction

Remove an attribute as a facet in the request (if present).

Parameter
Name	Description
var	Rule\RemoveFacetAction

Returns
Type	Description
$this

getPinAction

Pins one or more specified products to a specific position in the results.

Returns
Type	Description
Rule\PinAction|null

hasPinAction

setPinAction

Pins one or more specified products to a specific position in the results.

Parameter
Name	Description
var	Rule\PinAction

Returns
Type	Description
$this

getCondition

Required. The condition that triggers the rule.

If the condition is empty, the rule will always apply.

Returns
Type	Description
Condition|null

hasCondition

clearCondition

setCondition

Required. The condition that triggers the rule.

If the condition is empty, the rule will always apply.

Parameter
Name	Description
var	Condition

Returns
Type	Description
$this

getAction

Returns
Type	Description
string