Retail V2 API - Class Google::Cloud::Retail::V2::Condition (v1.1.0)

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

Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#active_time_range

def active_time_range() -> ::Array<::Google::Cloud::Retail::V2::Condition::TimeRange>
Returns

#active_time_range=

def active_time_range=(value) -> ::Array<::Google::Cloud::Retail::V2::Condition::TimeRange>
Parameter
Returns

#page_categories

def page_categories() -> ::Array<::String>
Returns
  • (::Array<::String>) — Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

#page_categories=

def page_categories=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
Returns
  • (::Array<::String>) — Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

#query_terms

def query_terms() -> ::Array<::Google::Cloud::Retail::V2::Condition::QueryTerm>
Returns
  • (::Array<::Google::Cloud::Retail::V2::Condition::QueryTerm>) — A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

#query_terms=

def query_terms=(value) -> ::Array<::Google::Cloud::Retail::V2::Condition::QueryTerm>
Parameter
  • value (::Array<::Google::Cloud::Retail::V2::Condition::QueryTerm>) — A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
Returns
  • (::Array<::Google::Cloud::Retail::V2::Condition::QueryTerm>) — A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).