Retail V2 API - Class Google::Cloud::Retail::V2::Rule::FilterAction (v0.20.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::Rule::FilterAction.

  • Rule Condition:
  • 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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::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":
      (id: ANY("product_1", "product_2"))
      AND
      (colorFamilies: ANY("Red", "Blue"))

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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":
      (id: ANY("product_1", "product_2"))
      AND
      (colorFamilies: ANY("Red", "Blue"))
Returns
  • (::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":
      (id: ANY("product_1", "product_2"))
      AND
      (colorFamilies: ANY("Red", "Blue"))