Reference documentation and code samples for the Google Cloud Retail V2 Client class FilterAction.
Rule Condition:
- No Condition.query_terms provided is a global match.
1 or more Condition.query_terms provided are combined with OR operator.
- Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.
- Action Result: Filters the returned objects to be ONLY those that passed the filter.
Generated from protobuf message google.cloud.retail.v2.Rule.FilterAction
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ filter |
string
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. See more details at the Retail Search user guide. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": |
getFilter
A filter to apply on the matching condition results. Supported features:
filter must be set.
Filter syntax is identical to SearchRequest.filter. See more details at the Retail Search user guide.
- To filter 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 | |
setFilter
A filter to apply on the matching condition results. Supported features:
filter must be set.
Filter syntax is identical to SearchRequest.filter. See more details at the Retail Search user guide.
- To filter 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"))
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |