Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::CompleteQueryRequest.
Autocomplete parameters.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#catalog
def catalog() -> ::String
-
(::String) — Required. Catalog for which the completion is performed.
Full resource name of catalog, such as
projects/*/locations/global/catalogs/default_catalog
.
#catalog=
def catalog=(value) -> ::String
-
value (::String) — Required. Catalog for which the completion is performed.
Full resource name of catalog, such as
projects/*/locations/global/catalogs/default_catalog
.
-
(::String) — Required. Catalog for which the completion is performed.
Full resource name of catalog, such as
projects/*/locations/global/catalogs/default_catalog
.
#dataset
def dataset() -> ::String
-
(::String) —
Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data".
Current supported values:
user-data
cloud-retail: This option requires enabling auto-learning function first. See guidelines.
#dataset=
def dataset=(value) -> ::String
-
value (::String) —
Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data".
Current supported values:
user-data
cloud-retail: This option requires enabling auto-learning function first. See guidelines.
-
(::String) —
Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data".
Current supported values:
user-data
cloud-retail: This option requires enabling auto-learning function first. See guidelines.
#device_type
def device_type() -> ::String
-
(::String) —
The device type context for completion suggestions. We recommend that you leave this field empty.
It can apply different suggestions on different device types, e.g.
DESKTOP
,MOBILE
. If it is empty, the suggestions are across all device types.Supported formats:
UNKNOWN_DEVICE_TYPE
DESKTOP
MOBILE
A customized string starts with
OTHER_
, e.g.OTHER_IPHONE
.
#device_type=
def device_type=(value) -> ::String
-
value (::String) —
The device type context for completion suggestions. We recommend that you leave this field empty.
It can apply different suggestions on different device types, e.g.
DESKTOP
,MOBILE
. If it is empty, the suggestions are across all device types.Supported formats:
UNKNOWN_DEVICE_TYPE
DESKTOP
MOBILE
A customized string starts with
OTHER_
, e.g.OTHER_IPHONE
.
-
(::String) —
The device type context for completion suggestions. We recommend that you leave this field empty.
It can apply different suggestions on different device types, e.g.
DESKTOP
,MOBILE
. If it is empty, the suggestions are across all device types.Supported formats:
UNKNOWN_DEVICE_TYPE
DESKTOP
MOBILE
A customized string starts with
OTHER_
, e.g.OTHER_IPHONE
.
#entity
def entity() -> ::String
-
(::String) — The entity for customers that may run multiple different entities, domains,
sites or regions, for example,
Google US
,Google Ads
,Waymo
,google.com
,youtube.com
, etc. If this is set, it should be exactly matched with UserEvent.entity to get per-entity autocomplete results.
#entity=
def entity=(value) -> ::String
-
value (::String) — The entity for customers that may run multiple different entities, domains,
sites or regions, for example,
Google US
,Google Ads
,Waymo
,google.com
,youtube.com
, etc. If this is set, it should be exactly matched with UserEvent.entity to get per-entity autocomplete results.
-
(::String) — The entity for customers that may run multiple different entities, domains,
sites or regions, for example,
Google US
,Google Ads
,Waymo
,google.com
,youtube.com
, etc. If this is set, it should be exactly matched with UserEvent.entity to get per-entity autocomplete results.
#language_codes
def language_codes() -> ::Array<::String>
-
(::Array<::String>) — Note that this field applies for
user-data
dataset only. For requests withcloud-retail
dataset, setting this field has no effect.The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.
#language_codes=
def language_codes=(value) -> ::Array<::String>
-
value (::Array<::String>) — Note that this field applies for
user-data
dataset only. For requests withcloud-retail
dataset, setting this field has no effect.The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.
-
(::Array<::String>) — Note that this field applies for
user-data
dataset only. For requests withcloud-retail
dataset, setting this field has no effect.The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.
#max_suggestions
def max_suggestions() -> ::Integer
-
(::Integer) — Completion max suggestions. If left unset or set to 0, then will fallback
to the configured value
CompletionConfig.max_suggestions.
The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.
#max_suggestions=
def max_suggestions=(value) -> ::Integer
-
value (::Integer) — Completion max suggestions. If left unset or set to 0, then will fallback
to the configured value
CompletionConfig.max_suggestions.
The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.
-
(::Integer) — Completion max suggestions. If left unset or set to 0, then will fallback
to the configured value
CompletionConfig.max_suggestions.
The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.
#query
def query() -> ::String
-
(::String) — Required. The query used to generate suggestions.
The maximum number of allowed characters is 255.
#query=
def query=(value) -> ::String
-
value (::String) — Required. The query used to generate suggestions.
The maximum number of allowed characters is 255.
-
(::String) — Required. The query used to generate suggestions.
The maximum number of allowed characters is 255.
#visitor_id
def visitor_id() -> ::String
-
(::String) — Required field. A unique identifier for tracking visitors. For example,
this could be implemented with an HTTP cookie, which should be able to
uniquely identify a visitor on a single device. This unique identifier
should not change if the visitor logs in or out of the website.
The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
#visitor_id=
def visitor_id=(value) -> ::String
-
value (::String) — Required field. A unique identifier for tracking visitors. For example,
this could be implemented with an HTTP cookie, which should be able to
uniquely identify a visitor on a single device. This unique identifier
should not change if the visitor logs in or out of the website.
The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
-
(::String) — Required field. A unique identifier for tracking visitors. For example,
this could be implemented with an HTTP cookie, which should be able to
uniquely identify a visitor on a single device. This unique identifier
should not change if the visitor logs in or out of the website.
The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.