Class ProjectsResource.LocationsResource.CatalogsResource.CompleteQueryRequest

Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudRetailV2CompleteQueryResponse>
CloudRetailBaseServiceRequest<GoogleCloudRetailV2CompleteQueryResponse>
ProjectsResource.LocationsResource.CatalogsResource.CompleteQueryRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudRetail.v2
Assembly: Google.Apis.CloudRetail.v2.dll
Syntax
public class ProjectsResource.LocationsResource.CatalogsResource.CompleteQueryRequest : CloudRetailBaseServiceRequest<GoogleCloudRetailV2CompleteQueryResponse>, IClientServiceRequest<GoogleCloudRetailV2CompleteQueryResponse>, IClientServiceRequest

Constructors

CompleteQueryRequest(IClientService, string)

Constructs a new CompleteQuery request.

Declaration
public CompleteQueryRequest(IClientService service, string catalog)
Parameters
Type Name Description
IClientService service
string catalog

Properties

Catalog

Required. Catalog for which the completion is performed. Full resource name of catalog, such as projects/*/locations/global/catalogs/default_catalog.

Declaration
[RequestParameter("catalog", RequestParameterType.Path)]
public virtual string Catalog { get; }
Property Value
Type Description
string

Dataset

Determines which dataset to use for fetching completion. "user-data" will use the dataset imported through CompletionService.ImportCompletionData. cloud-retail will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the user-data dataset. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See guidelines.

Declaration
[RequestParameter("dataset", RequestParameterType.Query)]
public virtual string Dataset { get; set; }
Property Value
Type Description
string

DeviceType

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.

Declaration
[RequestParameter("deviceType", RequestParameterType.Query)]
public virtual string DeviceType { get; set; }
Property Value
Type Description
string

EnableAttributeSuggestions

If true, attribute suggestions are enabled and provided in the response. This field is only available for the cloud-retail dataset.

Declaration
[RequestParameter("enableAttributeSuggestions", RequestParameterType.Query)]
public virtual bool? EnableAttributeSuggestions { get; set; }
Property Value
Type Description
bool?

Entity

The entity for customers who run multiple entities, domains, sites, or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. This field will be applied to completion_results only. It has no effect on the attribute_results. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters.

Declaration
[RequestParameter("entity", RequestParameterType.Query)]
public virtual string Entity { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

LanguageCodes

Note that this field applies for user-data dataset only. For requests with cloud-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.

Declaration
[RequestParameter("languageCodes", RequestParameterType.Query)]
public virtual Repeatable<string> LanguageCodes { get; set; }
Property Value
Type Description
Repeatable<string>

MaxSuggestions

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.

Declaration
[RequestParameter("maxSuggestions", RequestParameterType.Query)]
public virtual int? MaxSuggestions { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Query

Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

VisitorId

Recommended 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.

Declaration
[RequestParameter("visitorId", RequestParameterType.Query)]
public virtual string VisitorId { get; set; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes CompleteQuery parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements