Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class SearchInfo.
Detailed search information.
Generated from protobuf message google.cloud.discoveryengine.v1.SearchInfo
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ search_query | stringThe 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 |
↳ order_by | stringThe 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 |
↳ offset | intAn 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 |
getSearchQuery
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.
| Returns | |
|---|---|
| Type | Description |
string | |
setSearchQuery
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.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
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.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
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.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getOffset
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.
| Returns | |
|---|---|
| Type | Description |
int | |
hasOffset
clearOffset
setOffset
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.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |