Class Condition (1.21.2)

Condition(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attributes

Name Description
query_terms MutableSequence[google.cloud.retail_v2.types.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).
active_time_range MutableSequence[google.cloud.retail_v2.types.Condition.TimeRange]
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
page_categories MutableSequence[str]
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;

Classes

QueryTerm

QueryTerm(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Query terms that we want to match on.

TimeRange

TimeRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Used for time-dependent conditions. Example: Want to have rule applied for week long sale.