SearchInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)Detailed search information.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
search_query |
str
The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT
error is returned.
At least one of
search_query
or
PageInfo.page_category
is required for search events. Other event types should
not set this field. Otherwise, an INVALID_ARGUMENT error
is returned.
|
order_by |
str
The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT
error is returned.
This can only be set for search events. Other event
types should not set this field. Otherwise, an
INVALID_ARGUMENT error is returned.
|
offset |
int
An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for definition. If this field is negative, an INVALID_ARGUMENT is
returned.
This can only be set for search events. Other event
types should not set this field. Otherwise, an
INVALID_ARGUMENT error is returned.
This field is a member of oneof_ _offset.
|