Movatterモバイル変換


[0]ホーム

URL:


retail

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package retail provides access to the Vertex AI Search for commerce API.

For product documentation, see:https://cloud.google.com/recommendations

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/retail/v2alpha"...ctx := context.Background()retailService, err := retail.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

retailService, err := retail.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)retailService, err := retail.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeGoogleApiHttpBody

type GoogleApiHttpBody struct {// ContentType: The HTTP Content-Type header value specifying the content type// of the body.ContentTypestring `json:"contentType,omitempty"`// Data: The HTTP request/response body as raw binary.Datastring `json:"data,omitempty"`// Extensions: Application specific response metadata. Must be set in the first// response for streaming APIs.Extensions []googleapi.RawMessage `json:"extensions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ContentType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ContentType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleApiHttpBody: Message that represents an arbitrary HTTP body. It shouldonly be used for payload formats that can't be represented as JSON, such asraw binary or an HTML page. This message can be used both in streaming andnon-streaming API methods in the request as well as the response. It can beused as a top-level request field, which is convenient if one wants toextract parameters from either the URL or HTTP template into the requestfields and also want access to the raw HTTP body. Example: messageGetResourceRequest { // A unique request id. string request_id = 1; // Theraw HTTP body is bound to this field. google.api.HttpBody http_body = 2; }service ResourceService { rpc GetResource(GetResourceRequest) returns(google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns(google.protobuf.Empty); } Example with streaming methods: serviceCaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (streamgoogle.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns(stream google.api.HttpBody); } Use of this type only changes how therequest and response bodies are handled, all other features will continue towork unchanged.

func (GoogleApiHttpBody)MarshalJSON

func (sGoogleApiHttpBody) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailLoggingErrorContext

type GoogleCloudRetailLoggingErrorContext struct {// HttpRequest: The HTTP request which was processed when the error was// triggered.HttpRequest *GoogleCloudRetailLoggingHttpRequestContext `json:"httpRequest,omitempty"`// ReportLocation: The location in the source code where the decision was made// to report the error, usually the place where it was logged.ReportLocation *GoogleCloudRetailLoggingSourceLocation `json:"reportLocation,omitempty"`// ForceSendFields is a list of field names (e.g. "HttpRequest") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HttpRequest") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailLoggingErrorContext: A description of the context in whichan error occurred.

func (GoogleCloudRetailLoggingErrorContext)MarshalJSON

typeGoogleCloudRetailLoggingErrorLog

type GoogleCloudRetailLoggingErrorLog struct {// Context: A description of the context in which the error occurred.Context *GoogleCloudRetailLoggingErrorContext `json:"context,omitempty"`// ImportPayload: The error payload that is populated on LRO import APIs.ImportPayload *GoogleCloudRetailLoggingImportErrorContext `json:"importPayload,omitempty"`// Message: A message describing the error.Messagestring `json:"message,omitempty"`// RequestPayload: The API request payload, represented as a protocol buffer.// Most API request types are supported. For example:// "type.googleapis.com/google.cloud.retail.v2.ProductService.CreateProductReque// st"// "type.googleapis.com/google.cloud.retail.v2.UserEventService.WriteUserEventRe// quest"RequestPayloadgoogleapi.RawMessage `json:"requestPayload,omitempty"`// ResponsePayload: The API response payload, represented as a protocol buffer.// This is used to log some "soft errors", where the response is valid but we// consider there are some quality issues like unjoined events. The following// API responses are supported and no PII is included:// "google.cloud.retail.v2.PredictionService.Predict"// "google.cloud.retail.v2.UserEventService.WriteUserEvent"// "google.cloud.retail.v2.UserEventService.CollectUserEvent"ResponsePayloadgoogleapi.RawMessage `json:"responsePayload,omitempty"`// ServiceContext: The service context in which this error has occurred.ServiceContext *GoogleCloudRetailLoggingServiceContext `json:"serviceContext,omitempty"`// Status: The RPC status associated with the error log.Status *GoogleRpcStatus `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "Context") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Context") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailLoggingErrorLog: An error log which is reported to theError Reporting system. This proto a superset ofgoogle.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent.

func (GoogleCloudRetailLoggingErrorLog)MarshalJSON

func (sGoogleCloudRetailLoggingErrorLog) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailLoggingHttpRequestContext

type GoogleCloudRetailLoggingHttpRequestContext struct {// ResponseStatusCode: The HTTP response status code for the request.ResponseStatusCodeint64 `json:"responseStatusCode,omitempty"`// ForceSendFields is a list of field names (e.g. "ResponseStatusCode") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ResponseStatusCode") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailLoggingHttpRequestContext: HTTP request data that isrelated to a reported error.

func (GoogleCloudRetailLoggingHttpRequestContext)MarshalJSON

typeGoogleCloudRetailLoggingImportErrorContext

type GoogleCloudRetailLoggingImportErrorContext struct {// CatalogItem: The detailed content which caused the error on importing a// catalog item.CatalogItemstring `json:"catalogItem,omitempty"`// GcsPath: Cloud Storage file path of the import source. Can be set for batch// operation error.GcsPathstring `json:"gcsPath,omitempty"`// LineNumber: Line number of the content in file. Should be empty for// permission or batch operation error.LineNumberstring `json:"lineNumber,omitempty"`// OperationName: The operation resource name of the LRO.OperationNamestring `json:"operationName,omitempty"`// Product: The detailed content which caused the error on importing a product.Productstring `json:"product,omitempty"`// UserEvent: The detailed content which caused the error on importing a user// event.UserEventstring `json:"userEvent,omitempty"`// ForceSendFields is a list of field names (e.g. "CatalogItem") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CatalogItem") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailLoggingImportErrorContext: The error payload that ispopulated on LRO import APIs, including"google.cloud.retail.v2.ProductService.ImportProducts" and"google.cloud.retail.v2.EventService.ImportUserEvents".

func (GoogleCloudRetailLoggingImportErrorContext)MarshalJSON

typeGoogleCloudRetailLoggingServiceContext

type GoogleCloudRetailLoggingServiceContext struct {// Service: An identifier of the service. For example, "retail.googleapis.com".Servicestring `json:"service,omitempty"`// ForceSendFields is a list of field names (e.g. "Service") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Service") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailLoggingServiceContext: Describes a running service thatsends errors.

func (GoogleCloudRetailLoggingServiceContext)MarshalJSON

typeGoogleCloudRetailLoggingSourceLocation

type GoogleCloudRetailLoggingSourceLocation struct {// FunctionName: Human-readable name of a function or method. For example,// "google.cloud.retail.v2.UserEventService.ImportUserEvents".FunctionNamestring `json:"functionName,omitempty"`// ForceSendFields is a list of field names (e.g. "FunctionName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FunctionName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailLoggingSourceLocation: Indicates a location in the sourcecode of the service for which errors are reported.

func (GoogleCloudRetailLoggingSourceLocation)MarshalJSON

typeGoogleCloudRetailV2AddFulfillmentPlacesMetadataadded inv0.52.0

type GoogleCloudRetailV2AddFulfillmentPlacesMetadata struct {}

GoogleCloudRetailV2AddFulfillmentPlacesMetadata: Metadata related to theprogress of the AddFulfillmentPlaces operation. Currently empty becausethere is no meaningful metadata populated from theProductService.AddFulfillmentPlaces method.

typeGoogleCloudRetailV2AddFulfillmentPlacesResponseadded inv0.52.0

type GoogleCloudRetailV2AddFulfillmentPlacesResponse struct {}

GoogleCloudRetailV2AddFulfillmentPlacesResponse: Response of theAddFulfillmentPlacesRequest. Currently empty because there is no meaningfulresponse populated from the ProductService.AddFulfillmentPlaces method.

typeGoogleCloudRetailV2AddLocalInventoriesMetadataadded inv0.75.0

type GoogleCloudRetailV2AddLocalInventoriesMetadata struct {}

GoogleCloudRetailV2AddLocalInventoriesMetadata: Metadata related to theprogress of the AddLocalInventories operation. Currently empty because thereis no meaningful metadata populated from theProductService.AddLocalInventories method.

typeGoogleCloudRetailV2AddLocalInventoriesResponseadded inv0.75.0

type GoogleCloudRetailV2AddLocalInventoriesResponse struct {}

GoogleCloudRetailV2AddLocalInventoriesResponse: Response of theProductService.AddLocalInventories API. Currently empty because there is nomeaningful response populated from the ProductService.AddLocalInventoriesmethod.

typeGoogleCloudRetailV2BigQueryOutputResultadded inv0.163.0

type GoogleCloudRetailV2BigQueryOutputResult struct {// DatasetId: The ID of a BigQuery Dataset.DatasetIdstring `json:"datasetId,omitempty"`// TableId: The ID of a BigQuery Table.TableIdstring `json:"tableId,omitempty"`// ForceSendFields is a list of field names (e.g. "DatasetId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DatasetId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2BigQueryOutputResult: A BigQuery output result.

func (GoogleCloudRetailV2BigQueryOutputResult)MarshalJSONadded inv0.163.0

typeGoogleCloudRetailV2CreateModelMetadataadded inv0.109.0

type GoogleCloudRetailV2CreateModelMetadata struct {// Model: The resource name of the model that this create applies to. Format:// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/mode// ls/{model_id}`Modelstring `json:"model,omitempty"`// ForceSendFields is a list of field names (e.g. "Model") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Model") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2CreateModelMetadata: Metadata associated with a createoperation.

func (GoogleCloudRetailV2CreateModelMetadata)MarshalJSONadded inv0.109.0

typeGoogleCloudRetailV2ExportAnalyticsMetricsResponseadded inv0.163.0

type GoogleCloudRetailV2ExportAnalyticsMetricsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: This field is never set.ErrorsConfig *GoogleCloudRetailV2ExportErrorsConfig `json:"errorsConfig,omitempty"`// OutputResult: Output result indicating where the data were exported to.OutputResult *GoogleCloudRetailV2OutputResult `json:"outputResult,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ExportAnalyticsMetricsResponse: Response of theExportAnalyticsMetricsRequest. If the long running operation was successful,then this message is returned by the google.longrunning.Operations.responsefield if the operation was successful.

func (GoogleCloudRetailV2ExportAnalyticsMetricsResponse)MarshalJSONadded inv0.163.0

typeGoogleCloudRetailV2ExportErrorsConfigadded inv0.163.0

type GoogleCloudRetailV2ExportErrorsConfig struct {// GcsPrefix: Google Cloud Storage path for import errors. This must be an// empty, existing Cloud Storage bucket. Export errors will be written to a// file in this bucket, one per line, as a JSON-encoded `google.rpc.Status`// message.GcsPrefixstring `json:"gcsPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsPrefix") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ExportErrorsConfig: Configuration of destination forExport related errors.

func (GoogleCloudRetailV2ExportErrorsConfig)MarshalJSONadded inv0.163.0

typeGoogleCloudRetailV2ExportMetadataadded inv0.166.0

type GoogleCloudRetailV2ExportMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// UpdateTime: Operation last update time. If the operation is done, this is// also the finish time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ExportMetadata: Metadata related to the progress of theExport operation. This is returned by thegoogle.longrunning.Operation.metadata field.

func (GoogleCloudRetailV2ExportMetadata)MarshalJSONadded inv0.166.0

func (sGoogleCloudRetailV2ExportMetadata) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2GcsOutputResultadded inv0.163.0

type GoogleCloudRetailV2GcsOutputResult struct {// OutputUri: The uri of Gcs outputOutputUristring `json:"outputUri,omitempty"`// ForceSendFields is a list of field names (e.g. "OutputUri") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "OutputUri") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2GcsOutputResult: A Gcs output result.

func (GoogleCloudRetailV2GcsOutputResult)MarshalJSONadded inv0.163.0

typeGoogleCloudRetailV2ImportCompletionDataResponseadded inv0.52.0

type GoogleCloudRetailV2ImportCompletionDataResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ImportCompletionDataResponse: Response of theImportCompletionDataRequest. If the long running operation is done, thismessage is returned by the google.longrunning.Operations.response field ifthe operation is successful.

func (GoogleCloudRetailV2ImportCompletionDataResponse)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2ImportErrorsConfig

type GoogleCloudRetailV2ImportErrorsConfig struct {// GcsPrefix: Google Cloud Storage prefix for import errors. This must be an// empty, existing Cloud Storage directory. Import errors are written to// sharded files in this directory, one per line, as a JSON-encoded// `google.rpc.Status` message.GcsPrefixstring `json:"gcsPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsPrefix") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ImportErrorsConfig: Configuration of destination forImport related errors.

func (GoogleCloudRetailV2ImportErrorsConfig)MarshalJSON

typeGoogleCloudRetailV2ImportMetadata

type GoogleCloudRetailV2ImportMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// FailureCount: Count of entries that encountered errors while processing.FailureCountint64 `json:"failureCount,omitempty,string"`// NotificationPubsubTopic: Pub/Sub topic for receiving notification. If this// field is set, when the import is finished, a notification is sent to// specified Pub/Sub topic. The message data is JSON string of a Operation.// Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.NotificationPubsubTopicstring `json:"notificationPubsubTopic,omitempty"`// RequestId: Deprecated. This field is never set.RequestIdstring `json:"requestId,omitempty"`// SuccessCount: Count of entries that were processed successfully.SuccessCountint64 `json:"successCount,omitempty,string"`// UpdateTime: Operation last update time. If the operation is done, this is// also the finish time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ImportMetadata: Metadata related to the progress of theImport operation. This is returned by thegoogle.longrunning.Operation.metadata field.

func (GoogleCloudRetailV2ImportMetadata)MarshalJSON

func (sGoogleCloudRetailV2ImportMetadata) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2ImportProductsResponse

type GoogleCloudRetailV2ImportProductsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: Echoes the destination for the complete errors in the request// if set.ErrorsConfig *GoogleCloudRetailV2ImportErrorsConfig `json:"errorsConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ImportProductsResponse: Response of theImportProductsRequest. If the long running operation is done, then thismessage is returned by the google.longrunning.Operations.response field ifthe operation was successful.

func (GoogleCloudRetailV2ImportProductsResponse)MarshalJSON

typeGoogleCloudRetailV2ImportUserEventsResponse

type GoogleCloudRetailV2ImportUserEventsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: Echoes the destination for the complete errors if this field// was set in the request.ErrorsConfig *GoogleCloudRetailV2ImportErrorsConfig `json:"errorsConfig,omitempty"`// ImportSummary: Aggregated statistics of user event import status.ImportSummary *GoogleCloudRetailV2UserEventImportSummary `json:"importSummary,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ImportUserEventsResponse: Response of theImportUserEventsRequest. If the long running operation was successful, thenthis message is returned by the google.longrunning.Operations.response fieldif the operation was successful.

func (GoogleCloudRetailV2ImportUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2Modeladded inv0.109.0

type GoogleCloudRetailV2Model struct {// CreateTime: Output only. Timestamp the Recommendation Model was created at.CreateTimestring `json:"createTime,omitempty"`// DataState: Output only. The state of data requirements for this model:// `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the// data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR`// state even if serving state is `ACTIVE`: models were trained successfully// before, but cannot be refreshed because model no longer has sufficient data// for training.//// Possible values://   "DATA_STATE_UNSPECIFIED" - Unspecified default value, should never be// explicitly set.//   "DATA_OK" - The model has sufficient training data.//   "DATA_ERROR" - The model does not have sufficient training data. Error// messages can be queried via Stackdriver.DataStatestring `json:"dataState,omitempty"`// DisplayName: Required. The display name of the model. Should be human// readable, used to display Recommendation Models in the Retail Cloud Console// Dashboard. UTF-8 encoded string with limit of 1024 characters.DisplayNamestring `json:"displayName,omitempty"`// FilteringOption: Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`,// recommendation filtering by attributes is enabled for the model.//// Possible values://   "RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED" - Value used when unset. In// this case, server behavior defaults to RECOMMENDATIONS_FILTERING_DISABLED.//   "RECOMMENDATIONS_FILTERING_DISABLED" - Recommendation filtering is// disabled.//   "RECOMMENDATIONS_FILTERING_ENABLED" - Recommendation filtering is enabled.FilteringOptionstring `json:"filteringOption,omitempty"`// LastTuneTime: Output only. The timestamp when the latest successful tune// finished.LastTuneTimestring `json:"lastTuneTime,omitempty"`// ModelFeaturesConfig: Optional. Additional model features config.ModelFeaturesConfig *GoogleCloudRetailV2ModelModelFeaturesConfig `json:"modelFeaturesConfig,omitempty"`// Name: Required. The fully qualified resource name of the model. Format:// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/mode// ls/{model_id}` catalog_id has char limit of 50. recommendation_model_id has// char limit of 40.Namestring `json:"name,omitempty"`// OptimizationObjective: Optional. The optimization objective e.g. `cvr`.// Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not// specified, we choose default based on model type. Default depends on type of// recommendation: `recommended-for-you` => `ctr` `others-you-may-like` =>// `ctr` `frequently-bought-together` => `revenue_per_order` This field// together with optimization_objective describe model metadata to use to// control model training and serving. See//https://cloud.google.com/retail/docs/models for more details on what the// model metadata control and which combination of parameters are valid. For// invalid combinations of parameters (e.g. type = `frequently-bought-together`// and optimization_objective = `ctr`), you receive an error 400 if you try to// create/update a recommendation with this set of knobs.OptimizationObjectivestring `json:"optimizationObjective,omitempty"`// PeriodicTuningState: Optional. The state of periodic tuning. The period we// use is 3 months - to do a one-off tune earlier use the `TuneModel` method.// Default value is `PERIODIC_TUNING_ENABLED`.//// Possible values://   "PERIODIC_TUNING_STATE_UNSPECIFIED" - Unspecified default value, should// never be explicitly set.//   "PERIODIC_TUNING_DISABLED" - The model has periodic tuning disabled.// Tuning can be reenabled by calling the `EnableModelPeriodicTuning` method or// by calling the `TuneModel` method.//   "ALL_TUNING_DISABLED" - The model cannot be tuned with periodic tuning OR// the `TuneModel` method. Hide the options in customer UI and reject any// requests through the backend self serve API.//   "PERIODIC_TUNING_ENABLED" - The model has periodic tuning enabled. Tuning// can be disabled by calling the `DisableModelPeriodicTuning` method.PeriodicTuningStatestring `json:"periodicTuningState,omitempty"`// ServingConfigLists: Output only. The list of valid serving configs// associated with the PageOptimizationConfig.ServingConfigLists []*GoogleCloudRetailV2ModelServingConfigList `json:"servingConfigLists,omitempty"`// ServingState: Output only. The serving state of the model: `ACTIVE`,// `NOT_ACTIVE`.//// Possible values://   "SERVING_STATE_UNSPECIFIED" - Unspecified serving state.//   "INACTIVE" - The model is not serving.//   "ACTIVE" - The model is serving and can be queried.//   "TUNED" - The model is trained on tuned hyperparameters and can be// queried.ServingStatestring `json:"servingState,omitempty"`// TrainingState: Optional. The training state that the model is in (e.g.// `TRAINING` or `PAUSED`). Since part of the cost of running the service is// frequency of training - this can be used to determine when to train model in// order to control cost. If not specified: the default value for `CreateModel`// method is `TRAINING`. The default value for `UpdateModel` method is to keep// the state the same as before.//// Possible values://   "TRAINING_STATE_UNSPECIFIED" - Unspecified training state.//   "PAUSED" - The model training is paused.//   "TRAINING" - The model is training.TrainingStatestring `json:"trainingState,omitempty"`// TuningOperation: Output only. The tune operation associated with the model.// Can be used to determine if there is an ongoing tune for this// recommendation. Empty field implies no tune is goig on.TuningOperationstring `json:"tuningOperation,omitempty"`// Type: Required. The type of model e.g. `home-page`. Currently supported// values: `recommended-for-you`, `others-you-may-like`,// `frequently-bought-together`, `page-optimization`, `similar-items`,// `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This// field together with optimization_objective describe model metadata to use to// control model training and serving. See//https://cloud.google.com/retail/docs/models for more details on what the// model metadata control and which combination of parameters are valid. For// invalid combinations of parameters (e.g. type = `frequently-bought-together`// and optimization_objective = `ctr`), you receive an error 400 if you try to// create/update a recommendation with this set of knobs.Typestring `json:"type,omitempty"`// UpdateTime: Output only. Timestamp the Recommendation Model was last// updated. E.g. if a Recommendation Model was paused - this would be the time// the pause was initiated.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2Model: Metadata that describes the training and servingparameters of a Model. A Model can be associated with a ServingConfig andthen queried through the Predict API.

func (GoogleCloudRetailV2Model)MarshalJSONadded inv0.109.0

func (sGoogleCloudRetailV2Model) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfigadded inv0.121.0

type GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig struct {// ContextProductsType: Optional. Specifies the context of the model when it is// used in predict requests. Can only be set for the// `frequently-bought-together` type. If it isn't specified, it defaults to// MULTIPLE_CONTEXT_PRODUCTS.//// Possible values://   "CONTEXT_PRODUCTS_TYPE_UNSPECIFIED" - Unspecified default value, should// never be explicitly set. Defaults to MULTIPLE_CONTEXT_PRODUCTS.//   "SINGLE_CONTEXT_PRODUCT" - Use only a single product as context for the// recommendation. Typically used on pages like add-to-cart or product details.//   "MULTIPLE_CONTEXT_PRODUCTS" - Use one or multiple products as context for// the recommendation. Typically used on shopping cart pages.ContextProductsTypestring `json:"contextProductsType,omitempty"`// ForceSendFields is a list of field names (e.g. "ContextProductsType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ContextProductsType") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig: Additionalconfigs for the frequently-bought-together model type.

func (GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig)MarshalJSONadded inv0.121.0

typeGoogleCloudRetailV2ModelModelFeaturesConfigadded inv0.121.0

type GoogleCloudRetailV2ModelModelFeaturesConfig struct {// FrequentlyBoughtTogetherConfig: Additional configs for// frequently-bought-together models.FrequentlyBoughtTogetherConfig *GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig `json:"frequentlyBoughtTogetherConfig,omitempty"`// ForceSendFields is a list of field names (e.g.// "FrequentlyBoughtTogetherConfig") to unconditionally include in API// requests. By default, fields with empty or default values are omitted from// API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FrequentlyBoughtTogetherConfig")// to include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ModelModelFeaturesConfig: Additional model featuresconfig.

func (GoogleCloudRetailV2ModelModelFeaturesConfig)MarshalJSONadded inv0.121.0

typeGoogleCloudRetailV2ModelServingConfigListadded inv0.109.0

type GoogleCloudRetailV2ModelServingConfigList struct {// ServingConfigIds: Optional. A set of valid serving configs that may be used// for `PAGE_OPTIMIZATION`.ServingConfigIds []string `json:"servingConfigIds,omitempty"`// ForceSendFields is a list of field names (e.g. "ServingConfigIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ServingConfigIds") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2ModelServingConfigList: Represents an ordered combinationof valid serving configs, which can be used for `PAGE_OPTIMIZATION`recommendations.

func (GoogleCloudRetailV2ModelServingConfigList)MarshalJSONadded inv0.109.0

typeGoogleCloudRetailV2OutputResultadded inv0.163.0

type GoogleCloudRetailV2OutputResult struct {// BigqueryResult: The BigQuery location where the result is stored.BigqueryResult []*GoogleCloudRetailV2BigQueryOutputResult `json:"bigqueryResult,omitempty"`// GcsResult: The Google Cloud Storage location where the result is stored.GcsResult []*GoogleCloudRetailV2GcsOutputResult `json:"gcsResult,omitempty"`// ForceSendFields is a list of field names (e.g. "BigqueryResult") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BigqueryResult") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2OutputResult: Output result that stores the informationabout where the exported data is stored.

func (GoogleCloudRetailV2OutputResult)MarshalJSONadded inv0.163.0

func (sGoogleCloudRetailV2OutputResult) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2PurgeMetadata

type GoogleCloudRetailV2PurgeMetadata struct {}

GoogleCloudRetailV2PurgeMetadata: Metadata related to the progress of thePurge operation. This will be returned by thegoogle.longrunning.Operation.metadata field.

typeGoogleCloudRetailV2PurgeProductsMetadataadded inv0.128.0

type GoogleCloudRetailV2PurgeProductsMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// FailureCount: Count of entries that encountered errors while processing.FailureCountint64 `json:"failureCount,omitempty,string"`// SuccessCount: Count of entries that were deleted successfully.SuccessCountint64 `json:"successCount,omitempty,string"`// UpdateTime: Operation last update time. If the operation is done, this is// also the finish time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2PurgeProductsMetadata: Metadata related to the progressof the PurgeProducts operation. This will be returned by thegoogle.longrunning.Operation.metadata field.

func (GoogleCloudRetailV2PurgeProductsMetadata)MarshalJSONadded inv0.128.0

typeGoogleCloudRetailV2PurgeProductsResponseadded inv0.128.0

type GoogleCloudRetailV2PurgeProductsResponse struct {// PurgeCount: The total count of products purged as a result of the operation.PurgeCountint64 `json:"purgeCount,omitempty,string"`// PurgeSample: A sample of the product names that will be deleted. Only// populated if `force` is set to false. A max of 100 names will be returned// and the names are chosen at random.PurgeSample []string `json:"purgeSample,omitempty"`// ForceSendFields is a list of field names (e.g. "PurgeCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PurgeCount") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2PurgeProductsResponse: Response of thePurgeProductsRequest. If the long running operation is successfully done,then this message is returned by the google.longrunning.Operations.responsefield.

func (GoogleCloudRetailV2PurgeProductsResponse)MarshalJSONadded inv0.128.0

typeGoogleCloudRetailV2PurgeUserEventsResponse

type GoogleCloudRetailV2PurgeUserEventsResponse struct {// PurgedEventsCount: The total count of events purged as a result of the// operation.PurgedEventsCountint64 `json:"purgedEventsCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "PurgedEventsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PurgedEventsCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2PurgeUserEventsResponse: Response of thePurgeUserEventsRequest. If the long running operation is successfully done,then this message is returned by the google.longrunning.Operations.responsefield.

func (GoogleCloudRetailV2PurgeUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2RejoinUserEventsMetadata

type GoogleCloudRetailV2RejoinUserEventsMetadata struct {}

GoogleCloudRetailV2RejoinUserEventsMetadata: Metadata for `RejoinUserEvents`method.

typeGoogleCloudRetailV2RejoinUserEventsResponse

type GoogleCloudRetailV2RejoinUserEventsResponse struct {// RejoinedUserEventsCount: Number of user events that were joined with latest// product catalog.RejoinedUserEventsCountint64 `json:"rejoinedUserEventsCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "RejoinedUserEventsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RejoinedUserEventsCount") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2RejoinUserEventsResponse: Response message for`RejoinUserEvents` method.

func (GoogleCloudRetailV2RejoinUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2RemoveFulfillmentPlacesMetadataadded inv0.52.0

type GoogleCloudRetailV2RemoveFulfillmentPlacesMetadata struct {}

GoogleCloudRetailV2RemoveFulfillmentPlacesMetadata: Metadata related to theprogress of the RemoveFulfillmentPlaces operation. Currently empty becausethere is no meaningful metadata populated from theProductService.RemoveFulfillmentPlaces method.

typeGoogleCloudRetailV2RemoveFulfillmentPlacesResponseadded inv0.52.0

type GoogleCloudRetailV2RemoveFulfillmentPlacesResponse struct {}

GoogleCloudRetailV2RemoveFulfillmentPlacesResponse: Response of theRemoveFulfillmentPlacesRequest. Currently empty because there is nomeaningful response populated from theProductService.RemoveFulfillmentPlaces method.

typeGoogleCloudRetailV2RemoveLocalInventoriesMetadataadded inv0.75.0

type GoogleCloudRetailV2RemoveLocalInventoriesMetadata struct {}

GoogleCloudRetailV2RemoveLocalInventoriesMetadata: Metadata related to theprogress of the RemoveLocalInventories operation. Currently empty becausethere is no meaningful metadata populated from theProductService.RemoveLocalInventories method.

typeGoogleCloudRetailV2RemoveLocalInventoriesResponseadded inv0.75.0

type GoogleCloudRetailV2RemoveLocalInventoriesResponse struct {}

GoogleCloudRetailV2RemoveLocalInventoriesResponse: Response of theProductService.RemoveLocalInventories API. Currently empty because there isno meaningful response populated from theProductService.RemoveLocalInventories method.

typeGoogleCloudRetailV2SetInventoryMetadataadded inv0.52.0

type GoogleCloudRetailV2SetInventoryMetadata struct {}

GoogleCloudRetailV2SetInventoryMetadata: Metadata related to the progress ofthe SetInventory operation. Currently empty because there is no meaningfulmetadata populated from the ProductService.SetInventory method.

typeGoogleCloudRetailV2SetInventoryResponseadded inv0.52.0

type GoogleCloudRetailV2SetInventoryResponse struct {}

GoogleCloudRetailV2SetInventoryResponse: Response of theSetInventoryRequest. Currently empty because there is no meaningful responsepopulated from the ProductService.SetInventory method.

typeGoogleCloudRetailV2TuneModelMetadataadded inv0.109.0

type GoogleCloudRetailV2TuneModelMetadata struct {// Model: The resource name of the model that this tune applies to. Format:// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/mode// ls/{model_id}`Modelstring `json:"model,omitempty"`// ForceSendFields is a list of field names (e.g. "Model") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Model") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2TuneModelMetadata: Metadata associated with a tuneoperation.

func (GoogleCloudRetailV2TuneModelMetadata)MarshalJSONadded inv0.109.0

typeGoogleCloudRetailV2TuneModelResponseadded inv0.109.0

type GoogleCloudRetailV2TuneModelResponse struct {}

GoogleCloudRetailV2TuneModelResponse: Response associated with a tuneoperation.

typeGoogleCloudRetailV2UserEventImportSummary

type GoogleCloudRetailV2UserEventImportSummary struct {// JoinedEventsCount: Count of user events imported with complete existing// catalog information.JoinedEventsCountint64 `json:"joinedEventsCount,omitempty,string"`// UnjoinedEventsCount: Count of user events imported, but with catalog// information not found in the imported catalog.UnjoinedEventsCountint64 `json:"unjoinedEventsCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "JoinedEventsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "JoinedEventsCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2UserEventImportSummary: A summary of import result. TheUserEventImportSummary summarizes the import status for user events.

func (GoogleCloudRetailV2UserEventImportSummary)MarshalJSON

typeGoogleCloudRetailV2alphaAcceptTermsRequestadded inv0.131.0

type GoogleCloudRetailV2alphaAcceptTermsRequest struct {}

GoogleCloudRetailV2alphaAcceptTermsRequest: Request for AcceptTerms method.

typeGoogleCloudRetailV2alphaAddCatalogAttributeRequestadded inv0.71.0

type GoogleCloudRetailV2alphaAddCatalogAttributeRequest struct {// CatalogAttribute: Required. The CatalogAttribute to add.CatalogAttribute *GoogleCloudRetailV2alphaCatalogAttribute `json:"catalogAttribute,omitempty"`// ForceSendFields is a list of field names (e.g. "CatalogAttribute") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CatalogAttribute") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaAddCatalogAttributeRequest: Request forCatalogService.AddCatalogAttribute method.

func (GoogleCloudRetailV2alphaAddCatalogAttributeRequest)MarshalJSONadded inv0.71.0

typeGoogleCloudRetailV2alphaAddControlRequestadded inv0.66.0

type GoogleCloudRetailV2alphaAddControlRequest struct {// ControlId: Required. The id of the control to apply. Assumed to be in the// same catalog as the serving config - if id is not found a NOT_FOUND error is// returned.ControlIdstring `json:"controlId,omitempty"`// ForceSendFields is a list of field names (e.g. "ControlId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ControlId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaAddControlRequest: Request for AddControl method.

func (GoogleCloudRetailV2alphaAddControlRequest)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaAddFulfillmentPlacesMetadataadded inv0.52.0

type GoogleCloudRetailV2alphaAddFulfillmentPlacesMetadata struct {}

GoogleCloudRetailV2alphaAddFulfillmentPlacesMetadata: Metadata related tothe progress of the AddFulfillmentPlaces operation. Currently empty becausethere is no meaningful metadata populated from theProductService.AddFulfillmentPlaces method.

typeGoogleCloudRetailV2alphaAddFulfillmentPlacesRequestadded inv0.52.0

type GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest struct {// AddTime: The time when the fulfillment updates are issued, used to prevent// out-of-order updates on fulfillment information. If not provided, the// internal system time will be used.AddTimestring `json:"addTime,omitempty"`// AllowMissing: If set to true, and the Product is not found, the fulfillment// information will still be processed and retained for at most 1 day and// processed once the Product is created. If set to false, a NOT_FOUND error is// returned if the Product is not found.AllowMissingbool `json:"allowMissing,omitempty"`// PlaceIds: Required. The IDs for this type, such as the store IDs for// "pickup-in-store" or the region IDs for "same-day-delivery" to be added for// this type. Duplicate IDs will be automatically ignored. At least 1 value is// required, and a maximum of 2000 values are allowed. Each value must be a// string with a length limit of 10 characters, matching the pattern// `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an// INVALID_ARGUMENT error is returned. If the total number of place IDs exceeds// 2000 for this type after adding, then the update will be rejected.PlaceIds []string `json:"placeIds,omitempty"`// Type: Required. The fulfillment type, including commonly used types (such as// pickup in store and same day delivery), and custom types. Supported values:// * "pickup-in-store" * "ship-to-store" * "same-day-delivery" *// "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" *// "custom-type-4" * "custom-type-5" If this field is set to an invalid value// other than these, an INVALID_ARGUMENT error is returned. This field directly// corresponds to Product.fulfillment_info.type.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "AddTime") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AddTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest: Request message forProductService.AddFulfillmentPlaces method.

func (GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaAddFulfillmentPlacesResponseadded inv0.52.0

type GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse struct {}

GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse: Response of theAddFulfillmentPlacesRequest. Currently empty because there is no meaningfulresponse populated from the ProductService.AddFulfillmentPlaces method.

typeGoogleCloudRetailV2alphaAddLocalInventoriesMetadataadded inv0.61.0

type GoogleCloudRetailV2alphaAddLocalInventoriesMetadata struct {}

GoogleCloudRetailV2alphaAddLocalInventoriesMetadata: Metadata related to theprogress of the AddLocalInventories operation. Currently empty because thereis no meaningful metadata populated from theProductService.AddLocalInventories method.

typeGoogleCloudRetailV2alphaAddLocalInventoriesRequestadded inv0.61.0

type GoogleCloudRetailV2alphaAddLocalInventoriesRequest struct {// AddMask: Indicates which inventory fields in the provided list of// LocalInventory to update. The field is updated to the provided value. If a// field is set while the place does not have a previous local inventory, the// local inventory at that store is created. If a field is set while the value// of that field is not provided, the original field value, if it exists, is// deleted. If the mask is not set or set with empty paths, all inventory// fields will be updated. If an unsupported or unknown field is provided, an// INVALID_ARGUMENT error is returned and the entire update will be ignored.AddMaskstring `json:"addMask,omitempty"`// AddTime: The time when the inventory updates are issued. Used to prevent// out-of-order updates on local inventory fields. If not provided, the// internal system time will be used.AddTimestring `json:"addTime,omitempty"`// AllowMissing: If set to true, and the Product is not found, the local// inventory will still be processed and retained for at most 1 day and// processed once the Product is created. If set to false, a NOT_FOUND error is// returned if the Product is not found.AllowMissingbool `json:"allowMissing,omitempty"`// LocalInventories: Required. A list of inventory information at difference// places. Each place is identified by its place ID. At most 3000 inventories// are allowed per request.LocalInventories []*GoogleCloudRetailV2alphaLocalInventory `json:"localInventories,omitempty"`// ForceSendFields is a list of field names (e.g. "AddMask") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AddMask") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaAddLocalInventoriesRequest: Request message forProductService.AddLocalInventories method.

func (GoogleCloudRetailV2alphaAddLocalInventoriesRequest)MarshalJSONadded inv0.61.0

typeGoogleCloudRetailV2alphaAddLocalInventoriesResponseadded inv0.61.0

type GoogleCloudRetailV2alphaAddLocalInventoriesResponse struct {}

GoogleCloudRetailV2alphaAddLocalInventoriesResponse: Response of theProductService.AddLocalInventories API. Currently empty because there is nomeaningful response populated from the ProductService.AddLocalInventoriesmethod.

typeGoogleCloudRetailV2alphaAlertConfigadded inv0.169.0

type GoogleCloudRetailV2alphaAlertConfig struct {// AlertPolicies: Alert policies for a customer. They must be unique by// [AlertPolicy.alert_group]AlertPolicies []*GoogleCloudRetailV2alphaAlertConfigAlertPolicy `json:"alertPolicies,omitempty"`// Name: Required. Immutable. The name of the AlertConfig singleton resource.// Format: projects/*/alertConfigNamestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AlertPolicies") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AlertPolicies") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaAlertConfig: Project level alert config.

func (GoogleCloudRetailV2alphaAlertConfig)MarshalJSONadded inv0.169.0

typeGoogleCloudRetailV2alphaAlertConfigAlertPolicyadded inv0.169.0

type GoogleCloudRetailV2alphaAlertConfigAlertPolicy struct {// AlertGroup: The feature that provides alerting capability. Supported value:// - `search-data-quality` for retail search customers. - `conv-data-quality`// for retail conversation customers.AlertGroupstring `json:"alertGroup,omitempty"`// EnrollStatus: The enrollment status of a customer.//// Possible values://   "ENROLL_STATUS_UNSPECIFIED" - Default value. Used for customers who have// not responded to the alert policy.//   "ENROLLED" - Customer is enrolled in this policy.//   "DECLINED" - Customer declined this policy.EnrollStatusstring `json:"enrollStatus,omitempty"`// Recipients: Recipients for the alert policy. One alert policy should not// exceed 20 recipients.Recipients []*GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient `json:"recipients,omitempty"`// ForceSendFields is a list of field names (e.g. "AlertGroup") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AlertGroup") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaAlertConfigAlertPolicy: Alert policy for a customer.

func (GoogleCloudRetailV2alphaAlertConfigAlertPolicy)MarshalJSONadded inv0.169.0

typeGoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipientadded inv0.169.0

type GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient struct {// EmailAddress: Email address of the recipient.EmailAddressstring `json:"emailAddress,omitempty"`// ForceSendFields is a list of field names (e.g. "EmailAddress") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EmailAddress") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient: Recipient contactinformation.

func (GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient)MarshalJSONadded inv0.169.0

typeGoogleCloudRetailV2alphaAttributesConfigadded inv0.71.0

type GoogleCloudRetailV2alphaAttributesConfig struct {// AttributeConfigLevel: Output only. The AttributeConfigLevel used for this// catalog.//// Possible values://   "ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED" - Value used when unset. In this// case, server behavior defaults to CATALOG_LEVEL_ATTRIBUTE_CONFIG.//   "PRODUCT_LEVEL_ATTRIBUTE_CONFIG" - At this level, we honor the attribute// configurations set in Product.attributes.//   "CATALOG_LEVEL_ATTRIBUTE_CONFIG" - At this level, we honor the attribute// configurations set in `CatalogConfig.attribute_configs`.AttributeConfigLevelstring `json:"attributeConfigLevel,omitempty"`// CatalogAttributes: Enable attribute(s) config at catalog level. For example,// indexable, dynamic_facetable, or searchable for each attribute. The key is// catalog attribute's name. For example: `color`, `brands`,// `attributes.custom_attribute`, such as `attributes.xyz`. The maximum number// of catalog attributes allowed in a request is 1000.CatalogAttributes map[string]GoogleCloudRetailV2alphaCatalogAttribute `json:"catalogAttributes,omitempty"`// Name: Required. Immutable. The fully qualified resource name of the// attribute config. Format:// `projects/*/locations/*/catalogs/*/attributesConfig`Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AttributeConfigLevel") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AttributeConfigLevel") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaAttributesConfig: Catalog level attribute config.

func (GoogleCloudRetailV2alphaAttributesConfig)MarshalJSONadded inv0.71.0

typeGoogleCloudRetailV2alphaAudienceadded inv0.52.0

type GoogleCloudRetailV2alphaAudience struct {// AgeGroups: The age groups of the audience. Strongly encouraged to use the// standard values: "newborn" (up to 3 months old), "infant" (3–12 months// old), "toddler" (1–5 years old), "kids" (5–13 years old), "adult"// (typically teens or older). At most 5 values are allowed. Each value must be// a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an// INVALID_ARGUMENT error is returned. Google Merchant Center property// age_group (https://support.google.com/merchants/answer/6324463). Schema.org// property Product.audience.suggestedMinAge// (https://schema.org/suggestedMinAge) and Product.audience.suggestedMaxAge// (https://schema.org/suggestedMaxAge).AgeGroups []string `json:"ageGroups,omitempty"`// Genders: The genders of the audience. Strongly encouraged to use the// standard values: "male", "female", "unisex". At most 5 values are allowed.// Each value must be a UTF-8 encoded string with a length limit of 128// characters. Otherwise, an INVALID_ARGUMENT error is returned. Google// Merchant Center property gender// (https://support.google.com/merchants/answer/6324479). Schema.org property// Product.audience.suggestedGender (https://schema.org/suggestedGender).Genders []string `json:"genders,omitempty"`// ForceSendFields is a list of field names (e.g. "AgeGroups") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AgeGroups") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaAudience: An intended audience of the Product forwhom it's sold.

func (GoogleCloudRetailV2alphaAudience)MarshalJSONadded inv0.52.0

func (sGoogleCloudRetailV2alphaAudience) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequestadded inv0.92.0

type GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest struct {// AttributeKeys: Required. The attribute name keys of the CatalogAttributes to// delete. A maximum of 1000 catalog attributes can be deleted in a batch.AttributeKeys []string `json:"attributeKeys,omitempty"`// ForceSendFields is a list of field names (e.g. "AttributeKeys") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AttributeKeys") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest: Request forCatalogService.BatchRemoveCatalogAttributes method.

func (GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest)MarshalJSONadded inv0.92.0

typeGoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponseadded inv0.92.0

type GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse struct {// DeletedCatalogAttributes: Catalog attributes that were deleted. Only// pre-loaded catalog attributes that are neither in use by products nor// predefined can be deleted.DeletedCatalogAttributes []string `json:"deletedCatalogAttributes,omitempty"`// ResetCatalogAttributes: Catalog attributes that were reset. Catalog// attributes that are either in use by products or are predefined attributes// cannot be deleted; however, their configuration properties will reset to// default values upon removal request.ResetCatalogAttributes []string `json:"resetCatalogAttributes,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DeletedCatalogAttributes")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeletedCatalogAttributes") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse: Response ofthe CatalogService.BatchRemoveCatalogAttributes.

func (GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse)MarshalJSONadded inv0.92.0

typeGoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequestadded inv0.199.0

type GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest struct {// Requests: Required. The updates question configs.Requests []*GoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequest `json:"requests,omitempty"`// ForceSendFields is a list of field names (e.g. "Requests") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Requests") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest: Requestfor BatchUpdateGenerativeQuestionConfig method.

func (GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest)MarshalJSONadded inv0.199.0

typeGoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponseadded inv0.199.0

type GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse struct {// GenerativeQuestionConfigs: Optional. The updates question configs.GenerativeQuestionConfigs []*GoogleCloudRetailV2alphaGenerativeQuestionConfig `json:"generativeQuestionConfigs,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "GenerativeQuestionConfigs")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GenerativeQuestionConfigs") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse:Aggregated response for UpdateGenerativeQuestionConfig method.

func (GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse)MarshalJSONadded inv0.199.0

typeGoogleCloudRetailV2alphaBigQueryOutputResultadded inv0.90.0

type GoogleCloudRetailV2alphaBigQueryOutputResult struct {// DatasetId: The ID of a BigQuery Dataset.DatasetIdstring `json:"datasetId,omitempty"`// TableId: The ID of a BigQuery Table.TableIdstring `json:"tableId,omitempty"`// ForceSendFields is a list of field names (e.g. "DatasetId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DatasetId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaBigQueryOutputResult: A BigQuery output result.

func (GoogleCloudRetailV2alphaBigQueryOutputResult)MarshalJSONadded inv0.90.0

typeGoogleCloudRetailV2alphaBigQuerySource

type GoogleCloudRetailV2alphaBigQuerySource struct {// DataSchema: The schema to use when parsing the data from the source.// Supported values for product imports: * `product` (default): One JSON// Product per line. Each product must have a valid Product.id. *// `product_merchant_center`: See Importing catalog data from Merchant Center// (https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).// Supported values for user events imports: * `user_event` (default): One JSON// UserEvent per line. * `user_event_ga360`: The schema is available here://https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The// schema is available here://https://support.google.com/analytics/answer/7029846. Supported values for// autocomplete imports: * `suggestions` (default): One JSON completion// suggestion per line. * `denylist`: One JSON deny suggestion per line. *// `allowlist`: One JSON allow suggestion per line.DataSchemastring `json:"dataSchema,omitempty"`// DatasetId: Required. The BigQuery data set to copy the data from with a// length limit of 1,024 characters.DatasetIdstring `json:"datasetId,omitempty"`// GcsStagingDir: Intermediate Cloud Storage directory used for the import with// a length limit of 2,000 characters. Can be specified if one wants to have// the BigQuery export to a specific Cloud Storage directory.GcsStagingDirstring `json:"gcsStagingDir,omitempty"`// PartitionDate: BigQuery time partitioned table's _PARTITIONDATE in// YYYY-MM-DD format.PartitionDate *GoogleTypeDate `json:"partitionDate,omitempty"`// ProjectId: The project ID (can be project # or ID) that the BigQuery source// is in with a length limit of 128 characters. If not specified, inherits the// project ID from the parent request.ProjectIdstring `json:"projectId,omitempty"`// TableId: Required. The BigQuery table to copy the data from with a length// limit of 1,024 characters.TableIdstring `json:"tableId,omitempty"`// ForceSendFields is a list of field names (e.g. "DataSchema") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DataSchema") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaBigQuerySource: BigQuery source import data from.

func (GoogleCloudRetailV2alphaBigQuerySource)MarshalJSON

typeGoogleCloudRetailV2alphaBranchadded inv0.177.0

type GoogleCloudRetailV2alphaBranch struct {// DisplayName: Output only. Human readable name of the branch to display in// the UI.DisplayNamestring `json:"displayName,omitempty"`// IsDefault: Output only. Indicates whether this branch is set as the default// branch of its parent catalog.IsDefaultbool `json:"isDefault,omitempty"`// LastProductImportTime: Output only. Timestamp of last import through// ProductService.ImportProducts. Empty value means no import has been made to// this branch.LastProductImportTimestring `json:"lastProductImportTime,omitempty"`// Name: Immutable. Full resource name of the branch, such as// `projects/*/locations/global/catalogs/default_catalog/branches/branch_id`.Namestring `json:"name,omitempty"`// ProductCountStats: Output only. Statistics for number of products in the// branch, provided for different scopes. This field is not populated in// BranchView.BASIC view.ProductCountStats []*GoogleCloudRetailV2alphaBranchProductCountStatistic `json:"productCountStats,omitempty"`// QualityMetrics: Output only. The quality metrics measured among products of// this branch. See QualityMetric.requirement_key for supported metrics.// Metrics could be missing if failed to retrieve. This field is not populated// in BranchView.BASIC view.QualityMetrics []*GoogleCloudRetailV2alphaBranchQualityMetric `json:"qualityMetrics,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaBranch: A data branch that stores all instances ofProducts.

func (GoogleCloudRetailV2alphaBranch)MarshalJSONadded inv0.177.0

func (sGoogleCloudRetailV2alphaBranch) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaBranchProductCountStatisticadded inv0.177.0

type GoogleCloudRetailV2alphaBranchProductCountStatistic struct {// Counts: The number of products in scope broken down into different groups.// The key is a group representing a set of products, and the value is the// number of products in that group. Note: keys in this map may change over// time. Possible keys: * "primary-in-stock", products have// Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. *// "primary-out-of-stock", products have Product.Type.PRIMARY type and// Product.Availability.OUT_OF_STOCK availability. * "primary-preorder",// products have Product.Type.PRIMARY type and Product.Availability.PREORDER// availability. * "primary-backorder", products have Product.Type.PRIMARY type// and Product.Availability.BACKORDER availability. * "variant-in-stock",// products have Product.Type.VARIANT type and Product.Availability.IN_STOCK// availability. * "variant-out-of-stock", products have Product.Type.VARIANT// type and Product.Availability.OUT_OF_STOCK availability. *// "variant-preorder", products have Product.Type.VARIANT type and// Product.Availability.PREORDER availability. * "variant-backorder", products// have Product.Type.VARIANT type and Product.Availability.BACKORDER// availability. * "price-discounted", products have [Product.price_info.price]// < [Product.price_info.original_price].Counts map[string]string `json:"counts,omitempty"`// Scope: [ProductCountScope] of the [counts].//// Possible values://   "PRODUCT_COUNT_SCOPE_UNSPECIFIED" - Default value for enum. This value is// not used in the API response.//   "ALL_PRODUCTS" - Scope for all existing products in the branch. Useful for// understanding how many products there are in a branch.//   "LAST_24_HOUR_UPDATE" - Scope for products created or updated in the last// 24 hours.Scopestring `json:"scope,omitempty"`// ForceSendFields is a list of field names (e.g. "Counts") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Counts") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaBranchProductCountStatistic: A statistic about thenumber of products in a branch.

func (GoogleCloudRetailV2alphaBranchProductCountStatistic)MarshalJSONadded inv0.177.0

typeGoogleCloudRetailV2alphaBranchQualityMetricadded inv0.177.0

type GoogleCloudRetailV2alphaBranchQualityMetric struct {// QualifiedProductCount: Number of products passing the quality requirement// check. We only check searchable products.QualifiedProductCountint64 `json:"qualifiedProductCount,omitempty"`// RequirementKey: The key that represents a quality requirement rule.// Supported keys: * "has-valid-uri": product has a valid and accessible uri. *// "available-expire-time-conformance": Product.available_time is early than// "now", and Product.expire_time is greater than "now". *// "has-searchable-attributes": product has at least one attribute set to// searchable. * "has-description": product has non-empty description. *// "has-at-least-bigram-title": Product title has at least two words. A// comprehensive title helps to improve search quality. * "variant-has-image":// the variant products has at least one image. You may ignore this metric if// all your products are at primary level. * "variant-has-price-info": the// variant products has price_info set. You may ignore this metric if all your// products are at primary level. * "has-publish-time": product has non-empty// publish_time.RequirementKeystring `json:"requirementKey,omitempty"`// SuggestedQualityPercentThreshold: Value from 0 to 100 representing the// suggested percentage of products that meet the quality requirements to get// good search and recommendation performance. 100 * (qualified_product_count)// / (qualified_product_count + unqualified_product_count) should be greater or// equal to this suggestion.SuggestedQualityPercentThresholdfloat64 `json:"suggestedQualityPercentThreshold,omitempty"`// UnqualifiedProductCount: Number of products failing the quality requirement// check. We only check searchable products.UnqualifiedProductCountint64 `json:"unqualifiedProductCount,omitempty"`// UnqualifiedSampleProducts: A list of a maximum of 100 sample products that// do not qualify for this requirement. This field is only populated in the// response to BranchService.GetBranch API, and is always empty for// BranchService.ListBranches. Only the following fields are set in the// Product. * Product.name * Product.id * Product.titleUnqualifiedSampleProducts []*GoogleCloudRetailV2alphaProduct `json:"unqualifiedSampleProducts,omitempty"`// ForceSendFields is a list of field names (e.g. "QualifiedProductCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "QualifiedProductCount") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaBranchQualityMetric: Metric measured on a group ofProducts against a certain quality requirement. Contains the number ofproducts that pass the check and the number of products that don't.

func (GoogleCloudRetailV2alphaBranchQualityMetric)MarshalJSONadded inv0.177.0

func (*GoogleCloudRetailV2alphaBranchQualityMetric)UnmarshalJSONadded inv0.177.0

typeGoogleCloudRetailV2alphaCatalog

type GoogleCloudRetailV2alphaCatalog struct {// DisplayName: Required. Immutable. The catalog display name. This field must// be a UTF-8 encoded string with a length limit of 128 characters. Otherwise,// an INVALID_ARGUMENT error is returned.DisplayNamestring `json:"displayName,omitempty"`// MerchantCenterLinkingConfig: The Merchant Center linking configuration.// After a link is added, the data stream from Merchant Center to Cloud Retail// will be enabled automatically. The requester must have access to the// Merchant Center account in order to make changes to this field.MerchantCenterLinkingConfig *GoogleCloudRetailV2alphaMerchantCenterLinkingConfig `json:"merchantCenterLinkingConfig,omitempty"`// Name: Required. Immutable. The fully qualified resource name of the catalog.Namestring `json:"name,omitempty"`// ProductLevelConfig: Required. The product level configuration.ProductLevelConfig *GoogleCloudRetailV2alphaProductLevelConfig `json:"productLevelConfig,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCatalog: The catalog configuration.

func (GoogleCloudRetailV2alphaCatalog)MarshalJSON

func (sGoogleCloudRetailV2alphaCatalog) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaCatalogAttributeadded inv0.71.0

type GoogleCloudRetailV2alphaCatalogAttribute struct {// DynamicFacetableOption: If DYNAMIC_FACETABLE_ENABLED, attribute values are// available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if// CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an// INVALID_ARGUMENT error is returned. Must be specified, otherwise throws// INVALID_FORMAT error.//// Possible values://   "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED" - Value used when unset.//   "DYNAMIC_FACETABLE_ENABLED" - Dynamic facetable option enabled for an// attribute.//   "DYNAMIC_FACETABLE_DISABLED" - Dynamic facetable option disabled for an// attribute.DynamicFacetableOptionstring `json:"dynamicFacetableOption,omitempty"`// ExactSearchableOption: If EXACT_SEARCHABLE_ENABLED, attribute values will be// exact searchable. This property only applies to textual custom attributes// and requires indexable set to enabled to enable exact-searchable. If unset,// the server behavior defaults to EXACT_SEARCHABLE_DISABLED.//// Possible values://   "EXACT_SEARCHABLE_OPTION_UNSPECIFIED" - Value used when unset.//   "EXACT_SEARCHABLE_ENABLED" - Exact searchable option enabled for an// attribute.//   "EXACT_SEARCHABLE_DISABLED" - Exact searchable option disabled for an// attribute.ExactSearchableOptionstring `json:"exactSearchableOption,omitempty"`// FacetConfig: Contains facet options.FacetConfig *GoogleCloudRetailV2alphaCatalogAttributeFacetConfig `json:"facetConfig,omitempty"`// InUse: Output only. Indicates whether this attribute has been used by any// products. `True` if at least one Product is using this attribute in// Product.attributes. Otherwise, this field is `False`. CatalogAttribute can// be pre-loaded by using CatalogService.AddCatalogAttribute or// CatalogService.UpdateAttributesConfig APIs. This field is `False` for// pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are// neither in use by products nor predefined can be deleted. Catalog attributes// that are either in use by products or are predefined attributes cannot be// deleted; however, their configuration properties will reset to default// values upon removal request. After catalog changes, it takes about 10// minutes for this field to update.InUsebool `json:"inUse,omitempty"`// IndexableOption: When AttributesConfig.attribute_config_level is// CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are// indexed so that it can be filtered, faceted, or boosted in// SearchService.Search. Must be specified when// AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,// otherwise throws INVALID_FORMAT error.//// Possible values://   "INDEXABLE_OPTION_UNSPECIFIED" - Value used when unset.//   "INDEXABLE_ENABLED" - Indexable option enabled for an attribute.//   "INDEXABLE_DISABLED" - Indexable option disabled for an attribute.IndexableOptionstring `json:"indexableOption,omitempty"`// Key: Required. Attribute name. For example: `color`, `brands`,// `attributes.custom_attribute`, such as `attributes.xyz`. To be indexable,// the attribute name can contain only alpha-numeric characters and// underscores. For example, an attribute named `attributes.abc_xyz` can be// indexed, but an attribute named `attributes.abc-xyz` cannot be indexed. If// the attribute key starts with `attributes.`, then the attribute is a custom// attribute. Attributes such as `brands`, `patterns`, and `title` are built-in// and called system attributes.Keystring `json:"key,omitempty"`// RecommendationsFilteringOption: When AttributesConfig.attribute_config_level// is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED,// attribute values are filterable for recommendations. This option works for// categorical features only, does not work for numerical features, inventory// filtering.//// Possible values://   "RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED" - Value used when unset. In// this case, server behavior defaults to RECOMMENDATIONS_FILTERING_DISABLED.//   "RECOMMENDATIONS_FILTERING_DISABLED" - Recommendation filtering is// disabled.//   "RECOMMENDATIONS_FILTERING_ENABLED" - Recommendation filtering is enabled.RecommendationsFilteringOptionstring `json:"recommendationsFilteringOption,omitempty"`// RetrievableOption: If RETRIEVABLE_ENABLED, attribute values are retrievable// in the search results. If unset, the server behavior defaults to// RETRIEVABLE_DISABLED.//// Possible values://   "RETRIEVABLE_OPTION_UNSPECIFIED" - Value used when unset.//   "RETRIEVABLE_ENABLED" - Retrievable option enabled for an attribute.//   "RETRIEVABLE_DISABLED" - Retrievable option disabled for an attribute.RetrievableOptionstring `json:"retrievableOption,omitempty"`// SearchableOption: When AttributesConfig.attribute_config_level is// CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are// searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED// but attribute type is numerical, attribute values will not be searchable by// text queries in SearchService.Search, as there are no text values associated// to numerical attributes. Must be specified, when// AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,// otherwise throws INVALID_FORMAT error.//// Possible values://   "SEARCHABLE_OPTION_UNSPECIFIED" - Value used when unset.//   "SEARCHABLE_ENABLED" - Searchable option enabled for an attribute.//   "SEARCHABLE_DISABLED" - Searchable option disabled for an attribute.SearchableOptionstring `json:"searchableOption,omitempty"`// Type: Output only. The type of this attribute. This is derived from the// attribute in Product.attributes.//// Possible values://   "UNKNOWN" - The type of the attribute is unknown. Used when type cannot be// derived from attribute that is not in_use.//   "TEXTUAL" - Textual attribute.//   "NUMERICAL" - Numerical attribute.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "DynamicFacetableOption") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DynamicFacetableOption") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCatalogAttribute: Catalog level attribute config foran attribute. For example, if customers want to enable/disable facet for aspecific attribute.

func (GoogleCloudRetailV2alphaCatalogAttribute)MarshalJSONadded inv0.71.0

typeGoogleCloudRetailV2alphaCatalogAttributeFacetConfigadded inv0.139.0

type GoogleCloudRetailV2alphaCatalogAttributeFacetConfig struct {// FacetIntervals: If you don't set the facet// SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical// attribute, then we use the computed intervals with rounded bounds obtained// from all its product numerical attribute values. The computed intervals// might not be ideal for some attributes. Therefore, we give you the option to// overwrite them with the facet_intervals field. The maximum of facet// intervals per CatalogAttribute is 40. Each interval must have a lower bound// or an upper bound. If both bounds are provided, then the lower bound must be// smaller or equal than the upper bound.FacetIntervals []*GoogleCloudRetailV2alphaInterval `json:"facetIntervals,omitempty"`// IgnoredFacetValues: Each instance represents a list of attribute values to// ignore as facet values for a specific time range. The maximum number of// instances per CatalogAttribute is 25.IgnoredFacetValues []*GoogleCloudRetailV2alphaCatalogAttributeFacetConfigIgnoredFacetValues `json:"ignoredFacetValues,omitempty"`// MergedFacet: Use this field only if you want to merge a facet key into// another facet key.MergedFacet *GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacet `json:"mergedFacet,omitempty"`// MergedFacetValues: Each instance replaces a list of facet values by a merged// facet value. If a facet value is not in any list, then it will stay the// same. To avoid conflicts, only paths of length 1 are accepted. In other// words, if "dark_blue" merged into "BLUE", then the latter can't merge into// "blues" because this would create a path of length 2. The maximum number of// instances of MergedFacetValue per CatalogAttribute is 100. This feature is// available only for textual custom attributes.MergedFacetValues []*GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue `json:"mergedFacetValues,omitempty"`// RerankConfig: Set this field only if you want to rerank based on facet// values engaged by the user for the current key. This option is only possible// for custom facetable textual keys.RerankConfig *GoogleCloudRetailV2alphaCatalogAttributeFacetConfigRerankConfig `json:"rerankConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "FacetIntervals") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FacetIntervals") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCatalogAttributeFacetConfig: Possible options forthe facet that corresponds to the current attribute config.

func (GoogleCloudRetailV2alphaCatalogAttributeFacetConfig)MarshalJSONadded inv0.139.0

typeGoogleCloudRetailV2alphaCatalogAttributeFacetConfigIgnoredFacetValuesadded inv0.139.0

type GoogleCloudRetailV2alphaCatalogAttributeFacetConfigIgnoredFacetValues struct {// EndTime: If start time is empty and end time is not empty, then ignore these// facet values before end time.EndTimestring `json:"endTime,omitempty"`// StartTime: Time range for the current list of facet values to ignore. If// multiple time ranges are specified for an facet value for the current// attribute, consider all of them. If both are empty, ignore always. If start// time and end time are set, then start time must be before end time. If start// time is not empty and end time is empty, then will ignore these facet values// after the start time.StartTimestring `json:"startTime,omitempty"`// Values: List of facet values to ignore for the following time range. The// facet values are the same as the attribute values. There is a limit of 10// values per instance of IgnoredFacetValues. Each value can have at most 128// characters.Values []string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EndTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCatalogAttributeFacetConfigIgnoredFacetValues: Facetvalues to ignore on facets during the specified time range for the givenSearchResponse.Facet.key attribute.

func (GoogleCloudRetailV2alphaCatalogAttributeFacetConfigIgnoredFacetValues)MarshalJSONadded inv0.139.0

typeGoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetadded inv0.161.0

type GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacet struct {// MergedFacetKey: The merged facet key should be a valid facet key that is// different than the facet key of the current catalog attribute. We refer this// is merged facet key as the child of the current catalog attribute. This// merged facet key can't be a parent of another facet key (i.e. no directed// path of length 2). This merged facet key needs to be either a textual custom// attribute or a numerical custom attribute.MergedFacetKeystring `json:"mergedFacetKey,omitempty"`// ForceSendFields is a list of field names (e.g. "MergedFacetKey") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MergedFacetKey") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacet: The currentfacet key (i.e. attribute config) maps into the merged_facet_key. A facetkey can have at most one child. The current facet key and the merged facetkey need both to be textual custom attributes or both numerical customattributes (same type).

func (GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacet)MarshalJSONadded inv0.161.0

typeGoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValueadded inv0.139.0

type GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue struct {// MergedValue: All the previous values are replaced by this merged facet// value. This merged_value must be non-empty and can have up to 128// characters.MergedValuestring `json:"mergedValue,omitempty"`// Values: All the facet values that are replaces by the same merged_value that// follows. The maximum number of values per MergedFacetValue is 25. Each value// can have up to 128 characters.Values []string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "MergedValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MergedValue") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue:Replaces a set of textual facet values by the same (possibly different)merged facet value. Each facet value should appear at most once as a valueper CatalogAttribute. This feature is available only for textual customattributes.

func (GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue)MarshalJSONadded inv0.139.0

typeGoogleCloudRetailV2alphaCatalogAttributeFacetConfigRerankConfigadded inv0.156.0

type GoogleCloudRetailV2alphaCatalogAttributeFacetConfigRerankConfig struct {// FacetValues: If empty, rerank on all facet values for the current key.// Otherwise, will rerank on the facet values from this list only.FacetValues []string `json:"facetValues,omitempty"`// RerankFacet: If set to true, then we also rerank the dynamic facets based on// the facet values engaged by the user for the current attribute key during// serving.RerankFacetbool `json:"rerankFacet,omitempty"`// ForceSendFields is a list of field names (e.g. "FacetValues") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FacetValues") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCatalogAttributeFacetConfigRerankConfig: Options torerank based on facet values engaged by the user for the current key. Thatkey needs to be a custom textual key and facetable. To use this control, youalso need to pass all the facet keys engaged by the user in the requestusing the field [SearchRequest.FacetSpec]. In particular, if you don't passthe facet keys engaged that you want to rerank on, this control won't beeffective. Moreover, to obtain better results, the facet values that youwant to rerank on should be close to English (ideally made of words,underscores, and spaces).

func (GoogleCloudRetailV2alphaCatalogAttributeFacetConfigRerankConfig)MarshalJSONadded inv0.156.0

typeGoogleCloudRetailV2alphaCollectUserEventRequestadded inv0.215.0

type GoogleCloudRetailV2alphaCollectUserEventRequest struct {// Ets: The event timestamp in milliseconds. This prevents browser caching of// otherwise identical get requests. The name is abbreviated to reduce the// payload bytes.Etsint64 `json:"ets,omitempty,string"`// PrebuiltRule: The prebuilt rule name that can convert a specific type of// raw_json. For example: "ga4_bq" rule for the GA4 user event schema.PrebuiltRulestring `json:"prebuiltRule,omitempty"`// RawJson: An arbitrary serialized JSON string that contains necessary// information that can comprise a user event. When this field is specified,// the user_event field will be ignored. Note: line-delimited JSON is not// supported, a single JSON only.RawJsonstring `json:"rawJson,omitempty"`// Uri: The URL including cgi-parameters but excluding the hash fragment with a// length limit of 5,000 characters. This is often more useful than the referer// URL, because many browsers only send the domain for 3rd party requests.Uristring `json:"uri,omitempty"`// UserEvent: Required. URL encoded UserEvent proto with a length limit of// 2,000,000 characters.UserEventstring `json:"userEvent,omitempty"`// ForceSendFields is a list of field names (e.g. "Ets") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Ets") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCollectUserEventRequest: Request message forCollectUserEvent method.

func (GoogleCloudRetailV2alphaCollectUserEventRequest)MarshalJSONadded inv0.215.0

typeGoogleCloudRetailV2alphaColorInfoadded inv0.52.0

type GoogleCloudRetailV2alphaColorInfo struct {// ColorFamilies: The standard color families. Strongly recommended to use the// following standard color groups: "Red", "Pink", "Orange", "Yellow",// "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and// "Mixed". Normally it is expected to have only 1 color family. May consider// using single "Mixed" instead of multiple values. A maximum of 5 values are// allowed. Each value must be a UTF-8 encoded string with a length limit of// 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google// Merchant Center property color// (https://support.google.com/merchants/answer/6324487). Schema.org property// Product.color (https://schema.org/color). The colorFamilies field as a// system attribute is not a required field but strongly recommended to be// specified. Google Search models treat this field as more important than a// custom product attribute when specified.ColorFamilies []string `json:"colorFamilies,omitempty"`// Colors: The color display names, which may be different from standard color// family names, such as the color aliases used in the website frontend.// Normally it is expected to have only 1 color. May consider using single// "Mixed" instead of multiple values. A maximum of 75 colors are allowed. Each// value must be a UTF-8 encoded string with a length limit of 128 characters.// Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center// property color (https://support.google.com/merchants/answer/6324487).// Schema.org property Product.color (https://schema.org/color).Colors []string `json:"colors,omitempty"`// ForceSendFields is a list of field names (e.g. "ColorFamilies") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ColorFamilies") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaColorInfo: The color information of a Product.

func (GoogleCloudRetailV2alphaColorInfo)MarshalJSONadded inv0.52.0

func (sGoogleCloudRetailV2alphaColorInfo) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaCompleteQueryResponseadded inv0.52.0

type GoogleCloudRetailV2alphaCompleteQueryResponse struct {// AttributeResults: A map of matched attribute suggestions. This field is only// available for `cloud-retail` dataset. Current supported keys: * `brands` *// `categories`AttributeResults map[string]GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult `json:"attributeResults,omitempty"`// AttributionToken: A unique complete token. This should be included in the// UserEvent.completion_detail for search events resulting from this// completion, which enables accurate attribution of complete model// performance.AttributionTokenstring `json:"attributionToken,omitempty"`// CompletionResults: Results of the matching suggestions. The result list is// ordered and the first result is top suggestion.CompletionResults []*GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult `json:"completionResults,omitempty"`// RecentSearchResults: Deprecated. Matched recent searches of this user. The// maximum number of recent searches is 10. This field is a restricted feature.// If you want to enable it, contact Retail Search support. This feature is// only available when CompleteQueryRequest.visitor_id field is set and// UserEvent is imported. The recent searches satisfy the follow rules: * They// are ordered from latest to oldest. * They are matched with// CompleteQueryRequest.query case insensitively. * They are transformed to// lower case. * They are UTF-8 safe. Recent searches are deduplicated. More// recent searches will be reserved when duplication happens.RecentSearchResults []*GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult `json:"recentSearchResults,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AttributeResults") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AttributeResults") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCompleteQueryResponse: Response of the autocompletequery.

func (GoogleCloudRetailV2alphaCompleteQueryResponse)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaCompleteQueryResponseAttributeResultadded inv0.102.0

type GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult struct {// Suggestions: The list of suggestions for the attribute.Suggestions []string `json:"suggestions,omitempty"`// ForceSendFields is a list of field names (e.g. "Suggestions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Suggestions") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult: Resource thatrepresents attribute results.

func (GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult)MarshalJSONadded inv0.102.0

typeGoogleCloudRetailV2alphaCompleteQueryResponseCompletionResultadded inv0.52.0

type GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult struct {// Attributes: Custom attributes for the suggestion term. * For `user-data`,// the attributes are additional custom attributes ingested through BigQuery. *// For `cloud-retail`, the attributes are product attributes generated by Cloud// Retail. It requires UserEvent.product_details is imported properly.Attributes map[string]GoogleCloudRetailV2alphaCustomAttribute `json:"attributes,omitempty"`// Facets: Facet information for the suggestion term. Gives the number of items// resulting from a search with this suggestion term for each facet. This is an// experimental feature for limited customers. If you want to receive this// facet information, reach out to the Retail support team.Facets []*GoogleCloudRetailV2alphaSearchResponseFacet `json:"facets,omitempty"`// Suggestion: The suggestion for the query.Suggestionstring `json:"suggestion,omitempty"`// TotalProductCount: Total number of products associated with a search with// this suggestion. This is an experimental feature for limited customers. If// you want to receive this product count information, reach out to the Retail// support team.TotalProductCountint64 `json:"totalProductCount,omitempty"`// ForceSendFields is a list of field names (e.g. "Attributes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Attributes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult: Resource thatrepresents completion results.

func (GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResultadded inv0.52.0

type GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult struct {// RecentSearch: The recent search query.RecentSearchstring `json:"recentSearch,omitempty"`// ForceSendFields is a list of field names (e.g. "RecentSearch") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RecentSearch") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult: Deprecated:Recent search of this user.

func (GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaCompletionConfigadded inv0.74.0

type GoogleCloudRetailV2alphaCompletionConfig struct {// AllowlistInputConfig: Output only. The source data for the latest import of// the autocomplete allowlist phrases.AllowlistInputConfig *GoogleCloudRetailV2alphaCompletionDataInputConfig `json:"allowlistInputConfig,omitempty"`// AutoLearning: If set to true, the auto learning function is enabled. Auto// learning uses user data to generate suggestions using ML techniques. Default// value is false. Only after enabling auto learning can users use// `cloud-retail` data in CompleteQueryRequest.AutoLearningbool `json:"autoLearning,omitempty"`// DenylistInputConfig: Output only. The source data for the latest import of// the autocomplete denylist phrases.DenylistInputConfig *GoogleCloudRetailV2alphaCompletionDataInputConfig `json:"denylistInputConfig,omitempty"`// LastAllowlistImportOperation: Output only. Name of the LRO corresponding to// the latest allowlist import. Can use GetOperation API to retrieve the latest// state of the Long Running Operation.LastAllowlistImportOperationstring `json:"lastAllowlistImportOperation,omitempty"`// LastDenylistImportOperation: Output only. Name of the LRO corresponding to// the latest denylist import. Can use GetOperation API to retrieve the latest// state of the Long Running Operation.LastDenylistImportOperationstring `json:"lastDenylistImportOperation,omitempty"`// LastSuggestionsImportOperation: Output only. Name of the LRO corresponding// to the latest suggestion terms list import. Can use GetOperation API method// to retrieve the latest state of the Long Running Operation.LastSuggestionsImportOperationstring `json:"lastSuggestionsImportOperation,omitempty"`// MatchingOrder: Specifies the matching order for autocomplete suggestions,// e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest// "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified// would suggest "red shoes". Currently supported values: * 'out-of-order' *// 'exact-prefix' Default value: 'exact-prefix'.MatchingOrderstring `json:"matchingOrder,omitempty"`// MaxSuggestions: The maximum number of autocomplete suggestions returned per// term. Default value is 20. If left unset or set to 0, then will fallback to// default value. Value range is 1 to 20.MaxSuggestionsint64 `json:"maxSuggestions,omitempty"`// MinPrefixLength: The minimum number of characters needed to be typed in// order to get suggestions. Default value is 2. If left unset or set to 0,// then will fallback to default value. Value range is 1 to 20.MinPrefixLengthint64 `json:"minPrefixLength,omitempty"`// Name: Required. Immutable. Fully qualified name// `projects/*/locations/*/catalogs/*/completionConfig`Namestring `json:"name,omitempty"`// SuggestionsInputConfig: Output only. The source data for the latest import// of the autocomplete suggestion phrases.SuggestionsInputConfig *GoogleCloudRetailV2alphaCompletionDataInputConfig `json:"suggestionsInputConfig,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AllowlistInputConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowlistInputConfig") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCompletionConfig: Catalog level autocomplete configfor customers to customize autocomplete feature's settings.

func (GoogleCloudRetailV2alphaCompletionConfig)MarshalJSONadded inv0.74.0

typeGoogleCloudRetailV2alphaCompletionDataInputConfigadded inv0.52.0

type GoogleCloudRetailV2alphaCompletionDataInputConfig struct {// BigQuerySource: Required. BigQuery input source. Add the IAM permission// "BigQuery Data Viewer" for// cloud-retail-customer-data-access@system.gserviceaccount.com before using// this feature otherwise an error is thrown.BigQuerySource *GoogleCloudRetailV2alphaBigQuerySource `json:"bigQuerySource,omitempty"`// ForceSendFields is a list of field names (e.g. "BigQuerySource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BigQuerySource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCompletionDataInputConfig: The input config sourcefor completion data.

func (GoogleCloudRetailV2alphaCompletionDataInputConfig)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaCompletionDetailadded inv0.52.0

type GoogleCloudRetailV2alphaCompletionDetail struct {// CompletionAttributionToken: Completion attribution token in// CompleteQueryResponse.attribution_token.CompletionAttributionTokenstring `json:"completionAttributionToken,omitempty"`// SelectedPosition: End user selected// CompleteQueryResponse.CompletionResult.suggestion position, starting from 0.SelectedPositionint64 `json:"selectedPosition,omitempty"`// SelectedSuggestion: End user selected// CompleteQueryResponse.CompletionResult.suggestion.SelectedSuggestionstring `json:"selectedSuggestion,omitempty"`// ForceSendFields is a list of field names (e.g. "CompletionAttributionToken")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CompletionAttributionToken") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCompletionDetail: Detailed completion informationincluding completion attribution token and clicked completion info.

func (GoogleCloudRetailV2alphaCompletionDetail)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaConditionadded inv0.66.0

type GoogleCloudRetailV2alphaCondition struct {// ActiveTimeRange: Range of time(s) specifying when Condition is active.// Condition true if any time range matches.ActiveTimeRange []*GoogleCloudRetailV2alphaConditionTimeRange `json:"activeTimeRange,omitempty"`// PageCategories: 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;PageCategories []string `json:"pageCategories,omitempty"`// QueryTerms: 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).QueryTerms []*GoogleCloudRetailV2alphaConditionQueryTerm `json:"queryTerms,omitempty"`// ForceSendFields is a list of field names (e.g. "ActiveTimeRange") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ActiveTimeRange") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCondition: Metadata that is used to define acondition that triggers an action. A valid condition must specify at leastone 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 queryterms and product_filter are set, then only items matching theproduct_filter for requests with a query matching the query terms wil getboosted.

func (GoogleCloudRetailV2alphaCondition)MarshalJSONadded inv0.66.0

func (sGoogleCloudRetailV2alphaCondition) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaConditionQueryTermadded inv0.66.0

type GoogleCloudRetailV2alphaConditionQueryTerm struct {// FullMatch: Whether this is supposed to be a full or partial match.FullMatchbool `json:"fullMatch,omitempty"`// Value: The value of the term to match on. Value cannot be empty. Value can// have at most 3 terms if specified as a partial match. Each space separated// string is considered as one term. For example, "a b c" is 3 terms and// allowed, but " a b c d" is 4 terms and not allowed for a partial match.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "FullMatch") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FullMatch") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConditionQueryTerm: Query terms that we want tomatch on.

func (GoogleCloudRetailV2alphaConditionQueryTerm)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaConditionTimeRangeadded inv0.66.0

type GoogleCloudRetailV2alphaConditionTimeRange struct {// EndTime: End of time range. Range is inclusive.EndTimestring `json:"endTime,omitempty"`// StartTime: Start of time range. Range is inclusive.StartTimestring `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EndTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConditionTimeRange: Used for time-dependentconditions. Example: Want to have rule applied for week long sale.

func (GoogleCloudRetailV2alphaConditionTimeRange)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaControladded inv0.66.0

type GoogleCloudRetailV2alphaControl struct {// AssociatedServingConfigIds: Output only. List of serving config ids that are// associated with this control in the same Catalog. Note the association is// managed via the ServingConfig, this is an output only denormalized view.AssociatedServingConfigIds []string `json:"associatedServingConfigIds,omitempty"`// DisplayName: Required. The human readable control display name. Used in// Retail UI. This field must be a UTF-8 encoded string with a length limit of// 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.DisplayNamestring `json:"displayName,omitempty"`// Name: Immutable. Fully qualified name// `projects/*/locations/global/catalogs/*/controls/*`Namestring `json:"name,omitempty"`// Rule: A rule control - a condition-action pair. Enacts a set action when the// condition is triggered. For example: Boost "gShoe" when query full matches// "Running Shoes".Rule *GoogleCloudRetailV2alphaRule `json:"rule,omitempty"`// SearchSolutionUseCase: Specifies the use case for the control. Affects what// condition fields can be set. Only settable by search controls. Will default// to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow// one search_solution_use_case per control.//// Possible values://   "SEARCH_SOLUTION_USE_CASE_UNSPECIFIED" - The value when it's unspecified.// In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.//   "SEARCH_SOLUTION_USE_CASE_SEARCH" - Search use case. Expects the traffic// has a non-empty query.//   "SEARCH_SOLUTION_USE_CASE_BROWSE" - Browse use case. Expects the traffic// has an empty query.SearchSolutionUseCase []string `json:"searchSolutionUseCase,omitempty"`// SolutionTypes: Required. Immutable. The solution types that the control is// used for. Currently we support setting only one type of solution at creation// time. Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. If no// solution type is provided at creation time, will default to// SOLUTION_TYPE_SEARCH.//// Possible values://   "SOLUTION_TYPE_UNSPECIFIED" - Default value.//   "SOLUTION_TYPE_RECOMMENDATION" - Used for Recommendations AI.//   "SOLUTION_TYPE_SEARCH" - Used for Retail Search.SolutionTypes []string `json:"solutionTypes,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AssociatedServingConfigIds")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AssociatedServingConfigIds") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaControl: Configures dynamic metadata that can belinked to a ServingConfig and affect search or recommendation results atserving time.

func (GoogleCloudRetailV2alphaControl)MarshalJSONadded inv0.66.0

func (sGoogleCloudRetailV2alphaControl) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaConversationalSearchCustomizationConfigadded inv0.239.0

type GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig struct {// Catalog: Required. Resource name of the catalog. Format:// projects/{project}/locations/{location}/catalogs/{catalog}Catalogstring `json:"catalog,omitempty"`// IntentClassificationConfig: Optional. The configs for intent classification.IntentClassificationConfig *GoogleCloudRetailV2alphaIntentClassificationConfig `json:"intentClassificationConfig,omitempty"`// RetailerDisplayName: Optional. The retailer's display name that could be// used in our LLM answers. Example - "Google"RetailerDisplayNamestring `json:"retailerDisplayName,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Catalog") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Catalog") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig: The publicproto to represent the conversational search customization config. It willbe converted to the internal proto in the backend.

func (GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig)MarshalJSONadded inv0.239.0

typeGoogleCloudRetailV2alphaConversationalSearchRequestadded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchRequest struct {// Branch: Required. The branch resource name, such as// `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use// "default_branch" as the branch ID or leave this field empty, to search// products under the default branch.Branchstring `json:"branch,omitempty"`// ConversationId: Optional. This field specifies the conversation id, which// maintains the state of the conversation between client side and server side.// Use the value from the previous// ConversationalSearchResponse.conversation_id. For the initial request, this// should be empty.ConversationIdstring `json:"conversationId,omitempty"`// ConversationalFilteringSpec: Optional. This field specifies all// conversational filtering related parameters.ConversationalFilteringSpec *GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec `json:"conversationalFilteringSpec,omitempty"`// PageCategories: Optional. The categories associated with a category page.// Must be set for category navigation queries to achieve good search quality.// The format should be the same as UserEvent.page_categories; To represent// full path of category, use '>' sign to separate different hierarchies. If// '>' is part of the category name, replace it with other character(s).// Category pages include special pages such as sales or promotions. For// instance, a special sale page may have the category hierarchy:// "pageCategories" : ["Sales > 2017 Black Friday Deals"].PageCategories []string `json:"pageCategories,omitempty"`// Query: Optional. Raw search query to be searched for. If this field is// empty, the request is considered a category browsing request.Querystring `json:"query,omitempty"`// SafetySettings: Optional. The safety settings to be applied to the generated// content.SafetySettings []*GoogleCloudRetailV2alphaSafetySetting `json:"safetySettings,omitempty"`// SearchParams: Optional. Search parameters.SearchParams *GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams `json:"searchParams,omitempty"`// UserInfo: Optional. User information.UserInfo *GoogleCloudRetailV2alphaUserInfo `json:"userInfo,omitempty"`// UserLabels: Optional. The user labels applied to a resource must meet the// following requirements: * Each resource can have multiple labels, up to a// maximum of 64. * Each label must be a key-value pair. * Keys have a minimum// length of 1 character and a maximum length of 63 characters and cannot be// empty. Values can be empty and have a maximum length of 63 characters. *// Keys and values can contain only lowercase letters, numeric characters,// underscores, and dashes. All characters must use UTF-8 encoding, and// international characters are allowed. * The key portion of a label must be// unique. However, you can use the same key with multiple resources. * Keys// must start with a lowercase letter or international character. See Google// Cloud Document// (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)// for more details.UserLabels map[string]string `json:"userLabels,omitempty"`// VisitorId: Required. 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. This should// be the same identifier as UserEvent.visitor_id. The field must be a UTF-8// encoded string with a length limit of 128 characters. Otherwise, an// INVALID_ARGUMENT error is returned.VisitorIdstring `json:"visitorId,omitempty"`// ForceSendFields is a list of field names (e.g. "Branch") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Branch") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchRequest: Request message forConversationalSearchService.ConversationalSearch method.

func (GoogleCloudRetailV2alphaConversationalSearchRequest)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpecadded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec struct {// ConversationalFilteringMode: Optional. Mode to control Conversational// Filtering. Defaults to Mode.DISABLED if it's unset.//// Possible values://   "MODE_UNSPECIFIED" - Default value.//   "DISABLED" - Disables Conversational Filtering when using Conversational// Search.//   "ENABLED" - Enables Conversational Filtering when using Conversational// Search.//   "CONVERSATIONAL_FILTER_ONLY" - Enables Conversational Filtering without// Conversational Search.ConversationalFilteringModestring `json:"conversationalFilteringMode,omitempty"`// EnableConversationalFiltering: Optional. This field is deprecated. Please// use ConversationalFilteringSpec.conversational_filtering_mode instead.EnableConversationalFilteringbool `json:"enableConversationalFiltering,omitempty"`// UserAnswer: Optional. This field specifies the current user answer during// the conversational filtering search. It can be either user selected from// suggested answers or user input plain text.UserAnswer *GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer `json:"userAnswer,omitempty"`// ForceSendFields is a list of field names (e.g.// "ConversationalFilteringMode") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConversationalFilteringMode") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec: This field specifies all conversational filtering related parametersaddition to conversational retail search.

func (GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaConversationalSearchRequestSearchParamsadded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams struct {// BoostSpec: Optional. The boost spec to specify the boosting of search// results. The syntax of the boost spec is the same as// SearchRequest.boost_spec.BoostSpec *GoogleCloudRetailV2alphaSearchRequestBoostSpec `json:"boostSpec,omitempty"`// CanonicalFilter: Optional. The canonical filter string to restrict search// results. The syntax of the canonical filter string is the same as// SearchRequest.canonical_filter.CanonicalFilterstring `json:"canonicalFilter,omitempty"`// Filter: Optional. The filter string to restrict search results. The syntax// of the filter string is the same as SearchRequest.filter.Filterstring `json:"filter,omitempty"`// SortBy: Optional. The sort string to specify the sorting of search results.// The syntax of the sort string is the same as SearchRequest.sort.SortBystring `json:"sortBy,omitempty"`// ForceSendFields is a list of field names (e.g. "BoostSpec") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BoostSpec") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams: Searchparameters.

func (GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaConversationalSearchRequestUserAnsweradded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer struct {// SelectedAnswer: Optional. This field specifies the selected answer during// the conversational search. This should be a subset of// ConversationalSearchResponse.followup_question.suggested_answers.SelectedAnswer *GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer `json:"selectedAnswer,omitempty"`// TextAnswer: This field specifies the incremental input text from the user// during the conversational search.TextAnswerstring `json:"textAnswer,omitempty"`// ForceSendFields is a list of field names (e.g. "SelectedAnswer") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SelectedAnswer") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer: This fieldspecifies the current user answer during the conversational filteringsearch. This can be either user selected from suggested answers or userinput plain text.

func (GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnsweradded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer struct {// ProductAttributeValue: Optional. This field specifies the selected answer// which is a attribute key-value.ProductAttributeValue *GoogleCloudRetailV2alphaProductAttributeValue `json:"productAttributeValue,omitempty"`// ForceSendFields is a list of field names (e.g. "ProductAttributeValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProductAttributeValue") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer:This field specifies the selected answers during the conversational search.

func (GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaConversationalSearchResponseadded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchResponse struct {// ConversationId: Conversation UUID. This field will be stored in client side// storage to maintain the conversation session with server and will be used// for next search request's ConversationalSearchRequest.conversation_id to// restore conversation state in server.ConversationIdstring `json:"conversationId,omitempty"`// ConversationalFilteringResult: This field specifies all related information// that is needed on client side for UI rendering of conversational filtering// search.ConversationalFilteringResult *GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult `json:"conversationalFilteringResult,omitempty"`// ConversationalTextResponse: The conversational answer-based text response// generated by the Server.ConversationalTextResponsestring `json:"conversationalTextResponse,omitempty"`// FollowupQuestion: The conversational followup question generated for Intent// refinement.FollowupQuestion *GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion `json:"followupQuestion,omitempty"`// RefinedSearch: The proposed refined search queries. They can be used to// fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY// mode, the refined_query from search response will be populated here.RefinedSearch []*GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch `json:"refinedSearch,omitempty"`// State: Output only. The state of the response generation.//// Possible values://   "STATE_UNSPECIFIED" - Unknown.//   "STREAMING" - Response generation is being streamed.//   "SUCCEEDED" - Response generation has succeeded.Statestring `json:"state,omitempty"`// UserQueryTypes: The types Retail classifies the search query as. Supported// values are: - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" -// "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" -// "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" -// "RETAIL_SUPPORT" - "DISABLED"UserQueryTypes []string `json:"userQueryTypes,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ConversationId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConversationId") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchResponse: Response message forConversationalSearchService.ConversationalSearch method.

func (GoogleCloudRetailV2alphaConversationalSearchResponse)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultadded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult struct {// AdditionalFilter: This is the incremental additional filters implied from// the current user answer. User should add the suggested addition filters to// the previous ConversationalSearchRequest.search_params.filter and// SearchRequest.filter, and use the merged filter in the follow up requests.AdditionalFilter *GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter `json:"additionalFilter,omitempty"`// FollowupQuestion: The conversational filtering question.FollowupQuestion *GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion `json:"followupQuestion,omitempty"`// ForceSendFields is a list of field names (e.g. "AdditionalFilter") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdditionalFilter") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult: This field specifies all related information that is needed on clientside for UI rendering of conversational filtering search.

func (GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilteradded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter struct {// ProductAttributeValue: Product attribute value, including an attribute key// and an attribute value. Other types can be added here in the future.ProductAttributeValue *GoogleCloudRetailV2alphaProductAttributeValue `json:"productAttributeValue,omitempty"`// ForceSendFields is a list of field names (e.g. "ProductAttributeValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProductAttributeValue") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter: Additional filter that client side need to apply.

func (GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionadded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion struct {// FollowupQuestion: The conversational followup question generated for Intent// refinement.FollowupQuestionstring `json:"followupQuestion,omitempty"`// SuggestedAnswers: The answer options provided to client for the follow-up// question.SuggestedAnswers []*GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer `json:"suggestedAnswers,omitempty"`// ForceSendFields is a list of field names (e.g. "FollowupQuestion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FollowupQuestion") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion: Theconversational followup question generated for Intent refinement.

func (GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnsweradded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer struct {// ProductAttributeValue: Product attribute value, including an attribute key// and an attribute value. Other types can be added here in the future.ProductAttributeValue *GoogleCloudRetailV2alphaProductAttributeValue `json:"productAttributeValue,omitempty"`// ForceSendFields is a list of field names (e.g. "ProductAttributeValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProductAttributeValue") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer: Suggested answers to the follow-up question. If it's numericalattribute, only ProductAttributeInterval will be set. If it's textualattribute, only productAttributeValue will be set.

func (GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearchadded inv0.227.0

type GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch struct {// Query: The query to be used for search.Querystring `json:"query,omitempty"`// ForceSendFields is a list of field names (e.g. "Query") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Query") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch: Theproposed refined search for intent-refinement/bundled shopping conversation.When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from searchresponse will be populated here.

func (GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch)MarshalJSONadded inv0.227.0

typeGoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadataadded inv0.115.0

type GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// UpdateTime: Operation last update time. If the operation is done, this is// also the finish time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata: Commonmetadata related to the progress of the operations.

func (GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata)MarshalJSONadded inv0.115.0

typeGoogleCloudRetailV2alphaCreateModelMetadataadded inv0.89.0

type GoogleCloudRetailV2alphaCreateModelMetadata struct {// Model: The resource name of the model that this create applies to. Format:// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/mode// ls/{model_id}`Modelstring `json:"model,omitempty"`// ForceSendFields is a list of field names (e.g. "Model") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Model") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCreateModelMetadata: Metadata associated with acreate operation.

func (GoogleCloudRetailV2alphaCreateModelMetadata)MarshalJSONadded inv0.89.0

typeGoogleCloudRetailV2alphaCustomAttribute

type GoogleCloudRetailV2alphaCustomAttribute struct {// Indexable: This field is normally ignored unless// AttributesConfig.attribute_config_level of the Catalog is set to the// deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about// product-level attribute configuration, see Configuration modes// (https://cloud.google.com/retail/docs/attribute-config#config-modes). If// true, custom attribute values are indexed, so that they can be filtered,// faceted or boosted in SearchService.Search. This field is ignored in a// UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and// SearchRequest.boost_spec for more details.Indexablebool `json:"indexable,omitempty"`// Numbers: The numerical values of this custom attribute. For example, `[2.3,// 15.4]` when the key is "lengths_cm". Exactly one of text or numbers should// be set. Otherwise, an INVALID_ARGUMENT error is returned.Numbers []float64 `json:"numbers,omitempty"`// Searchable: This field is normally ignored unless// AttributesConfig.attribute_config_level of the Catalog is set to the// deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about// product-level attribute configuration, see Configuration modes// (https://cloud.google.com/retail/docs/attribute-config#config-modes). If// true, custom attribute values are searchable by text queries in// SearchService.Search. This field is ignored in a UserEvent. Only set if type// text is set. Otherwise, a INVALID_ARGUMENT error is returned.Searchablebool `json:"searchable,omitempty"`// Text: The textual values of this custom attribute. For example, `["yellow",// "green"]` when the key is "color". Empty string is not allowed. Otherwise,// an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should// be set. Otherwise, an INVALID_ARGUMENT error is returned.Text []string `json:"text,omitempty"`// ForceSendFields is a list of field names (e.g. "Indexable") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Indexable") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaCustomAttribute: A custom attribute that is notexplicitly modeled in Product.

func (GoogleCloudRetailV2alphaCustomAttribute)MarshalJSON

func (*GoogleCloudRetailV2alphaCustomAttribute)UnmarshalJSONadded inv0.122.0

func (s *GoogleCloudRetailV2alphaCustomAttribute) UnmarshalJSON(data []byte)error

typeGoogleCloudRetailV2alphaDoubleListadded inv0.234.0

type GoogleCloudRetailV2alphaDoubleList struct {// Values: The list of double values.Values []float64 `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Values") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Values") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaDoubleList: A message with a list of double values.

func (GoogleCloudRetailV2alphaDoubleList)MarshalJSONadded inv0.234.0

func (*GoogleCloudRetailV2alphaDoubleList)UnmarshalJSONadded inv0.234.0

func (s *GoogleCloudRetailV2alphaDoubleList) UnmarshalJSON(data []byte)error

typeGoogleCloudRetailV2alphaEnrollSolutionMetadataadded inv0.58.0

type GoogleCloudRetailV2alphaEnrollSolutionMetadata struct {}

GoogleCloudRetailV2alphaEnrollSolutionMetadata: Metadata related to theEnrollSolution method. This will be returned by thegoogle.longrunning.Operation.metadata field.

typeGoogleCloudRetailV2alphaEnrollSolutionRequestadded inv0.131.0

type GoogleCloudRetailV2alphaEnrollSolutionRequest struct {// Solution: Required. Solution to enroll.//// Possible values://   "SOLUTION_TYPE_UNSPECIFIED" - Default value.//   "SOLUTION_TYPE_RECOMMENDATION" - Used for Recommendations AI.//   "SOLUTION_TYPE_SEARCH" - Used for Retail Search.Solutionstring `json:"solution,omitempty"`// ForceSendFields is a list of field names (e.g. "Solution") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Solution") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaEnrollSolutionRequest: Request for EnrollSolutionmethod.

func (GoogleCloudRetailV2alphaEnrollSolutionRequest)MarshalJSONadded inv0.131.0

typeGoogleCloudRetailV2alphaEnrollSolutionResponseadded inv0.131.0

type GoogleCloudRetailV2alphaEnrollSolutionResponse struct {// EnrolledSolution: Retail API solution that the project has enrolled.//// Possible values://   "SOLUTION_TYPE_UNSPECIFIED" - Default value.//   "SOLUTION_TYPE_RECOMMENDATION" - Used for Recommendations AI.//   "SOLUTION_TYPE_SEARCH" - Used for Retail Search.EnrolledSolutionstring `json:"enrolledSolution,omitempty"`// ForceSendFields is a list of field names (e.g. "EnrolledSolution") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EnrolledSolution") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaEnrollSolutionResponse: Response for EnrollSolutionmethod.

func (GoogleCloudRetailV2alphaEnrollSolutionResponse)MarshalJSONadded inv0.131.0

typeGoogleCloudRetailV2alphaExperimentInfoadded inv0.109.0

type GoogleCloudRetailV2alphaExperimentInfo struct {// Experiment: The fully qualified resource name of the experiment that// provides the serving config under test, should an active experiment exist.// For example:// `projects/*/locations/global/catalogs/default_catalog/experiments/experiment_// id`Experimentstring `json:"experiment,omitempty"`// ServingConfigExperiment: A/B test between existing Cloud Retail Search// ServingConfigs.ServingConfigExperiment *GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment `json:"servingConfigExperiment,omitempty"`// ForceSendFields is a list of field names (e.g. "Experiment") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Experiment") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaExperimentInfo: Metadata for active A/B testingexperiment.

func (GoogleCloudRetailV2alphaExperimentInfo)MarshalJSONadded inv0.109.0

typeGoogleCloudRetailV2alphaExperimentInfoServingConfigExperimentadded inv0.109.0

type GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment struct {// ExperimentServingConfig: The fully qualified resource name of the serving// config `Experiment.VariantArm.serving_config_id` responsible for generating// the search response. For example:// `projects/*/locations/*/catalogs/*/servingConfigs/*`.ExperimentServingConfigstring `json:"experimentServingConfig,omitempty"`// OriginalServingConfig: The fully qualified resource name of the original// SearchRequest.placement in the search request prior to reassignment by// experiment API. For example:// `projects/*/locations/*/catalogs/*/servingConfigs/*`.OriginalServingConfigstring `json:"originalServingConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "ExperimentServingConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExperimentServingConfig") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment: Metadata foractive serving config A/B tests.

func (GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment)MarshalJSONadded inv0.109.0

typeGoogleCloudRetailV2alphaExportAnalyticsMetricsRequestadded inv0.154.0

type GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest struct {// Filter: A filtering expression to specify restrictions on returned metrics.// The expression is a sequence of terms. Each term applies a restriction to// the returned metrics. Use this expression to restrict results to a specific// time range. Currently we expect only one types of fields: * `timestamp`:// This can be specified twice, once with a less than operator and once with a// greater than operator. The `timestamp` restriction should result in one,// contiguous, valid, `timestamp` range. Some examples of valid filters// expressions: * Example 1: `timestamp > "2012-04-23T18:25:43.511Z" timestamp// < "2012-04-23T18:30:43.511Z" * Example 2: `timestamp >// "2012-04-23T18:25:43.511Z"Filterstring `json:"filter,omitempty"`// OutputConfig: Required. The output location of the data.OutputConfig *GoogleCloudRetailV2alphaOutputConfig `json:"outputConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Filter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest: Request message forthe `ExportAnalyticsMetrics` method.

func (GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest)MarshalJSONadded inv0.154.0

typeGoogleCloudRetailV2alphaExportAnalyticsMetricsResponseadded inv0.154.0

type GoogleCloudRetailV2alphaExportAnalyticsMetricsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: This field is never set.ErrorsConfig *GoogleCloudRetailV2alphaExportErrorsConfig `json:"errorsConfig,omitempty"`// OutputResult: Output result indicating where the data were exported to.OutputResult *GoogleCloudRetailV2alphaOutputResult `json:"outputResult,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaExportAnalyticsMetricsResponse: Response of theExportAnalyticsMetricsRequest. If the long running operation was successful,then this message is returned by the google.longrunning.Operations.responsefield if the operation was successful.

func (GoogleCloudRetailV2alphaExportAnalyticsMetricsResponse)MarshalJSONadded inv0.154.0

typeGoogleCloudRetailV2alphaExportErrorsConfig

type GoogleCloudRetailV2alphaExportErrorsConfig struct {// GcsPrefix: Google Cloud Storage path for import errors. This must be an// empty, existing Cloud Storage bucket. Export errors will be written to a// file in this bucket, one per line, as a JSON-encoded `google.rpc.Status`// message.GcsPrefixstring `json:"gcsPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsPrefix") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaExportErrorsConfig: Configuration of destination forExport related errors.

func (GoogleCloudRetailV2alphaExportErrorsConfig)MarshalJSON

typeGoogleCloudRetailV2alphaExportMetadata

type GoogleCloudRetailV2alphaExportMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// UpdateTime: Operation last update time. If the operation is done, this is// also the finish time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaExportMetadata: Metadata related to the progress ofthe Export operation. This is returned by thegoogle.longrunning.Operation.metadata field.

func (GoogleCloudRetailV2alphaExportMetadata)MarshalJSON

typeGoogleCloudRetailV2alphaExportProductsRequestadded inv0.191.0

type GoogleCloudRetailV2alphaExportProductsRequest struct {// Filter: Deprecated: This field is deprecated. Any filter provided will be// ignored.Filterstring `json:"filter,omitempty"`// OutputConfig: Required. The output location of the data.OutputConfig *GoogleCloudRetailV2alphaOutputConfig `json:"outputConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Filter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaExportProductsRequest: Request message forExportProducts method.

func (GoogleCloudRetailV2alphaExportProductsRequest)MarshalJSONadded inv0.191.0

typeGoogleCloudRetailV2alphaExportProductsResponse

type GoogleCloudRetailV2alphaExportProductsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: This field is never set.ErrorsConfig *GoogleCloudRetailV2alphaExportErrorsConfig `json:"errorsConfig,omitempty"`// OutputResult: Output result indicating where the data were exported to.OutputResult *GoogleCloudRetailV2alphaOutputResult `json:"outputResult,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaExportProductsResponse: Response of theExportProductsRequest. If the long running operation is done, then thismessage is returned by the google.longrunning.Operations.response field ifthe operation was successful.

func (GoogleCloudRetailV2alphaExportProductsResponse)MarshalJSON

typeGoogleCloudRetailV2alphaExportUserEventsRequestadded inv0.190.0

type GoogleCloudRetailV2alphaExportUserEventsRequest struct {// Filter: Deprecated: This field is deprecated. Any filter provided will be// ignored.Filterstring `json:"filter,omitempty"`// OutputConfig: Required. The output location of the data.OutputConfig *GoogleCloudRetailV2alphaOutputConfig `json:"outputConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Filter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaExportUserEventsRequest: Request message for the`ExportUserEvents` method.

func (GoogleCloudRetailV2alphaExportUserEventsRequest)MarshalJSONadded inv0.190.0

typeGoogleCloudRetailV2alphaExportUserEventsResponse

type GoogleCloudRetailV2alphaExportUserEventsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: This field is never set.ErrorsConfig *GoogleCloudRetailV2alphaExportErrorsConfig `json:"errorsConfig,omitempty"`// OutputResult: Output result indicating where the data were exported to.OutputResult *GoogleCloudRetailV2alphaOutputResult `json:"outputResult,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaExportUserEventsResponse: Response of theExportUserEventsRequest. If the long running operation was successful, thenthis message is returned by the google.longrunning.Operations.response fieldif the operation was successful.

func (GoogleCloudRetailV2alphaExportUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2alphaFulfillmentInfoadded inv0.52.0

type GoogleCloudRetailV2alphaFulfillmentInfo struct {// PlaceIds: The IDs for this type, such as the store IDs for// FulfillmentInfo.type.pickup-in-store or the region IDs for// FulfillmentInfo.type.same-day-delivery. A maximum of 3000 values are// allowed. Each value must be a string with a length limit of 30 characters,// matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2".// Otherwise, an INVALID_ARGUMENT error is returned.PlaceIds []string `json:"placeIds,omitempty"`// Type: The fulfillment type, including commonly used types (such as pickup in// store and same day delivery), and custom types. Customers have to map custom// types to their display names before rendering UI. Supported values: *// "pickup-in-store" * "ship-to-store" * "same-day-delivery" *// "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" *// "custom-type-4" * "custom-type-5" If this field is set to an invalid value// other than these, an INVALID_ARGUMENT error is returned.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "PlaceIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PlaceIds") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaFulfillmentInfo: Fulfillment information, such asthe store IDs for in-store pickup or region IDs for different shippingmethods.

func (GoogleCloudRetailV2alphaFulfillmentInfo)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaGcsOutputResultadded inv0.101.0

type GoogleCloudRetailV2alphaGcsOutputResult struct {// OutputUri: The uri of Gcs outputOutputUristring `json:"outputUri,omitempty"`// ForceSendFields is a list of field names (e.g. "OutputUri") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "OutputUri") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaGcsOutputResult: A Gcs output result.

func (GoogleCloudRetailV2alphaGcsOutputResult)MarshalJSONadded inv0.101.0

typeGoogleCloudRetailV2alphaGcsSource

type GoogleCloudRetailV2alphaGcsSource struct {// DataSchema: The schema to use when parsing the data from the source.// Supported values for product imports: * `product` (default): One JSON// Product per line. Each product must have a valid Product.id. *// `product_merchant_center`: See Importing catalog data from Merchant Center// (https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc).// Supported values for user events imports: * `user_event` (default): One JSON// UserEvent per line. * `user_event_ga360`: Using//https://support.google.com/analytics/answer/3437719. Supported values for// control imports: * `control` (default): One JSON Control per line. Supported// values for catalog attribute imports: * `catalog_attribute` (default): One// CSV CatalogAttribute per line.DataSchemastring `json:"dataSchema,omitempty"`// InputUris: Required. Google Cloud Storage URIs to input files. URI can be up// to 2000 characters long. URIs can match the full object path (for example,// `gs://bucket/directory/object.json`) or a pattern matching one or more// files, such as `gs://bucket/directory/*.json`. A request can contain at most// 100 files, and each file can be up to 2 GB. See Importing product// information// (https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog) for// the expected file format and setup instructions.InputUris []string `json:"inputUris,omitempty"`// ForceSendFields is a list of field names (e.g. "DataSchema") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DataSchema") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaGcsSource: Google Cloud Storage location for inputcontent.

func (GoogleCloudRetailV2alphaGcsSource)MarshalJSON

func (sGoogleCloudRetailV2alphaGcsSource) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaGenerativeQuestionConfigadded inv0.199.0

type GoogleCloudRetailV2alphaGenerativeQuestionConfig struct {// AllowedInConversation: Optional. Whether the question is asked at serving// time.AllowedInConversationbool `json:"allowedInConversation,omitempty"`// Catalog: Required. Resource name of the catalog. Format:// projects/{project}/locations/{location}/catalogs/{catalog}Catalogstring `json:"catalog,omitempty"`// ExampleValues: Output only. Values that can be used to answer the question.ExampleValues []string `json:"exampleValues,omitempty"`// Facet: Required. The facet to which the question is associated.Facetstring `json:"facet,omitempty"`// FinalQuestion: Optional. The question that will be used at serving time.// Question can have a max length of 300 bytes. When not populated,// generated_question should be used.FinalQuestionstring `json:"finalQuestion,omitempty"`// Frequency: Output only. The ratio of how often a question was asked.Frequencyfloat64 `json:"frequency,omitempty"`// GeneratedQuestion: Output only. The LLM generated question.GeneratedQuestionstring `json:"generatedQuestion,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AllowedInConversation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowedInConversation") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaGenerativeQuestionConfig: Configuration for a singlegenerated question.

func (GoogleCloudRetailV2alphaGenerativeQuestionConfig)MarshalJSONadded inv0.199.0

func (*GoogleCloudRetailV2alphaGenerativeQuestionConfig)UnmarshalJSONadded inv0.199.0

typeGoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfigadded inv0.199.0

type GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig struct {// Catalog: Required. Resource name of the affected catalog. Format:// projects/{project}/locations/{location}/catalogs/{catalog}Catalogstring `json:"catalog,omitempty"`// FeatureEnabled: Optional. Determines whether questions will be used at// serving time. Note: This feature cannot be enabled until initial data// requirements are satisfied.FeatureEnabledbool `json:"featureEnabled,omitempty"`// MinimumProducts: Optional. Minimum number of products in the response to// trigger follow-up questions. Value must be 0 or positive.MinimumProductsint64 `json:"minimumProducts,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Catalog") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Catalog") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig: Configuration foroverall generative question feature state.

func (GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig)MarshalJSONadded inv0.199.0

typeGoogleCloudRetailV2alphaGetDefaultBranchResponseadded inv0.52.0

type GoogleCloudRetailV2alphaGetDefaultBranchResponse struct {// Branch: Full resource name of the branch id currently set as default branch.Branchstring `json:"branch,omitempty"`// Note: This corresponds to SetDefaultBranchRequest.note field, when this// branch was set as default.Notestring `json:"note,omitempty"`// SetTime: The time when this branch is set to default.SetTimestring `json:"setTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Branch") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Branch") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaGetDefaultBranchResponse: Response message ofCatalogService.GetDefaultBranch.

func (GoogleCloudRetailV2alphaGetDefaultBranchResponse)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaImage

type GoogleCloudRetailV2alphaImage struct {// Height: Height of the image in number of pixels. This field must be// nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.Heightint64 `json:"height,omitempty"`// Uri: Required. URI of the image. This field must be a valid UTF-8 encoded// URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT// error is returned. Google Merchant Center property image_link// (https://support.google.com/merchants/answer/6324350). Schema.org property// Product.image (https://schema.org/image).Uristring `json:"uri,omitempty"`// Width: Width of the image in number of pixels. This field must be// nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.Widthint64 `json:"width,omitempty"`// ForceSendFields is a list of field names (e.g. "Height") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Height") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaImage: Product image. Recommendations AI and RetailSearch use product images to improve prediction and search results. Productimages can be returned in results, and are shown in prediction or searchpreviews in the console. Please try to provide correct product images andavoid using images with size too small.

func (GoogleCloudRetailV2alphaImage)MarshalJSON

func (sGoogleCloudRetailV2alphaImage) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaImportCompletionDataRequestadded inv0.52.0

type GoogleCloudRetailV2alphaImportCompletionDataRequest struct {// InputConfig: Required. The desired input location of the data.InputConfig *GoogleCloudRetailV2alphaCompletionDataInputConfig `json:"inputConfig,omitempty"`// NotificationPubsubTopic: Pub/Sub topic for receiving notification. If this// field is set, when the import is finished, a notification is sent to// specified Pub/Sub topic. The message data is JSON string of a Operation.// Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.NotificationPubsubTopicstring `json:"notificationPubsubTopic,omitempty"`// ForceSendFields is a list of field names (e.g. "InputConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InputConfig") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaImportCompletionDataRequest: Request message forImportCompletionData methods.

func (GoogleCloudRetailV2alphaImportCompletionDataRequest)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaImportCompletionDataResponseadded inv0.52.0

type GoogleCloudRetailV2alphaImportCompletionDataResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaImportCompletionDataResponse: Response of theImportCompletionDataRequest. If the long running operation is done, thismessage is returned by the google.longrunning.Operations.response field ifthe operation is successful.

func (GoogleCloudRetailV2alphaImportCompletionDataResponse)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaImportErrorsConfig

type GoogleCloudRetailV2alphaImportErrorsConfig struct {// GcsPrefix: Google Cloud Storage prefix for import errors. This must be an// empty, existing Cloud Storage directory. Import errors are written to// sharded files in this directory, one per line, as a JSON-encoded// `google.rpc.Status` message.GcsPrefixstring `json:"gcsPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsPrefix") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaImportErrorsConfig: Configuration of destination forImport related errors.

func (GoogleCloudRetailV2alphaImportErrorsConfig)MarshalJSON

typeGoogleCloudRetailV2alphaImportMetadata

type GoogleCloudRetailV2alphaImportMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// FailureCount: Count of entries that encountered errors while processing.FailureCountint64 `json:"failureCount,omitempty,string"`// NotificationPubsubTopic: Pub/Sub topic for receiving notification. If this// field is set, when the import is finished, a notification is sent to// specified Pub/Sub topic. The message data is JSON string of a Operation.// Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.NotificationPubsubTopicstring `json:"notificationPubsubTopic,omitempty"`// RequestId: Deprecated. This field is never set.RequestIdstring `json:"requestId,omitempty"`// SuccessCount: Count of entries that were processed successfully.SuccessCountint64 `json:"successCount,omitempty,string"`// TransformedUserEventsMetadata: Metadata related to transform user events.TransformedUserEventsMetadata *GoogleCloudRetailV2alphaTransformedUserEventsMetadata `json:"transformedUserEventsMetadata,omitempty"`// UpdateTime: Operation last update time. If the operation is done, this is// also the finish time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaImportMetadata: Metadata related to the progress ofthe Import operation. This is returned by thegoogle.longrunning.Operation.metadata field.

func (GoogleCloudRetailV2alphaImportMetadata)MarshalJSON

typeGoogleCloudRetailV2alphaImportProductsRequest

type GoogleCloudRetailV2alphaImportProductsRequest struct {// ErrorsConfig: The desired location of errors incurred during the Import.ErrorsConfig *GoogleCloudRetailV2alphaImportErrorsConfig `json:"errorsConfig,omitempty"`// InputConfig: Required. The desired input location of the data.InputConfig *GoogleCloudRetailV2alphaProductInputConfig `json:"inputConfig,omitempty"`// NotificationPubsubTopic: Full Pub/Sub topic name for receiving notification.// If this field is set, when the import is finished, a notification is sent to// specified Pub/Sub topic. The message data is JSON string of a Operation.// Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has// to be within the same project as ImportProductsRequest.parent. Make sure// that both `cloud-retail-customer-data-access@system.gserviceaccount.com` and// `service-@gcp-sa-retail.iam.gserviceaccount.com` have the// `pubsub.topics.publish` IAM permission on the topic. Only supported when// ImportProductsRequest.reconciliation_mode is set to `FULL`.NotificationPubsubTopicstring `json:"notificationPubsubTopic,omitempty"`// ReconciliationMode: The mode of reconciliation between existing products and// the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.//// Possible values://   "RECONCILIATION_MODE_UNSPECIFIED" - Defaults to INCREMENTAL.//   "INCREMENTAL" - Inserts new products or updates existing products.//   "FULL" - Calculates diff and replaces the entire product dataset. Existing// products may be deleted if they are not present in the source location.ReconciliationModestring `json:"reconciliationMode,omitempty"`// RequestId: Deprecated. This field has no effect.RequestIdstring `json:"requestId,omitempty"`// SkipDefaultBranchProtection: If true, this performs the FULL import even if// it would delete a large proportion of the products in the default branch,// which could potentially cause outages if you have live predict/search// traffic. Only supported when ImportProductsRequest.reconciliation_mode is// set to `FULL`.SkipDefaultBranchProtectionbool `json:"skipDefaultBranchProtection,omitempty"`// UpdateMask: Indicates which fields in the provided imported `products` to// update. If not set, all fields are updated. If provided, only the existing// product fields are updated. Missing products will not be created.UpdateMaskstring `json:"updateMask,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorsConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorsConfig") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaImportProductsRequest: Request message for Importmethods.

func (GoogleCloudRetailV2alphaImportProductsRequest)MarshalJSON

typeGoogleCloudRetailV2alphaImportProductsResponse

type GoogleCloudRetailV2alphaImportProductsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: Echoes the destination for the complete errors in the request// if set.ErrorsConfig *GoogleCloudRetailV2alphaImportErrorsConfig `json:"errorsConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaImportProductsResponse: Response of theImportProductsRequest. If the long running operation is done, then thismessage is returned by the google.longrunning.Operations.response field ifthe operation was successful.

func (GoogleCloudRetailV2alphaImportProductsResponse)MarshalJSON

typeGoogleCloudRetailV2alphaImportUserEventsRequest

type GoogleCloudRetailV2alphaImportUserEventsRequest struct {// ErrorsConfig: The desired location of errors incurred during the Import.// Cannot be set for inline user event imports.ErrorsConfig *GoogleCloudRetailV2alphaImportErrorsConfig `json:"errorsConfig,omitempty"`// InputConfig: Required. The desired input location of the data.InputConfig *GoogleCloudRetailV2alphaUserEventInputConfig `json:"inputConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorsConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorsConfig") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaImportUserEventsRequest: Request message for theImportUserEvents request.

func (GoogleCloudRetailV2alphaImportUserEventsRequest)MarshalJSON

typeGoogleCloudRetailV2alphaImportUserEventsResponse

type GoogleCloudRetailV2alphaImportUserEventsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: Echoes the destination for the complete errors if this field// was set in the request.ErrorsConfig *GoogleCloudRetailV2alphaImportErrorsConfig `json:"errorsConfig,omitempty"`// ImportSummary: Aggregated statistics of user event import status.ImportSummary *GoogleCloudRetailV2alphaUserEventImportSummary `json:"importSummary,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaImportUserEventsResponse: Response of theImportUserEventsRequest. If the long running operation was successful, thenthis message is returned by the google.longrunning.Operations.response fieldif the operation was successful.

func (GoogleCloudRetailV2alphaImportUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2alphaIntentClassificationConfigadded inv0.239.0

type GoogleCloudRetailV2alphaIntentClassificationConfig struct {// BlocklistKeywords: Optional. A list of keywords that will be used to// classify the query to the "BLOCKLISTED" intent type. The keywords are case// insensitive.BlocklistKeywords []string `json:"blocklistKeywords,omitempty"`// DisabledIntentTypes: Optional. A list of intent types that will be disabled// for this customer. The intent types must match one of the predefined intent// types defined at//https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytypeDisabledIntentTypes []string `json:"disabledIntentTypes,omitempty"`// Example: Optional. A list of examples for intent classification.Example []*GoogleCloudRetailV2alphaIntentClassificationConfigExample `json:"example,omitempty"`// InlineSource: Optional. Inline source for intent classifications.InlineSource *GoogleCloudRetailV2alphaIntentClassificationConfigInlineSource `json:"inlineSource,omitempty"`// ModelPreamble: Optional. Customers can use the preamble to specify any// requirements for blocklisting intent classification. This preamble will be// added to the blocklisting intent classification model prompt.ModelPreamblestring `json:"modelPreamble,omitempty"`// ForceSendFields is a list of field names (e.g. "BlocklistKeywords") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BlocklistKeywords") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaIntentClassificationConfig: The public proto torepresent the intent classification config. It will be converted to theinternal proto in the backend.

func (GoogleCloudRetailV2alphaIntentClassificationConfig)MarshalJSONadded inv0.239.0

typeGoogleCloudRetailV2alphaIntentClassificationConfigExampleadded inv0.239.0

type GoogleCloudRetailV2alphaIntentClassificationConfigExample struct {// ClassifiedPositive: Required. Whether the example is classified positively.ClassifiedPositivebool `json:"classifiedPositive,omitempty"`// IntentType: Optional. The intent_type must match one of the predefined// intent types defined at//https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytypeIntentTypestring `json:"intentType,omitempty"`// Query: Required. Example query.Querystring `json:"query,omitempty"`// Reason: Optional. The reason for the intent classification. This is used to// explain the intent classification decision.Reasonstring `json:"reason,omitempty"`// ForceSendFields is a list of field names (e.g. "ClassifiedPositive") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ClassifiedPositive") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaIntentClassificationConfigExample: An example forintent classification.

func (GoogleCloudRetailV2alphaIntentClassificationConfigExample)MarshalJSONadded inv0.239.0

typeGoogleCloudRetailV2alphaIntentClassificationConfigInlineForceIntentadded inv0.240.0

type GoogleCloudRetailV2alphaIntentClassificationConfigInlineForceIntent struct {// IntentType: Optional. The intent_type must match one of the predefined// intent types defined at//https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytypeIntentTypestring `json:"intentType,omitempty"`// Operation: Optional. The operation to perform for the query.//// Possible values://   "OPERATION_UNSPECIFIED" - Unspecified match operation.//   "EXACT_MATCH" - Exact match.//   "CONTAINS" - Contains match.Operationstring `json:"operation,omitempty"`// Query: Optional. A example query.Querystring `json:"query,omitempty"`// ForceSendFields is a list of field names (e.g. "IntentType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IntentType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaIntentClassificationConfigInlineForceIntent: Aninline force intent classification configuration.

func (GoogleCloudRetailV2alphaIntentClassificationConfigInlineForceIntent)MarshalJSONadded inv0.240.0

typeGoogleCloudRetailV2alphaIntentClassificationConfigInlineSourceadded inv0.240.0

type GoogleCloudRetailV2alphaIntentClassificationConfigInlineSource struct {// InlineForceIntents: Optional. A list of inline force intent classifications.InlineForceIntents []*GoogleCloudRetailV2alphaIntentClassificationConfigInlineForceIntent `json:"inlineForceIntents,omitempty"`// ForceSendFields is a list of field names (e.g. "InlineForceIntents") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InlineForceIntents") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaIntentClassificationConfigInlineSource: Inlinesource for intent classifications.

func (GoogleCloudRetailV2alphaIntentClassificationConfigInlineSource)MarshalJSONadded inv0.240.0

typeGoogleCloudRetailV2alphaIntervaladded inv0.52.0

type GoogleCloudRetailV2alphaInterval struct {// ExclusiveMaximum: Exclusive upper bound.ExclusiveMaximumfloat64 `json:"exclusiveMaximum,omitempty"`// ExclusiveMinimum: Exclusive lower bound.ExclusiveMinimumfloat64 `json:"exclusiveMinimum,omitempty"`// Maximum: Inclusive upper bound.Maximumfloat64 `json:"maximum,omitempty"`// Minimum: Inclusive lower bound.Minimumfloat64 `json:"minimum,omitempty"`// ForceSendFields is a list of field names (e.g. "ExclusiveMaximum") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExclusiveMaximum") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaInterval: A floating point interval.

func (GoogleCloudRetailV2alphaInterval)MarshalJSONadded inv0.52.0

func (sGoogleCloudRetailV2alphaInterval) MarshalJSON() ([]byte,error)

func (*GoogleCloudRetailV2alphaInterval)UnmarshalJSONadded inv0.52.0

func (s *GoogleCloudRetailV2alphaInterval) UnmarshalJSON(data []byte)error

typeGoogleCloudRetailV2alphaListBranchesResponseadded inv0.177.0

type GoogleCloudRetailV2alphaListBranchesResponse struct {// Branches: The Branches.Branches []*GoogleCloudRetailV2alphaBranch `json:"branches,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Branches") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Branches") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaListBranchesResponse: Response forBranchService.ListBranches method.

func (GoogleCloudRetailV2alphaListBranchesResponse)MarshalJSONadded inv0.177.0

typeGoogleCloudRetailV2alphaListCatalogsResponse

type GoogleCloudRetailV2alphaListCatalogsResponse struct {// Catalogs: All the customer's Catalogs.Catalogs []*GoogleCloudRetailV2alphaCatalog `json:"catalogs,omitempty"`// NextPageToken: A token that can be sent as ListCatalogsRequest.page_token to// retrieve the next page. If this field is omitted, there are no subsequent// pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Catalogs") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Catalogs") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaListCatalogsResponse: Response forCatalogService.ListCatalogs method.

func (GoogleCloudRetailV2alphaListCatalogsResponse)MarshalJSON

typeGoogleCloudRetailV2alphaListControlsResponseadded inv0.66.0

type GoogleCloudRetailV2alphaListControlsResponse struct {// Controls: All the Controls for a given catalog.Controls []*GoogleCloudRetailV2alphaControl `json:"controls,omitempty"`// NextPageToken: Pagination token, if not returned indicates the last page.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Controls") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Controls") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaListControlsResponse: Response for ListControlsmethod.

func (GoogleCloudRetailV2alphaListControlsResponse)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaListEnrolledSolutionsResponseadded inv0.131.0

type GoogleCloudRetailV2alphaListEnrolledSolutionsResponse struct {// EnrolledSolutions: Retail API solutions that the project has enrolled.//// Possible values://   "SOLUTION_TYPE_UNSPECIFIED" - Default value.//   "SOLUTION_TYPE_RECOMMENDATION" - Used for Recommendations AI.//   "SOLUTION_TYPE_SEARCH" - Used for Retail Search.EnrolledSolutions []string `json:"enrolledSolutions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "EnrolledSolutions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EnrolledSolutions") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaListEnrolledSolutionsResponse: Response forListEnrolledSolutions method.

func (GoogleCloudRetailV2alphaListEnrolledSolutionsResponse)MarshalJSONadded inv0.131.0

typeGoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponseadded inv0.199.0

type GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse struct {// GenerativeQuestionConfigs: All the questions for a given catalog.GenerativeQuestionConfigs []*GoogleCloudRetailV2alphaGenerativeQuestionConfig `json:"generativeQuestionConfigs,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "GenerativeQuestionConfigs")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GenerativeQuestionConfigs") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse: Response forListQuestions method.

func (GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse)MarshalJSONadded inv0.199.0

typeGoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponseadded inv0.115.0

type GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse struct {// MerchantCenterAccountLinks: The links.MerchantCenterAccountLinks []*GoogleCloudRetailV2alphaMerchantCenterAccountLink `json:"merchantCenterAccountLinks,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "MerchantCenterAccountLinks")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MerchantCenterAccountLinks") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse: Response forMerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method.

func (GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse)MarshalJSONadded inv0.115.0

typeGoogleCloudRetailV2alphaListModelsResponseadded inv0.89.0

type GoogleCloudRetailV2alphaListModelsResponse struct {// Models: List of Models.Models []*GoogleCloudRetailV2alphaModel `json:"models,omitempty"`// NextPageToken: Pagination token, if not returned indicates the last page.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Models") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Models") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaListModelsResponse: Response to a ListModelRequest.

func (GoogleCloudRetailV2alphaListModelsResponse)MarshalJSONadded inv0.89.0

typeGoogleCloudRetailV2alphaListProductsResponseadded inv0.52.0

type GoogleCloudRetailV2alphaListProductsResponse struct {// NextPageToken: A token that can be sent as ListProductsRequest.page_token to// retrieve the next page. If this field is omitted, there are no subsequent// pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// Products: The Products.Products []*GoogleCloudRetailV2alphaProduct `json:"products,omitempty"`// TotalSize: The total count of matched Products irrespective of pagination.// The total number of Products returned by pagination may be less than the// total_size that matches. This field is ignored if// ListProductsRequest.require_total_size is not set or// ListProductsRequest.page_token is not empty.TotalSizeint64 `json:"totalSize,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaListProductsResponse: Response message forProductService.ListProducts method.

func (GoogleCloudRetailV2alphaListProductsResponse)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaListServingConfigsResponseadded inv0.66.0

type GoogleCloudRetailV2alphaListServingConfigsResponse struct {// NextPageToken: Pagination token, if not returned indicates the last page.NextPageTokenstring `json:"nextPageToken,omitempty"`// ServingConfigs: All the ServingConfigs for a given catalog.ServingConfigs []*GoogleCloudRetailV2alphaServingConfig `json:"servingConfigs,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaListServingConfigsResponse: Response forListServingConfigs method.

func (GoogleCloudRetailV2alphaListServingConfigsResponse)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaLocalInventoryadded inv0.61.0

type GoogleCloudRetailV2alphaLocalInventory struct {// Attributes: Optional. Additional local inventory attributes, for example,// store name, promotion tags, etc. This field needs to pass all below// criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30// attributes are allowed. * The key must be a UTF-8 encoded string with a// length limit of 32 characters. * The key must match the pattern:// `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute// values must be of the same type (text or number). * Only 1 value is allowed// for each attribute. * For text values, the length limit is 256 UTF-8// characters. * The attribute does not support search. The `searchable` field// should be unset or set to false. * The max summed total bytes of custom// attribute keys and values per product is 5MiB.Attributes map[string]GoogleCloudRetailV2alphaCustomAttribute `json:"attributes,omitempty"`// Availability: Optional. The availability of the Product at this place_id.// Default to Availability.IN_STOCK. For primary products with variants set the// availability of the primary as Availability.OUT_OF_STOCK and set the true// availability at the variant level. This way the primary product will be// considered "in stock" as long as it has at least one variant in stock. For// primary products with no variants set the true availability at the primary// level. Corresponding properties: Google Merchant Center property// availability (https://support.google.com/merchants/answer/6324448).// Schema.org property Offer.availability (https://schema.org/availability).// This field is currently only used by the Recommendations API. For Search,// please make use of fulfillment_types or custom attributes for similar// behaviour. See here (//https://cloud.google.com/retail/docs/local-inventory-updates#local-inventory-update-methods)// for more details.//// Possible values://   "AVAILABILITY_UNSPECIFIED" - Default product availability. Default to// Availability.IN_STOCK if unset.//   "IN_STOCK" - Product in stock.//   "OUT_OF_STOCK" - Product out of stock.//   "PREORDER" - Product that is in pre-order state.//   "BACKORDER" - Product that is back-ordered (i.e. temporarily out of// stock).Availabilitystring `json:"availability,omitempty"`// FulfillmentTypes: Optional. Supported fulfillment types. Valid fulfillment// type values include commonly used types (such as pickup in store and same// day delivery), and custom types. Customers have to map custom types to their// display names before rendering UI. Supported values: * "pickup-in-store" *// "ship-to-store" * "same-day-delivery" * "next-day-delivery" *// "custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" *// "custom-type-5" If this field is set to an invalid value other than these,// an INVALID_ARGUMENT error is returned. All the elements must be distinct.// Otherwise, an INVALID_ARGUMENT error is returned.FulfillmentTypes []string `json:"fulfillmentTypes,omitempty"`// PlaceId: Optional. The place ID for the current set of inventory// information.PlaceIdstring `json:"placeId,omitempty"`// PriceInfo: Optional. Product price and cost information. Google Merchant// Center property price (https://support.google.com/merchants/answer/6324371).PriceInfo *GoogleCloudRetailV2alphaPriceInfo `json:"priceInfo,omitempty"`// ForceSendFields is a list of field names (e.g. "Attributes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Attributes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaLocalInventory: The inventory information at a place(e.g. a store) identified by a place ID.

func (GoogleCloudRetailV2alphaLocalInventory)MarshalJSONadded inv0.61.0

typeGoogleCloudRetailV2alphaLoggingConfigadded inv0.147.0

type GoogleCloudRetailV2alphaLoggingConfig struct {// DefaultLogGenerationRule: The log generation rule that applies by default to// all services supporting log generation. It can be overridden by// ServiceLogGenerationRule for service level control.DefaultLogGenerationRule *GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule `json:"defaultLogGenerationRule,omitempty"`// Name: Required. Immutable. The name of the LoggingConfig singleton resource.// Format: projects/*/loggingConfigNamestring `json:"name,omitempty"`// ServiceLogGenerationRules: Controls logging configurations more granularly// for each supported service. This overrides the default_log_generation_rule// for the services specified. For those not mentioned, they will fallback to// the default log generation rule.ServiceLogGenerationRules []*GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule `json:"serviceLogGenerationRules,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DefaultLogGenerationRule")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DefaultLogGenerationRule") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaLoggingConfig: Project level logging config tocontrol what level of log will be generated and written to Cloud Logging.

func (GoogleCloudRetailV2alphaLoggingConfig)MarshalJSONadded inv0.147.0

typeGoogleCloudRetailV2alphaLoggingConfigLogGenerationRuleadded inv0.147.0

type GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule struct {// InfoLogSampleRate: The log sample rate for INFO level log entries. You can// use this to reduce the number of entries generated for INFO level logs. DO// NOT set this field if the logging_level is not LoggingLevel.LOG_ALL.// Otherwise, an INVALID_ARGUMENT error is returned. Sample rate for INFO logs// defaults to 1 when unset (generate and send all INFO logs to Cloud Logging).// Its value must be greater than 0 and less than or equal to 1.InfoLogSampleRatefloat64 `json:"infoLogSampleRate,omitempty"`// LoggingLevel: The logging level. By default it is set to// `LOG_WARNINGS_AND_ABOVE`.//// Possible values://   "LOGGING_LEVEL_UNSPECIFIED" - Default value. Defaults to// `LOG_FOR_WARNINGS_AND_ABOVE` if unset.//   "LOGGING_DISABLED" - No log will be generated and sent to Cloud Logging.//   "LOG_ERRORS_AND_ABOVE" - Log for operations resulted in fatal error.//   "LOG_WARNINGS_AND_ABOVE" - In addition to `LOG_ERRORS_AND_ABOVE`, also log// for operations that have soft errors, quality suggestions.//   "LOG_ALL" - Log all operations, including successful ones.LoggingLevelstring `json:"loggingLevel,omitempty"`// ForceSendFields is a list of field names (e.g. "InfoLogSampleRate") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InfoLogSampleRate") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule: The loggingconfigurations for services supporting log generation.

func (GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule)MarshalJSONadded inv0.147.0

func (*GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule)UnmarshalJSONadded inv0.147.0

typeGoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRuleadded inv0.147.0

type GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule struct {// LogGenerationRule: The log generation rule that applies to this service.LogGenerationRule *GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule `json:"logGenerationRule,omitempty"`// ServiceName: Required. Supported service names: "CatalogService",// "CompletionService", "ControlService", "MerchantCenterStreaming",// "ModelService", "PredictionService", "ProductService",// "ServingConfigService", "UserEventService",ServiceNamestring `json:"serviceName,omitempty"`// ForceSendFields is a list of field names (e.g. "LogGenerationRule") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LogGenerationRule") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule: The granularlogging configurations for supported services.

func (GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule)MarshalJSONadded inv0.147.0

typeGoogleCloudRetailV2alphaMerchantCenterAccountLinkadded inv0.115.0

type GoogleCloudRetailV2alphaMerchantCenterAccountLink struct {// BranchId: Required. The branch ID (e.g. 0/1/2) within the catalog that// products from merchant_center_account_id are streamed to. When updating this// field, an empty value will use the currently configured default branch.// However, changing the default branch later on won't change the linked branch// here. A single branch ID can only have one linked Merchant Center account// ID.BranchIdstring `json:"branchId,omitempty"`// FeedFilters: Criteria for the Merchant Center feeds to be ingested via the// link. All offers will be ingested if the list is empty. Otherwise the offers// will be ingested from selected feeds.FeedFilters []*GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter `json:"feedFilters,omitempty"`// FeedLabel: The FeedLabel used to perform filtering. Note: this replaces// region_id// (https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.feed_label).// Example value: `US`. Example value: `FeedLabel1`.FeedLabelstring `json:"feedLabel,omitempty"`// Id: Output only. Immutable. MerchantCenterAccountLink identifier, which is// the final component of name. This field is auto generated and follows the// convention: `BranchId_MerchantCenterAccountId`.// `projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLi// nks/id_1`.Idstring `json:"id,omitempty"`// LanguageCode: Language of the title/description and other string attributes.// Use language tags defined by BCP 47// (https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO 639-1. This specifies// the language of offers in Merchant Center that will be accepted. If empty,// no language filtering will be performed. Example value: `en`.LanguageCodestring `json:"languageCode,omitempty"`// MerchantCenterAccountId: Required. The linked Merchant center account id// (https://developers.google.com/shopping-content/guides/accountstatuses). The// account must be a standalone account or a sub-account of a MCA.MerchantCenterAccountIdint64 `json:"merchantCenterAccountId,omitempty,string"`// Name: Output only. Immutable. Full resource name of the Merchant Center// Account Link, such as// `projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLi// nks/merchant_center_account_link`.Namestring `json:"name,omitempty"`// ProjectId: Output only. Google Cloud project ID.ProjectIdstring `json:"projectId,omitempty"`// Source: Optional. An optional arbitrary string that could be used as a tag// for tracking link source.Sourcestring `json:"source,omitempty"`// State: Output only. Represents the state of the link.//// Possible values://   "STATE_UNSPECIFIED" - Default value.//   "PENDING" - Link is created and LRO is not complete.//   "ACTIVE" - Link is active.//   "FAILED" - Link creation failed.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "BranchId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BranchId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaMerchantCenterAccountLink: Represents a link betweena Merchant Center account and a branch. After a link is established,products from the linked Merchant Center account are streamed to the linkedbranch.

func (GoogleCloudRetailV2alphaMerchantCenterAccountLink)MarshalJSONadded inv0.115.0

typeGoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilteradded inv0.115.0

type GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter struct {// DataSourceId: AFM data source ID.DataSourceIdint64 `json:"dataSourceId,omitempty,string"`// PrimaryFeedId: Merchant Center primary feed ID. Deprecated: use// data_source_id instead.PrimaryFeedIdint64 `json:"primaryFeedId,omitempty,string"`// PrimaryFeedName: Merchant Center primary feed name. The name is used for the// display purposes only.PrimaryFeedNamestring `json:"primaryFeedName,omitempty"`// ForceSendFields is a list of field names (e.g. "DataSourceId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DataSourceId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter:Merchant Center Feed filter criterion.

func (GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter)MarshalJSONadded inv0.115.0

typeGoogleCloudRetailV2alphaMerchantCenterFeedFilteradded inv0.98.0

type GoogleCloudRetailV2alphaMerchantCenterFeedFilter struct {// DataSourceId: AFM data source ID.DataSourceIdint64 `json:"dataSourceId,omitempty,string"`// PrimaryFeedId: Merchant Center primary feed ID. Deprecated: use// data_source_id instead.PrimaryFeedIdint64 `json:"primaryFeedId,omitempty,string"`// PrimaryFeedName: Merchant Center primary feed name. The name is used for the// display purposes only.PrimaryFeedNamestring `json:"primaryFeedName,omitempty"`// ForceSendFields is a list of field names (e.g. "DataSourceId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DataSourceId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaMerchantCenterFeedFilter: Merchant Center Feedfilter criterion.

func (GoogleCloudRetailV2alphaMerchantCenterFeedFilter)MarshalJSONadded inv0.98.0

typeGoogleCloudRetailV2alphaMerchantCenterLinkadded inv0.52.0

type GoogleCloudRetailV2alphaMerchantCenterLink struct {// BranchId: The branch ID (e.g. 0/1/2) within this catalog that products from// merchant_center_account_id are streamed to. When updating this field, an// empty value will use the currently configured default branch. However,// changing the default branch later on won't change the linked branch here. A// single branch ID can only have one linked Merchant Center account ID.BranchIdstring `json:"branchId,omitempty"`// Destinations: String representing the destination to import for, all if left// empty. List of possible values is given in Included destination// (https://support.google.com/merchants/answer/7501026). List of allowed// string values: "Shopping_ads", "Buy_on_google_listings", "Display_ads",// "Local_inventory _ads", "Free_listings", "Free_local_listings" NOTE: The// string values are case sensitive.Destinations []string `json:"destinations,omitempty"`// Feeds: Criteria for the Merchant Center feeds to be ingested via the link.// All offers will be ingested if the list is empty. Otherwise the offers will// be ingested from selected feeds.Feeds []*GoogleCloudRetailV2alphaMerchantCenterFeedFilter `json:"feeds,omitempty"`// LanguageCode: Language of the title/description and other string attributes.// Use language tags defined by BCP 47// (https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO 639-1. This specifies// the language of offers in Merchant Center that will be accepted. If empty no// language filtering will be performed. Example value: `en`.LanguageCodestring `json:"languageCode,omitempty"`// MerchantCenterAccountId: Required. The linked Merchant Center account ID// (https://developers.google.com/shopping-content/guides/accountstatuses). The// account must be a standalone account or a sub-account of a MCA.MerchantCenterAccountIdint64 `json:"merchantCenterAccountId,omitempty,string"`// RegionCode: Region code of offers to accept. 2-letter Uppercase ISO 3166-1// alpha-2 code. List of values can be found here// (https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry)// under the `region` tag. If left blank no region filtering will be performed.// Example value: `US`.RegionCodestring `json:"regionCode,omitempty"`// ForceSendFields is a list of field names (e.g. "BranchId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BranchId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaMerchantCenterLink: Represents a link between aMerchant Center account and a branch. After a link is established, productsfrom the linked Merchant Center account are streamed to the linked branch.

func (GoogleCloudRetailV2alphaMerchantCenterLink)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaMerchantCenterLinkingConfigadded inv0.52.0

type GoogleCloudRetailV2alphaMerchantCenterLinkingConfig struct {// Links: Links between Merchant Center accounts and branches.Links []*GoogleCloudRetailV2alphaMerchantCenterLink `json:"links,omitempty"`// ForceSendFields is a list of field names (e.g. "Links") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Links") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaMerchantCenterLinkingConfig: Configures MerchantCenter linking. Links contained in the config will be used to sync data froma Merchant Center account to a Cloud Retail branch.

func (GoogleCloudRetailV2alphaMerchantCenterLinkingConfig)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaModeladded inv0.89.0

type GoogleCloudRetailV2alphaModel struct {// CreateTime: Output only. Timestamp the Recommendation Model was created at.CreateTimestring `json:"createTime,omitempty"`// DataState: Output only. The state of data requirements for this model:// `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the// data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR`// state even if serving state is `ACTIVE`: models were trained successfully// before, but cannot be refreshed because model no longer has sufficient data// for training.//// Possible values://   "DATA_STATE_UNSPECIFIED" - Unspecified default value, should never be// explicitly set.//   "DATA_OK" - The model has sufficient training data.//   "DATA_ERROR" - The model does not have sufficient training data. Error// messages can be queried via Stackdriver.DataStatestring `json:"dataState,omitempty"`// DisplayName: Required. The display name of the model. Should be human// readable, used to display Recommendation Models in the Retail Cloud Console// Dashboard. UTF-8 encoded string with limit of 1024 characters.DisplayNamestring `json:"displayName,omitempty"`// FilteringOption: Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`,// recommendation filtering by attributes is enabled for the model.//// Possible values://   "RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED" - Value used when unset. In// this case, server behavior defaults to RECOMMENDATIONS_FILTERING_DISABLED.//   "RECOMMENDATIONS_FILTERING_DISABLED" - Recommendation filtering is// disabled.//   "RECOMMENDATIONS_FILTERING_ENABLED" - Recommendation filtering is enabled.FilteringOptionstring `json:"filteringOption,omitempty"`// LastTuneTime: Output only. The timestamp when the latest successful tune// finished.LastTuneTimestring `json:"lastTuneTime,omitempty"`// ModelFeaturesConfig: Optional. Additional model features config.ModelFeaturesConfig *GoogleCloudRetailV2alphaModelModelFeaturesConfig `json:"modelFeaturesConfig,omitempty"`// Name: Required. The fully qualified resource name of the model. Format:// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/mode// ls/{model_id}` catalog_id has char limit of 50. recommendation_model_id has// char limit of 40.Namestring `json:"name,omitempty"`// OptimizationObjective: Optional. The optimization objective e.g. `cvr`.// Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not// specified, we choose default based on model type. Default depends on type of// recommendation: `recommended-for-you` => `ctr` `others-you-may-like` =>// `ctr` `frequently-bought-together` => `revenue_per_order` This field// together with optimization_objective describe model metadata to use to// control model training and serving. See//https://cloud.google.com/retail/docs/models for more details on what the// model metadata control and which combination of parameters are valid. For// invalid combinations of parameters (e.g. type = `frequently-bought-together`// and optimization_objective = `ctr`), you receive an error 400 if you try to// create/update a recommendation with this set of knobs.OptimizationObjectivestring `json:"optimizationObjective,omitempty"`// PageOptimizationConfig: Optional. The page optimization config.PageOptimizationConfig *GoogleCloudRetailV2alphaModelPageOptimizationConfig `json:"pageOptimizationConfig,omitempty"`// PeriodicTuningState: Optional. The state of periodic tuning. The period we// use is 3 months - to do a one-off tune earlier use the `TuneModel` method.// Default value is `PERIODIC_TUNING_ENABLED`.//// Possible values://   "PERIODIC_TUNING_STATE_UNSPECIFIED" - Unspecified default value, should// never be explicitly set.//   "PERIODIC_TUNING_DISABLED" - The model has periodic tuning disabled.// Tuning can be reenabled by calling the `EnableModelPeriodicTuning` method or// by calling the `TuneModel` method.//   "ALL_TUNING_DISABLED" - The model cannot be tuned with periodic tuning OR// the `TuneModel` method. Hide the options in customer UI and reject any// requests through the backend self serve API.//   "PERIODIC_TUNING_ENABLED" - The model has periodic tuning enabled. Tuning// can be disabled by calling the `DisableModelPeriodicTuning` method.PeriodicTuningStatestring `json:"periodicTuningState,omitempty"`// ServingConfigLists: Output only. The list of valid serving configs// associated with the PageOptimizationConfig.ServingConfigLists []*GoogleCloudRetailV2alphaModelServingConfigList `json:"servingConfigLists,omitempty"`// ServingState: Output only. The serving state of the model: `ACTIVE`,// `NOT_ACTIVE`.//// Possible values://   "SERVING_STATE_UNSPECIFIED" - Unspecified serving state.//   "INACTIVE" - The model is not serving.//   "ACTIVE" - The model is serving and can be queried.//   "TUNED" - The model is trained on tuned hyperparameters and can be// queried.ServingStatestring `json:"servingState,omitempty"`// TrainingState: Optional. The training state that the model is in (e.g.// `TRAINING` or `PAUSED`). Since part of the cost of running the service is// frequency of training - this can be used to determine when to train model in// order to control cost. If not specified: the default value for `CreateModel`// method is `TRAINING`. The default value for `UpdateModel` method is to keep// the state the same as before.//// Possible values://   "TRAINING_STATE_UNSPECIFIED" - Unspecified training state.//   "PAUSED" - The model training is paused.//   "TRAINING" - The model is training.TrainingStatestring `json:"trainingState,omitempty"`// TuningOperation: Output only. The tune operation associated with the model.// Can be used to determine if there is an ongoing tune for this// recommendation. Empty field implies no tune is goig on.TuningOperationstring `json:"tuningOperation,omitempty"`// Type: Required. The type of model e.g. `home-page`. Currently supported// values: `recommended-for-you`, `others-you-may-like`,// `frequently-bought-together`, `page-optimization`, `similar-items`,// `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This// field together with optimization_objective describe model metadata to use to// control model training and serving. See//https://cloud.google.com/retail/docs/models for more details on what the// model metadata control and which combination of parameters are valid. For// invalid combinations of parameters (e.g. type = `frequently-bought-together`// and optimization_objective = `ctr`), you receive an error 400 if you try to// create/update a recommendation with this set of knobs.Typestring `json:"type,omitempty"`// UpdateTime: Output only. Timestamp the Recommendation Model was last// updated. E.g. if a Recommendation Model was paused - this would be the time// the pause was initiated.UpdateTimestring `json:"updateTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaModel: Metadata that describes the training andserving parameters of a Model. A Model can be associated with aServingConfig and then queried through the Predict API.

func (GoogleCloudRetailV2alphaModel)MarshalJSONadded inv0.89.0

func (sGoogleCloudRetailV2alphaModel) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfigadded inv0.121.0

type GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig struct {// ContextProductsType: Optional. Specifies the context of the model when it is// used in predict requests. Can only be set for the// `frequently-bought-together` type. If it isn't specified, it defaults to// MULTIPLE_CONTEXT_PRODUCTS.//// Possible values://   "CONTEXT_PRODUCTS_TYPE_UNSPECIFIED" - Unspecified default value, should// never be explicitly set. Defaults to MULTIPLE_CONTEXT_PRODUCTS.//   "SINGLE_CONTEXT_PRODUCT" - Use only a single product as context for the// recommendation. Typically used on pages like add-to-cart or product details.//   "MULTIPLE_CONTEXT_PRODUCTS" - Use one or multiple products as context for// the recommendation. Typically used on shopping cart pages.ContextProductsTypestring `json:"contextProductsType,omitempty"`// ForceSendFields is a list of field names (e.g. "ContextProductsType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ContextProductsType") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig:Additional configs for the frequently-bought-together model type.

func (GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig)MarshalJSONadded inv0.121.0

typeGoogleCloudRetailV2alphaModelModelFeaturesConfigadded inv0.121.0

type GoogleCloudRetailV2alphaModelModelFeaturesConfig struct {// FrequentlyBoughtTogetherConfig: Additional configs for// frequently-bought-together models.FrequentlyBoughtTogetherConfig *GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig `json:"frequentlyBoughtTogetherConfig,omitempty"`// ForceSendFields is a list of field names (e.g.// "FrequentlyBoughtTogetherConfig") to unconditionally include in API// requests. By default, fields with empty or default values are omitted from// API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FrequentlyBoughtTogetherConfig")// to include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaModelModelFeaturesConfig: Additional model featuresconfig.

func (GoogleCloudRetailV2alphaModelModelFeaturesConfig)MarshalJSONadded inv0.121.0

typeGoogleCloudRetailV2alphaModelPageOptimizationConfigadded inv0.89.0

type GoogleCloudRetailV2alphaModelPageOptimizationConfig struct {// PageOptimizationEventType: Required. The type of UserEvent this page// optimization is shown for. Each page has an associated event type - this// will be the corresponding event type for the page that the page optimization// model is used on. Supported types: * `add-to-cart`: Products being added to// cart. * `detail-page-view`: Products detail page viewed. * `home-page-view`:// Homepage viewed * `category-page-view`: Homepage viewed *// `shopping-cart-page-view`: User viewing a shopping cart. `home-page-view`// only allows models with type `recommended-for-you`. All other// page_optimization_event_type allow all Model.types.PageOptimizationEventTypestring `json:"pageOptimizationEventType,omitempty"`// Panels: Required. A list of panel configurations. Limit = 5.Panels []*GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel `json:"panels,omitempty"`// Restriction: Optional. How to restrict results across panels e.g. can the// same ServingConfig be shown on multiple panels at once. If unspecified,// default to `UNIQUE_MODEL_RESTRICTION`.//// Possible values://   "RESTRICTION_UNSPECIFIED" - Unspecified value for restriction.//   "NO_RESTRICTION" - Allow any ServingConfig to be show on any number of// panels. Example: `Panel1 candidates`: pdp_ctr, pdp_cvr,// home_page_ctr_no_diversity `Panel2 candidates`: home_page_ctr_no_diversity,// home_page_ctr_diversity, pdp_cvr_no_diversity `Restriction` = NO_RESTRICTION// `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr,// home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr,// home_page_ctr_no_diversity) * (pdp_cvr, home_page_ctr_diversity) * (pdp_cvr,// pdp_cvr_no_diversity) * (home_page_ctr_no_diversity,// home_page_ctr_no_diversity) * (home_page_ctr_no_diversity,// home_page_ctr_diversity) * (home_page_ctr_no_diversity,// pdp_cvr_no_diversity) * `Invalid combinations`: []//   "UNIQUE_SERVING_CONFIG_RESTRICTION" - Do not allow the same// ServingConfig.name to be shown on multiple panels. Example: `Panel1// candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2// candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low,// pdp_cvr_no_diversity * `Restriction` = `UNIQUE_SERVING_CONFIG_RESTRICTION`// `Valid combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr,// home_page_ctr_diversity_low) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr,// pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr,// home_page_ctr_diversity_low) * (pdp_cvr, pdp_cvr_no_diversity) *// (home_page_ctr_no_diversity, home_page_ctr_diversity_low) *// (home_page_ctr_no_diversity, pdp_cvr_no_diversity) * `Invalid combinations`:// * * (home_page_ctr_no_diversity, home_page_ctr_no_diversity) *//   "UNIQUE_MODEL_RESTRICTION" - Do not allow multiple ServingConfigs with// same Model.name to be show on on different panels. Example: `Panel1// candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2// candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low,// pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` `Valid// combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr,// home_page_ctr_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_ctr,// pdp_cvr_no_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr,// home_page_ctr_diversity_low) * (home_page_ctr_no_diversity,// pdp_cvr_no_diversity) * `Invalid combinations`: * *// (home_page_ctr_no_diversity, home_page_ctr_no_diversity) * (pdp_cvr,// pdp_cvr_no_diversity) *//   "UNIQUE_MODEL_TYPE_RESTRICTION" - Do not allow multiple ServingConfigs// with same Model.type to be shown on different panels. Example: `Panel1// candidates`: * pdp_ctr, pdp_cvr, home_page_ctr_no_diversity * `Panel2// candidates`: * home_page_ctr_no_diversity, home_page_ctr_diversity_low,// pdp_cvr_no_diversity * `Restriction` = `UNIQUE_MODEL_RESTRICTION` `Valid// combinations`: * * (pdp_ctr, home_page_ctr_no_diversity) * (pdp_ctr,// home_page_ctr_diversity) * (pdp_cvr, home_page_ctr_no_diversity) * (pdp_cvr,// home_page_ctr_diversity_low) * (home_page_ctr_no_diversity,// pdp_cvr_no_diversity) * `Invalid combinations`: * * (pdp_ctr,// pdp_cvr_no_diversity) * (pdp_ctr, pdp_cvr_no_diversity) * (pdp_cvr,// pdp_cvr_no_diversity) * (home_page_ctr_no_diversity,// home_page_ctr_no_diversity) * (home_page_ctr_no_diversity,// home_page_ctr_diversity) *Restrictionstring `json:"restriction,omitempty"`// ForceSendFields is a list of field names (e.g. "PageOptimizationEventType")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PageOptimizationEventType") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaModelPageOptimizationConfig: ThePageOptimizationConfig for model training. This determines how many panelsto optimize for, and which serving configs to consider for each panel. Thepurpose of this model is to optimize which ServingConfig to show on whichpanels in way that optimizes the visitors shopping journey.

func (GoogleCloudRetailV2alphaModelPageOptimizationConfig)MarshalJSONadded inv0.89.0

typeGoogleCloudRetailV2alphaModelPageOptimizationConfigCandidateadded inv0.89.0

type GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate struct {// ServingConfigId: This has to be a valid ServingConfig identifier. For// example, for a ServingConfig with full name:// `projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candi// date_config`, this would be `my_candidate_config`.ServingConfigIdstring `json:"servingConfigId,omitempty"`// ForceSendFields is a list of field names (e.g. "ServingConfigId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ServingConfigId") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate: A candidate toconsider for a given panel. Currently only ServingConfig are validcandidates.

func (GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate)MarshalJSONadded inv0.89.0

typeGoogleCloudRetailV2alphaModelPageOptimizationConfigPaneladded inv0.89.0

type GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel struct {// Candidates: Required. The candidates to consider on the panel.Candidates []*GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"candidates,omitempty"`// DefaultCandidate: Required. The default candidate. If the model fails at// serving time, we fall back to the default.DefaultCandidate *GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate `json:"defaultCandidate,omitempty"`// DisplayName: Optional. The name to display for the panel.DisplayNamestring `json:"displayName,omitempty"`// ForceSendFields is a list of field names (e.g. "Candidates") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Candidates") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel: An individualpanel with a list of ServingConfigs to consider for it.

func (GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel)MarshalJSONadded inv0.89.0

typeGoogleCloudRetailV2alphaModelServingConfigListadded inv0.90.0

type GoogleCloudRetailV2alphaModelServingConfigList struct {// ServingConfigIds: Optional. A set of valid serving configs that may be used// for `PAGE_OPTIMIZATION`.ServingConfigIds []string `json:"servingConfigIds,omitempty"`// ForceSendFields is a list of field names (e.g. "ServingConfigIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ServingConfigIds") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaModelServingConfigList: Represents an orderedcombination of valid serving configs, which can be used for`PAGE_OPTIMIZATION` recommendations.

func (GoogleCloudRetailV2alphaModelServingConfigList)MarshalJSONadded inv0.90.0

typeGoogleCloudRetailV2alphaOutputConfigadded inv0.154.0

type GoogleCloudRetailV2alphaOutputConfig struct {// BigqueryDestination: The BigQuery location where the output is to be written// to.BigqueryDestination *GoogleCloudRetailV2alphaOutputConfigBigQueryDestination `json:"bigqueryDestination,omitempty"`// GcsDestination: The Google Cloud Storage location where the output is to be// written to.GcsDestination *GoogleCloudRetailV2alphaOutputConfigGcsDestination `json:"gcsDestination,omitempty"`// ForceSendFields is a list of field names (e.g. "BigqueryDestination") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BigqueryDestination") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaOutputConfig: The output configuration setting.

func (GoogleCloudRetailV2alphaOutputConfig)MarshalJSONadded inv0.154.0

typeGoogleCloudRetailV2alphaOutputConfigBigQueryDestinationadded inv0.154.0

type GoogleCloudRetailV2alphaOutputConfigBigQueryDestination struct {// DatasetId: Required. The ID of a BigQuery Dataset.DatasetIdstring `json:"datasetId,omitempty"`// TableIdPrefix: Required. The prefix of exported BigQuery tables.TableIdPrefixstring `json:"tableIdPrefix,omitempty"`// TableType: Required. Describes the table type. The following values are// supported: * `table`: A BigQuery native table. * `view`: A virtual table// defined by a SQL query.TableTypestring `json:"tableType,omitempty"`// ForceSendFields is a list of field names (e.g. "DatasetId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DatasetId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaOutputConfigBigQueryDestination: The BigQuery outputdestination configuration.

func (GoogleCloudRetailV2alphaOutputConfigBigQueryDestination)MarshalJSONadded inv0.154.0

typeGoogleCloudRetailV2alphaOutputConfigGcsDestinationadded inv0.154.0

type GoogleCloudRetailV2alphaOutputConfigGcsDestination struct {// OutputUriPrefix: Required. The output uri prefix for saving output data to// json files. Some mapping examples are as follows: output_uri_prefix sample// output(assuming the object is foo.json) ========================// ============================================= gs://bucket/// gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json// gs://bucket/folder/item_ gs://bucket/folder/item_foo.jsonOutputUriPrefixstring `json:"outputUriPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "OutputUriPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "OutputUriPrefix") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaOutputConfigGcsDestination: The Google Cloud Storageoutput destination configuration.

func (GoogleCloudRetailV2alphaOutputConfigGcsDestination)MarshalJSONadded inv0.154.0

typeGoogleCloudRetailV2alphaOutputResultadded inv0.90.0

type GoogleCloudRetailV2alphaOutputResult struct {// BigqueryResult: The BigQuery location where the result is stored.BigqueryResult []*GoogleCloudRetailV2alphaBigQueryOutputResult `json:"bigqueryResult,omitempty"`// GcsResult: The Google Cloud Storage location where the result is stored.GcsResult []*GoogleCloudRetailV2alphaGcsOutputResult `json:"gcsResult,omitempty"`// ForceSendFields is a list of field names (e.g. "BigqueryResult") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BigqueryResult") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaOutputResult: Output result that stores theinformation about where the exported data is stored.

func (GoogleCloudRetailV2alphaOutputResult)MarshalJSONadded inv0.90.0

typeGoogleCloudRetailV2alphaPanelInfoadded inv0.244.0

type GoogleCloudRetailV2alphaPanelInfo struct {// AttributionToken: Optional. The attribution token of the panel.AttributionTokenstring `json:"attributionToken,omitempty"`// DisplayName: Optional. The display name of the panel.DisplayNamestring `json:"displayName,omitempty"`// PanelId: Required. The panel ID.PanelIdstring `json:"panelId,omitempty"`// PanelPosition: Optional. The ordered position of the panel, if shown to the// user with other panels. If set, then total_panels must also be set.PanelPositionint64 `json:"panelPosition,omitempty"`// ProductDetails: Optional. The product details associated with the panel.ProductDetails []*GoogleCloudRetailV2alphaProductDetail `json:"productDetails,omitempty"`// TotalPanels: Optional. The total number of panels, including this one, shown// to the user. Must be set if panel_position is set.TotalPanelsint64 `json:"totalPanels,omitempty"`// ForceSendFields is a list of field names (e.g. "AttributionToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AttributionToken") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPanelInfo: Detailed panel information associatedwith a user event.

func (GoogleCloudRetailV2alphaPanelInfo)MarshalJSONadded inv0.244.0

func (sGoogleCloudRetailV2alphaPanelInfo) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaPauseModelRequestadded inv0.89.0

type GoogleCloudRetailV2alphaPauseModelRequest struct {}

GoogleCloudRetailV2alphaPauseModelRequest: Request for pausing training of amodel.

typeGoogleCloudRetailV2alphaPinControlMetadataadded inv0.204.0

type GoogleCloudRetailV2alphaPinControlMetadata struct {// AllMatchedPins: Map of all matched pins, keyed by pin position.AllMatchedPins map[string]GoogleCloudRetailV2alphaPinControlMetadataProductPins `json:"allMatchedPins,omitempty"`// DroppedPins: Map of pins that were dropped due to overlap with other// matching pins, keyed by pin position.DroppedPins map[string]GoogleCloudRetailV2alphaPinControlMetadataProductPins `json:"droppedPins,omitempty"`// ForceSendFields is a list of field names (e.g. "AllMatchedPins") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllMatchedPins") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPinControlMetadata: Metadata for pinning to bereturned in the response. This is used for distinguishing between applied vsdropped pins.

func (GoogleCloudRetailV2alphaPinControlMetadata)MarshalJSONadded inv0.204.0

typeGoogleCloudRetailV2alphaPinControlMetadataProductPinsadded inv0.204.0

type GoogleCloudRetailV2alphaPinControlMetadataProductPins struct {// ProductId: List of product ids which have associated pins.ProductId []string `json:"productId,omitempty"`// ForceSendFields is a list of field names (e.g. "ProductId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProductId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPinControlMetadataProductPins: List of product idswhich have associated pins.

func (GoogleCloudRetailV2alphaPinControlMetadataProductPins)MarshalJSONadded inv0.204.0

typeGoogleCloudRetailV2alphaPredictRequest

type GoogleCloudRetailV2alphaPredictRequest struct {// Filter: Filter for restricting prediction results with a length limit of// 5,000 characters. Accepts values for tags and the `filterOutOfStockItems`// flag. * Tag expressions. Restricts predictions to products that match all of// the specified tags. Boolean operators `OR` and `NOT` are supported if the// expression is enclosed in parentheses, and must be separated from the tag// values by a space. `-"tagA" is also supported and is equivalent to `NOT// "tagA". Tag values must be double quoted UTF-8 encoded strings with a size// limit of 1,000 characters. Note: "Recently viewed" models don't support tag// filtering at the moment. * filterOutOfStockItems. Restricts predictions to// products that do not have a stockState value of OUT_OF_STOCK. Examples: *// tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") *// filterOutOfStockItems tag=(-"promotional") * filterOutOfStockItems If your// filter blocks all prediction results, the API will return *no* results. If// instead you want empty result sets to return generic (unfiltered) popular// products, set `strictFiltering` to False in `PredictRequest.params`. Note// that the API will never return items with storageStatus of "EXPIRED" or// "DELETED" regardless of filter choices. If `filterSyntaxV2` is set to true// under the `params` field, then attribute-based expressions are expected// instead of the above described tag-based syntax. Examples: * (colors:// ANY("Red", "Blue")) AND NOT (categories: ANY("Phones")) * (availability:// ANY("IN_STOCK")) AND (colors: ANY("Red") OR categories: ANY("Phones")) For// more information, see Filter recommendations// (https://cloud.google.com/retail/docs/filter-recs).Filterstring `json:"filter,omitempty"`// Labels: The labels applied to a resource must meet the following// requirements: * Each resource can have multiple labels, up to a maximum of// 64. * Each label must be a key-value pair. * Keys have a minimum length of 1// character and a maximum length of 63 characters and cannot be empty. Values// can be empty and have a maximum length of 63 characters. * Keys and values// can contain only lowercase letters, numeric characters, underscores, and// dashes. All characters must use UTF-8 encoding, and international characters// are allowed. * The key portion of a label must be unique. However, you can// use the same key with multiple resources. * Keys must start with a lowercase// letter or international character. See Google Cloud Document// (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)// for more details.Labels map[string]string `json:"labels,omitempty"`// PageSize: Maximum number of results to return. Set this property to the// number of prediction results needed. If zero, the service will choose a// reasonable default. The maximum allowed value is 100. Values above 100 will// be coerced to 100.PageSizeint64 `json:"pageSize,omitempty"`// PageToken: This field is not used; leave it unset.PageTokenstring `json:"pageToken,omitempty"`// Params: Additional domain specific parameters for the predictions. Allowed// values: * `returnProduct`: Boolean. If set to true, the associated product// object will be returned in the `results.metadata` field in the prediction// response. * `returnScore`: Boolean. If set to true, the prediction 'score'// corresponding to each returned product will be set in the `results.metadata`// field in the prediction response. The given 'score' indicates the// probability of a product being clicked/purchased given the user's context// and history. * `strictFiltering`: Boolean. True by default. If set to false,// the service will return generic (unfiltered) popular products instead of// empty if your filter blocks all prediction results. * `priceRerankLevel`:// String. Default empty. If set to be non-empty, then it needs to be one of// {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking',// 'high-price-reranking'}. This gives request-level control and adjusts// prediction results based on product price. * `diversityLevel`: String.// Default empty. If set to be non-empty, then it needs to be one of// {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity',// 'auto-diversity'}. This gives request-level control and adjusts prediction// results based on product category. * `filterSyntaxV2`: Boolean. False by// default. If set to true, the `filter` field is interpreteted according to// the new, attribute-based syntax.Paramsgoogleapi.RawMessage `json:"params,omitempty"`// UserEvent: Required. Context about the user, what they are looking at and// what action they took to trigger the predict request. Note that this user// event detail won't be ingested to userEvent logs. Thus, a separate userEvent// write request is required for event logging. Don't set UserEvent.visitor_id// or UserInfo.user_id to the same fixed ID for different users. If you are// trying to receive non-personalized recommendations (not recommended; this// can negatively impact model performance), instead set UserEvent.visitor_id// to a random unique ID and leave UserInfo.user_id unset.UserEvent *GoogleCloudRetailV2alphaUserEvent `json:"userEvent,omitempty"`// ValidateOnly: Use validate only mode for this prediction query. If set to// true, a dummy model will be used that returns arbitrary products. Note that// the validate only mode should only be used for testing the API, or if the// model is not ready.ValidateOnlybool `json:"validateOnly,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Filter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPredictRequest: Request message for Predict method.

func (GoogleCloudRetailV2alphaPredictRequest)MarshalJSON

typeGoogleCloudRetailV2alphaPredictResponse

type GoogleCloudRetailV2alphaPredictResponse struct {// AttributionToken: A unique attribution token. This should be included in the// UserEvent logs resulting from this recommendation, which enables accurate// attribution of recommendation model performance.AttributionTokenstring `json:"attributionToken,omitempty"`// MissingIds: IDs of products in the request that were missing from the// inventory.MissingIds []string `json:"missingIds,omitempty"`// Results: A list of recommended products. The order represents the ranking// (from the most relevant product to the least).Results []*GoogleCloudRetailV2alphaPredictResponsePredictionResult `json:"results,omitempty"`// ValidateOnly: True if the validateOnly property was set in the request.ValidateOnlybool `json:"validateOnly,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AttributionToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AttributionToken") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPredictResponse: Response message for predictmethod.

func (GoogleCloudRetailV2alphaPredictResponse)MarshalJSON

typeGoogleCloudRetailV2alphaPredictResponsePredictionResult

type GoogleCloudRetailV2alphaPredictResponsePredictionResult struct {// Id: ID of the recommended productIdstring `json:"id,omitempty"`// Metadata: Additional product metadata / annotations. Possible values: *// `product`: JSON representation of the product. Is set if `returnProduct` is// set to true in `PredictRequest.params`. * `score`: Prediction score in// double value. Is set if `returnScore` is set to true in// `PredictRequest.params`.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// ForceSendFields is a list of field names (e.g. "Id") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Id") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPredictResponsePredictionResult: PredictionResultrepresents the recommendation prediction results.

func (GoogleCloudRetailV2alphaPredictResponsePredictionResult)MarshalJSON

typeGoogleCloudRetailV2alphaPriceInfo

type GoogleCloudRetailV2alphaPriceInfo struct {// Cost: The costs associated with the sale of a particular product. Used for// gross profit reporting. * Profit = price - cost Google Merchant Center// property cost_of_goods_sold// (https://support.google.com/merchants/answer/9017895).Costfloat64 `json:"cost,omitempty"`// CurrencyCode: The 3-letter currency code defined in ISO 4217// (https://www.iso.org/iso-4217-currency-codes.html). If this field is an// unrecognizable currency code, an INVALID_ARGUMENT error is returned. The// Product.Type.VARIANT Products with the same Product.primary_product_id must// share the same currency_code. Otherwise, a FAILED_PRECONDITION error is// returned.CurrencyCodestring `json:"currencyCode,omitempty"`// OriginalPrice: Price of the product without any discount. If zero, by// default set to be the price. If set, original_price should be greater than// or equal to price, otherwise an INVALID_ARGUMENT error is thrown.OriginalPricefloat64 `json:"originalPrice,omitempty"`// Price: Price of the product. Google Merchant Center property price// (https://support.google.com/merchants/answer/6324371). Schema.org property// Offer.price (https://schema.org/price).Pricefloat64 `json:"price,omitempty"`// PriceEffectiveTime: The timestamp when the price starts to be effective.// This can be set as a future timestamp, and the price is only used for search// after price_effective_time. If so, the original_price must be set and// original_price is used before price_effective_time. Do not set if price is// always effective because it will cause additional latency during search.PriceEffectiveTimestring `json:"priceEffectiveTime,omitempty"`// PriceExpireTime: The timestamp when the price stops to be effective. The// price is used for search before price_expire_time. If this field is set, the// original_price must be set and original_price is used after// price_expire_time. Do not set if price is always effective because it will// cause additional latency during search.PriceExpireTimestring `json:"priceExpireTime,omitempty"`// PriceRange: Output only. The price range of all the child// Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY// Product. Only populated for Product.Type.PRIMARY Products. Note: This field// is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API// requests.PriceRange *GoogleCloudRetailV2alphaPriceInfoPriceRange `json:"priceRange,omitempty"`// ForceSendFields is a list of field names (e.g. "Cost") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cost") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPriceInfo: The price information of a Product.

func (GoogleCloudRetailV2alphaPriceInfo)MarshalJSON

func (sGoogleCloudRetailV2alphaPriceInfo) MarshalJSON() ([]byte,error)

func (*GoogleCloudRetailV2alphaPriceInfo)UnmarshalJSON

func (s *GoogleCloudRetailV2alphaPriceInfo) UnmarshalJSON(data []byte)error

typeGoogleCloudRetailV2alphaPriceInfoPriceRangeadded inv0.52.0

type GoogleCloudRetailV2alphaPriceInfoPriceRange struct {// OriginalPrice: The inclusive Product.pricing_info.original_price internal of// all variant Product having the same Product.primary_product_id.OriginalPrice *GoogleCloudRetailV2alphaInterval `json:"originalPrice,omitempty"`// Price: The inclusive Product.pricing_info.price interval of all variant// Product having the same Product.primary_product_id.Price *GoogleCloudRetailV2alphaInterval `json:"price,omitempty"`// ForceSendFields is a list of field names (e.g. "OriginalPrice") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "OriginalPrice") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPriceInfoPriceRange: The price range of all variantProduct having the same Product.primary_product_id.

func (GoogleCloudRetailV2alphaPriceInfoPriceRange)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaProduct

type GoogleCloudRetailV2alphaProduct struct {// Attributes: Highly encouraged. Extra product attributes to be included. For// example, for products, this could include the store name, vendor, style,// color, etc. These are very strong signals for recommendation model, thus we// highly recommend providing the attributes here. Features that can take on// one of a limited number of possible values. Two types of features can be set// are: Textual features. some examples would be the brand/maker of a product,// or country of a customer. Numerical features. Some examples would be the// height/weight of a product, or age of a customer. For example: `{ "vendor":// {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]},// "heights_cm": {"numbers":[8.1, 6.4]} }`. This field needs to pass all below// criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries// count: 200. * The key must be a UTF-8 encoded string with a length limit of// 128 characters. * For indexable attribute, the key must match the pattern:// `a-zA-Z0-9*`. For example, `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text// attributes, at most 400 values are allowed. Empty values are not allowed.// Each value must be a non-empty UTF-8 encoded string with a length limit of// 256 characters. * For number attributes, at most 400 values are allowed.Attributes map[string]GoogleCloudRetailV2alphaCustomAttribute `json:"attributes,omitempty"`// Audience: The target group associated with a given audience (e.g. male,// veterans, car owners, musicians, etc.) of the product.Audience *GoogleCloudRetailV2alphaAudience `json:"audience,omitempty"`// Availability: The online availability of the Product. Default to// Availability.IN_STOCK. For primary products with variants set the// availability of the primary as Availability.OUT_OF_STOCK and set the true// availability at the variant level. This way the primary product will be// considered "in stock" as long as it has at least one variant in stock. For// primary products with no variants set the true availability at the primary// level. Corresponding properties: Google Merchant Center property// availability (https://support.google.com/merchants/answer/6324448).// Schema.org property Offer.availability (https://schema.org/availability).//// Possible values://   "AVAILABILITY_UNSPECIFIED" - Default product availability. Default to// Availability.IN_STOCK if unset.//   "IN_STOCK" - Product in stock.//   "OUT_OF_STOCK" - Product out of stock.//   "PREORDER" - Product that is in pre-order state.//   "BACKORDER" - Product that is back-ordered (i.e. temporarily out of// stock).Availabilitystring `json:"availability,omitempty"`// AvailableQuantity: The available quantity of the item.AvailableQuantityint64 `json:"availableQuantity,omitempty"`// AvailableTime: The timestamp when this Product becomes available for// SearchService.Search. Note that this is only applicable to Type.PRIMARY and// Type.COLLECTION, and ignored for Type.VARIANT.AvailableTimestring `json:"availableTime,omitempty"`// Brands: The brands of the product. A maximum of 30 brands are allowed unless// overridden through the Google Cloud console. Each brand must be a UTF-8// encoded string with a length limit of 1,000 characters. Otherwise, an// INVALID_ARGUMENT error is returned. Corresponding properties: Google// Merchant Center property brand// (https://support.google.com/merchants/answer/6324351). Schema.org property// Product.brand (https://schema.org/brand).Brands []string `json:"brands,omitempty"`// Categories: Product categories. This field is repeated for supporting one// product belonging to several parallel categories. Strongly recommended using// the full path for better search / recommendation quality. To represent full// path of category, use '>' sign to separate different hierarchies. If '>' is// part of the category name, replace it with other character(s). For example,// if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and// ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be// represented as: "categories": [ "Shoes & Accessories > Shoes", "Sports &// Fitness > Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product// otherwise an INVALID_ARGUMENT error is returned. At most 250 values are// allowed per Product unless overridden through the Google Cloud console.// Empty values are not allowed. Each value must be a UTF-8 encoded string with// a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is// returned. Corresponding properties: Google Merchant Center property// google_product_category. Schema.org property [Product.category]// (https://schema.org/category). [mc_google_product_category]://https://support.google.com/merchants/answer/6324436Categories []string `json:"categories,omitempty"`// CollectionMemberIds: The id of the collection members when type is// Type.COLLECTION. Non-existent product ids are allowed. The type of the// members must be either Type.PRIMARY or Type.VARIANT otherwise an// INVALID_ARGUMENT error is thrown. Should not set it for other types. A// maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is// return.CollectionMemberIds []string `json:"collectionMemberIds,omitempty"`// ColorInfo: The color of the product. Corresponding properties: Google// Merchant Center property color// (https://support.google.com/merchants/answer/6324487). Schema.org property// Product.color (https://schema.org/color).ColorInfo *GoogleCloudRetailV2alphaColorInfo `json:"colorInfo,omitempty"`// Conditions: The condition of the product. Strongly encouraged to use the// standard values: "new", "refurbished", "used". A maximum of 1 value is// allowed per Product. Each value must be a UTF-8 encoded string with a length// limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.// Corresponding properties: Google Merchant Center property condition// (https://support.google.com/merchants/answer/6324469). Schema.org property// Offer.itemCondition (https://schema.org/itemCondition).Conditions []string `json:"conditions,omitempty"`// Description: Product description. This field must be a UTF-8 encoded string// with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT// error is returned. Corresponding properties: Google Merchant Center property// description (https://support.google.com/merchants/answer/6324468).// Schema.org property Product.description (https://schema.org/description).Descriptionstring `json:"description,omitempty"`// ExpireTime: Note that this field is applied in the following ways: * If the// Product is already expired when it is uploaded, this product is not indexed// for search. * If the Product is not expired when it is uploaded, only the// Type.PRIMARY's and Type.COLLECTION's expireTime is respected, and// Type.VARIANT's expireTime is not used. In general, we suggest the users to// delete the stale products explicitly, instead of using this field to// determine staleness. expire_time must be later than available_time and// publish_time, otherwise an INVALID_ARGUMENT error is thrown. Corresponding// properties: Google Merchant Center property expiration_date// (https://support.google.com/merchants/answer/6324499).ExpireTimestring `json:"expireTime,omitempty"`// FulfillmentInfo: Fulfillment information, such as the store IDs for in-store// pickup or region IDs for different shipping methods. All the elements must// have distinct FulfillmentInfo.type. Otherwise, an INVALID_ARGUMENT error is// returned.FulfillmentInfo []*GoogleCloudRetailV2alphaFulfillmentInfo `json:"fulfillmentInfo,omitempty"`// Gtin: The Global Trade Item Number (GTIN) of the product. This field must be// a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an// INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise,// an INVALID_ARGUMENT error is returned. Corresponding properties: Google// Merchant Center property gtin// (https://support.google.com/merchants/answer/6324461). Schema.org property// Product.isbn (https://schema.org/isbn), Product.gtin8// (https://schema.org/gtin8), Product.gtin12 (https://schema.org/gtin12),// Product.gtin13 (https://schema.org/gtin13), or Product.gtin14// (https://schema.org/gtin14). If the value is not a valid GTIN, an// INVALID_ARGUMENT error is returned.Gtinstring `json:"gtin,omitempty"`// Id: Immutable. Product identifier, which is the final component of name. For// example, this field is "id_1", if name is// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch// /products/id_1`. This field must be a UTF-8 encoded string with a length// limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.// Corresponding properties: Google Merchant Center property id// (https://support.google.com/merchants/answer/6324405). Schema.org property// Product.sku (https://schema.org/sku).Idstring `json:"id,omitempty"`// Images: Product images for the product. We highly recommend putting the main// image first. A maximum of 300 images are allowed. Corresponding properties:// Google Merchant Center property image_link// (https://support.google.com/merchants/answer/6324350). Schema.org property// Product.image (https://schema.org/image).Images []*GoogleCloudRetailV2alphaImage `json:"images,omitempty"`// LanguageCode: Language of the title/description and other string attributes.// Use language tags defined by BCP 47// (https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For product prediction, this// field is ignored and the model automatically detects the text language. The// Product can include text in different languages, but duplicating Products to// provide text in multiple languages can result in degraded model performance.// For product search this field is in use. It defaults to "en-US" if unset.LanguageCodestring `json:"languageCode,omitempty"`// LocalInventories: Output only. A list of local inventories specific to// different places. This field can be managed by// ProductService.AddLocalInventories and ProductService.RemoveLocalInventories// APIs if fine-grained, high-volume updates are necessary.LocalInventories []*GoogleCloudRetailV2alphaLocalInventory `json:"localInventories,omitempty"`// Materials: The material of the product. For example, "leather", "wooden". A// maximum of 20 values are allowed. Each value must be a UTF-8 encoded string// with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error// is returned. Corresponding properties: Google Merchant Center property// material (https://support.google.com/merchants/answer/6324410). Schema.org// property Product.material (https://schema.org/material).Materials []string `json:"materials,omitempty"`// Name: Immutable. Full resource name of the product, such as// `projects/*/locations/global/catalogs/default_catalog/branches/default_branch// /products/product_id`.Namestring `json:"name,omitempty"`// Patterns: The pattern or graphic print of the product. For example,// "striped", "polka dot", "paisley". A maximum of 20 values are allowed per// Product. Each value must be a UTF-8 encoded string with a length limit of// 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.// Corresponding properties: Google Merchant Center property pattern// (https://support.google.com/merchants/answer/6324483). Schema.org property// Product.pattern (https://schema.org/pattern).Patterns []string `json:"patterns,omitempty"`// PriceInfo: Product price and cost information. Corresponding properties:// Google Merchant Center property price// (https://support.google.com/merchants/answer/6324371).PriceInfo *GoogleCloudRetailV2alphaPriceInfo `json:"priceInfo,omitempty"`// PrimaryProductId: Variant group identifier. Must be an id, with the same// parent branch with this product. Otherwise, an error is thrown. For// Type.PRIMARY Products, this field can only be empty or set to the same value// as id. For VARIANT Products, this field cannot be empty. A maximum of 2,000// products are allowed to share the same Type.PRIMARY Product. Otherwise, an// INVALID_ARGUMENT error is returned. Corresponding properties: Google// Merchant Center property item_group_id// (https://support.google.com/merchants/answer/6324507). Schema.org property// Product.inProductGroupWithID (https://schema.org/inProductGroupWithID).PrimaryProductIdstring `json:"primaryProductId,omitempty"`// Promotions: The promotions applied to the product. A maximum of 10 values// are allowed per Product. Only Promotion.promotion_id will be used, other// fields will be ignored if set.Promotions []*GoogleCloudRetailV2alphaPromotion `json:"promotions,omitempty"`// PublishTime: The timestamp when the product is published by the retailer for// the first time, which indicates the freshness of the products. Note that// this field is different from available_time, given it purely describes// product freshness regardless of when it is available on search and// recommendation.PublishTimestring `json:"publishTime,omitempty"`// Rating: The rating of this product.Rating *GoogleCloudRetailV2alphaRating `json:"rating,omitempty"`// RetrievableFields: Indicates which fields in the Products are returned in// SearchResponse. Supported fields for all types: * audience * availability *// brands * color_info * conditions * gtin * materials * name * patterns *// price_info * rating * sizes * title * uri Supported fields only for// Type.PRIMARY and Type.COLLECTION: * categories * description * images// Supported fields only for Type.VARIANT: * Only the first image in images To// mark attributes as retrievable, include paths of the form "attributes.key"// where "key" is the key of a custom attribute, as specified in attributes.// For Type.PRIMARY and Type.COLLECTION, the following fields are always// returned in SearchResponse by default: * name For Type.VARIANT, the// following fields are always returned in by default: * name * color_info// Note: Returning more fields in SearchResponse can increase response payload// size and serving latency. This field is deprecated. Use the retrievable// site-wide control instead.RetrievableFieldsstring `json:"retrievableFields,omitempty"`// Sizes: The size of the product. To represent different size systems or size// types, consider using this format: [[[size_system:]size_type:]size_value].// For example, in "US:MENS:M", "US" represents size system; "MENS" represents// size type; "M" represents size value. In "GIRLS:27", size system is empty;// "GIRLS" represents size type; "27" represents size value. In "32 inches",// both size system and size type are empty, while size value is "32 inches". A// maximum of 20 values are allowed per Product. Each value must be a UTF-8// encoded string with a length limit of 128 characters. Otherwise, an// INVALID_ARGUMENT error is returned. Corresponding properties: Google// Merchant Center property size// (https://support.google.com/merchants/answer/6324492), size_type// (https://support.google.com/merchants/answer/6324497), and size_system// (https://support.google.com/merchants/answer/6324502). Schema.org property// Product.size (https://schema.org/size).Sizes []string `json:"sizes,omitempty"`// Tags: Custom tags associated with the product. At most 250 values are// allowed per Product. This value must be a UTF-8 encoded string with a length// limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.// This tag can be used for filtering recommendation results by passing the tag// as part of the PredictRequest.filter. Corresponding properties: Google// Merchant Center property custom_label_0–4// (https://support.google.com/merchants/answer/6324473).Tags []string `json:"tags,omitempty"`// Title: Required. Product title. This field must be a UTF-8 encoded string// with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT// error is returned. Corresponding properties: Google Merchant Center property// title (https://support.google.com/merchants/answer/6324415). Schema.org// property Product.name (https://schema.org/name).Titlestring `json:"title,omitempty"`// Ttl: Input only. The TTL (time to live) of the product. Note that this is// only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for// Type.VARIANT. In general, we suggest the users to delete the stale products// explicitly, instead of using this field to determine staleness. If it is// set, it must be a non-negative value, and expire_time is set as current// timestamp plus ttl. The derived expire_time is returned in the output and// ttl is left blank when retrieving the Product. If it is set, the product is// not available for SearchService.Search after current timestamp plus ttl.// However, the product can still be retrieved by ProductService.GetProduct and// ProductService.ListProducts.Ttlstring `json:"ttl,omitempty"`// Type: Immutable. The type of the product. Default to// Catalog.product_level_config.ingestion_product_type if unset.//// Possible values://   "TYPE_UNSPECIFIED" - Default value. Default to// Catalog.product_level_config.ingestion_product_type if unset.//   "PRIMARY" - The primary type. As the primary unit for predicting, indexing// and search serving, a Type.PRIMARY Product is grouped with multiple// Type.VARIANT Products.//   "VARIANT" - The variant type. Type.VARIANT Products usually share some// common attributes on the same Type.PRIMARY Products, but they have variant// attributes like different colors, sizes and prices, etc.//   "COLLECTION" - The collection type. Collection products are bundled// Type.PRIMARY Products or Type.VARIANT Products that are sold together, such// as a jewelry set with necklaces, earrings and rings, etc.Typestring `json:"type,omitempty"`// Uri: Canonical URL directly linking to the product detail page. It is// strongly recommended to provide a valid uri for the product, otherwise the// service performance could be significantly degraded. This field must be a// UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an// INVALID_ARGUMENT error is returned. Corresponding properties: Google// Merchant Center property link// (https://support.google.com/merchants/answer/6324416). Schema.org property// Offer.url (https://schema.org/url).Uristring `json:"uri,omitempty"`// Variants: Output only. Product variants grouped together on primary product// which share similar product attributes. It's automatically grouped by// primary_product_id for all the product variants. Only populated for// Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for// ProductService.GetProduct. Do not set this field in API requests.Variants []*GoogleCloudRetailV2alphaProduct `json:"variants,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Attributes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Attributes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaProduct: Product captures all metadata informationof items to be recommended or searched.

func (GoogleCloudRetailV2alphaProduct)MarshalJSON

func (sGoogleCloudRetailV2alphaProduct) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaProductAttributeIntervaladded inv0.198.0

type GoogleCloudRetailV2alphaProductAttributeInterval struct {// Interval: The numeric interval (e.g. [10, 20))Interval *GoogleCloudRetailV2alphaInterval `json:"interval,omitempty"`// Name: The attribute name (e.g. "length")Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "Interval") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Interval") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaProductAttributeInterval: Product attribute name andnumeric interval.

func (GoogleCloudRetailV2alphaProductAttributeInterval)MarshalJSONadded inv0.198.0

typeGoogleCloudRetailV2alphaProductAttributeValueadded inv0.198.0

type GoogleCloudRetailV2alphaProductAttributeValue struct {// Name: The attribute name.Namestring `json:"name,omitempty"`// Value: The attribute value.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaProductAttributeValue: Product attribute whichstructured by an attribute name and value. This structure is used inconversational search filters and answers. For example, if we have`name=color` and `value=red`, this means that the color is `red`.

func (GoogleCloudRetailV2alphaProductAttributeValue)MarshalJSONadded inv0.198.0

typeGoogleCloudRetailV2alphaProductDetail

type GoogleCloudRetailV2alphaProductDetail struct {// Product: Required. Product information. Required field(s): * Product.id// Optional override field(s): * Product.price_info If any supported optional// fields are provided, we will treat them as a full override when looking up// product information from the catalog. Thus, it is important to ensure that// the overriding fields are accurate and complete. All other product fields// are ignored and instead populated via catalog lookup after event ingestion.Product *GoogleCloudRetailV2alphaProduct `json:"product,omitempty"`// Quantity: Quantity of the product associated with the user event. For// example, this field will be 2 if two products are added to the shopping cart// for `purchase-complete` event. Required for `add-to-cart` and// `purchase-complete` event types.Quantityint64 `json:"quantity,omitempty"`// ForceSendFields is a list of field names (e.g. "Product") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Product") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaProductDetail: Detailed product informationassociated with a user event.

func (GoogleCloudRetailV2alphaProductDetail)MarshalJSON

typeGoogleCloudRetailV2alphaProductInlineSource

type GoogleCloudRetailV2alphaProductInlineSource struct {// Products: Required. A list of products to update/create. Each product must// have a valid Product.id. Recommended max of 100 items.Products []*GoogleCloudRetailV2alphaProduct `json:"products,omitempty"`// ForceSendFields is a list of field names (e.g. "Products") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Products") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaProductInlineSource: The inline source for the inputconfig for ImportProducts method.

func (GoogleCloudRetailV2alphaProductInlineSource)MarshalJSON

typeGoogleCloudRetailV2alphaProductInputConfig

type GoogleCloudRetailV2alphaProductInputConfig struct {// BigQuerySource: BigQuery input source.BigQuerySource *GoogleCloudRetailV2alphaBigQuerySource `json:"bigQuerySource,omitempty"`// GcsSource: Google Cloud Storage location for the input content.GcsSource *GoogleCloudRetailV2alphaGcsSource `json:"gcsSource,omitempty"`// ProductInlineSource: The Inline source for the input content for products.ProductInlineSource *GoogleCloudRetailV2alphaProductInlineSource `json:"productInlineSource,omitempty"`// ForceSendFields is a list of field names (e.g. "BigQuerySource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BigQuerySource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaProductInputConfig: The input config source forproducts.

func (GoogleCloudRetailV2alphaProductInputConfig)MarshalJSON

typeGoogleCloudRetailV2alphaProductLevelConfig

type GoogleCloudRetailV2alphaProductLevelConfig struct {// IngestionProductType: The type of Products allowed to be ingested into the// catalog. Acceptable values are: * `primary` (default): You can ingest// Products of all types. When ingesting a Product, its type will default to// Product.Type.PRIMARY if unset. * `variant` (incompatible with Retail// Search): You can only ingest Product.Type.VARIANT Products. This means// Product.primary_product_id cannot be empty. If this field is set to an// invalid value other than these, an INVALID_ARGUMENT error is returned. If// this field is `variant` and merchant_center_product_id_field is// `itemGroupId`, an INVALID_ARGUMENT error is returned. See Product levels// (https://cloud.google.com/retail/docs/catalog#product-levels) for more// details.IngestionProductTypestring `json:"ingestionProductType,omitempty"`// MerchantCenterProductIdField: Which field of Merchant Center Product// (/bigquery-transfer/docs/merchant-center-products-schema) should be imported// as Product.id. Acceptable values are: * `offerId` (default): Import// `offerId` as the product ID. * `itemGroupId`: Import `itemGroupId` as the// product ID. Notice that Retail API will choose one item from the ones with// the same `itemGroupId`, and use it to represent the item group. If this// field is set to an invalid value other than these, an INVALID_ARGUMENT error// is returned. If this field is `itemGroupId` and ingestion_product_type is// `variant`, an INVALID_ARGUMENT error is returned. See Product levels// (https://cloud.google.com/retail/docs/catalog#product-levels) for more// details.MerchantCenterProductIdFieldstring `json:"merchantCenterProductIdField,omitempty"`// ForceSendFields is a list of field names (e.g. "IngestionProductType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IngestionProductType") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaProductLevelConfig: Configures what level theproduct should be uploaded with regards to how users will be send events andhow predictions will be made.

func (GoogleCloudRetailV2alphaProductLevelConfig)MarshalJSON

typeGoogleCloudRetailV2alphaProjectadded inv0.131.0

type GoogleCloudRetailV2alphaProject struct {// EnrolledSolutions: Output only. Retail API solutions that the project has// enrolled.//// Possible values://   "SOLUTION_TYPE_UNSPECIFIED" - Default value.//   "SOLUTION_TYPE_RECOMMENDATION" - Used for Recommendations AI.//   "SOLUTION_TYPE_SEARCH" - Used for Retail Search.EnrolledSolutions []string `json:"enrolledSolutions,omitempty"`// Name: Output only. Full resource name of the retail project, such as// `projects/{project_id_or_number}/retailProject`.Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "EnrolledSolutions") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EnrolledSolutions") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaProject: Metadata that describes a Cloud RetailProject.

func (GoogleCloudRetailV2alphaProject)MarshalJSONadded inv0.131.0

func (sGoogleCloudRetailV2alphaProject) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaPromotionadded inv0.52.0

type GoogleCloudRetailV2alphaPromotion struct {// PromotionId: Promotion identifier, which is the final component of name. For// example, this field is "free_gift", if name is// `projects/*/locations/global/catalogs/default_catalog/promotions/free_gift`.// The value must be a UTF-8 encoded string with a length limit of 128// characters, and match the pattern: `a-zA-Z*`. For example, id0LikeThis or// ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is returned.// Corresponds to Google Merchant Center property promotion_id// (https://support.google.com/merchants/answer/7050148).PromotionIdstring `json:"promotionId,omitempty"`// ForceSendFields is a list of field names (e.g. "PromotionId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PromotionId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPromotion: Promotion specification.

func (GoogleCloudRetailV2alphaPromotion)MarshalJSONadded inv0.52.0

func (sGoogleCloudRetailV2alphaPromotion) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaPurchaseTransaction

type GoogleCloudRetailV2alphaPurchaseTransaction struct {// Cost: All the costs associated with the products. These can be manufacturing// costs, shipping expenses not borne by the end user, or any other costs, such// that: * Profit = revenue - tax - costCostfloat64 `json:"cost,omitempty"`// CurrencyCode: Required. Currency code. Use three-character ISO-4217 code.CurrencyCodestring `json:"currencyCode,omitempty"`// Id: The transaction ID with a length limit of 128 characters.Idstring `json:"id,omitempty"`// Revenue: Required. Total non-zero revenue or grand total associated with the// transaction. This value include shipping, tax, or other adjustments to total// revenue that you want to include as part of your revenue calculations.Revenuefloat64 `json:"revenue,omitempty"`// Tax: All the taxes associated with the transaction.Taxfloat64 `json:"tax,omitempty"`// ForceSendFields is a list of field names (e.g. "Cost") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cost") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPurchaseTransaction: A transaction represents theentire purchase transaction.

func (GoogleCloudRetailV2alphaPurchaseTransaction)MarshalJSON

func (*GoogleCloudRetailV2alphaPurchaseTransaction)UnmarshalJSON

typeGoogleCloudRetailV2alphaPurgeMetadata

type GoogleCloudRetailV2alphaPurgeMetadata struct {}

GoogleCloudRetailV2alphaPurgeMetadata: Metadata related to the progress ofthe Purge operation. This will be returned by thegoogle.longrunning.Operation.metadata field.

typeGoogleCloudRetailV2alphaPurgeProductsMetadataadded inv0.74.0

type GoogleCloudRetailV2alphaPurgeProductsMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// FailureCount: Count of entries that encountered errors while processing.FailureCountint64 `json:"failureCount,omitempty,string"`// SuccessCount: Count of entries that were deleted successfully.SuccessCountint64 `json:"successCount,omitempty,string"`// UpdateTime: Operation last update time. If the operation is done, this is// also the finish time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPurgeProductsMetadata: Metadata related to theprogress of the PurgeProducts operation. This will be returned by thegoogle.longrunning.Operation.metadata field.

func (GoogleCloudRetailV2alphaPurgeProductsMetadata)MarshalJSONadded inv0.74.0

typeGoogleCloudRetailV2alphaPurgeProductsRequestadded inv0.74.0

type GoogleCloudRetailV2alphaPurgeProductsRequest struct {// Filter: Required. The filter string to specify the products to be deleted// with a length limit of 5,000 characters. Empty string filter is not allowed.// "*" implies delete all items in a branch. The eligible fields for filtering// are: * `availability`: Double quoted Product.availability string. *// `create_time` : in ISO 8601 "zulu" format. Supported syntax: * Comparators// (">", "<", ">=", "<=", "="). Examples: * create_time <=// "2015-02-13T17:05:46Z" * availability = "IN_STOCK" * Conjunctions ("AND")// Examples: * create_time <= "2015-02-13T17:05:46Z" AND availability =// "PREORDER" * Disjunctions ("OR") Examples: * create_time <=// "2015-02-13T17:05:46Z" OR availability = "IN_STOCK" * Can support nested// queries. Examples: * (create_time <= "2015-02-13T17:05:46Z" AND availability// = "PREORDER") OR (create_time >= "2015-02-14T13:03:32Z" AND availability =// "IN_STOCK") * Filter Limits: * Filter should not contain more than 6// conditions. * Max nesting depth should not exceed 2 levels. Examples// queries: * Delete back order products created before a timestamp.// create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER"Filterstring `json:"filter,omitempty"`// Force: Actually perform the purge. If `force` is set to false, the method// will return the expected purge count without deleting any products.Forcebool `json:"force,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Filter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPurgeProductsRequest: Request message forPurgeProducts method.

func (GoogleCloudRetailV2alphaPurgeProductsRequest)MarshalJSONadded inv0.74.0

typeGoogleCloudRetailV2alphaPurgeProductsResponseadded inv0.74.0

type GoogleCloudRetailV2alphaPurgeProductsResponse struct {// PurgeCount: The total count of products purged as a result of the operation.PurgeCountint64 `json:"purgeCount,omitempty,string"`// PurgeSample: A sample of the product names that will be deleted. Only// populated if `force` is set to false. A max of 100 names will be returned// and the names are chosen at random.PurgeSample []string `json:"purgeSample,omitempty"`// ForceSendFields is a list of field names (e.g. "PurgeCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PurgeCount") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPurgeProductsResponse: Response of thePurgeProductsRequest. If the long running operation is successfully done,then this message is returned by the google.longrunning.Operations.responsefield.

func (GoogleCloudRetailV2alphaPurgeProductsResponse)MarshalJSONadded inv0.74.0

typeGoogleCloudRetailV2alphaPurgeUserEventsRequest

type GoogleCloudRetailV2alphaPurgeUserEventsRequest struct {// Filter: Required. The filter string to specify the events to be deleted with// a length limit of 5,000 characters. Empty string filter is not allowed. The// eligible fields for filtering are: * `eventType`: Double quoted// UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu" format. *// `visitorId`: Double quoted string. Specifying this will delete all events// associated with a visitor. * `userId`: Double quoted string. Specifying this// will delete all events associated with a user. Examples: * Deleting all// events in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime <// "2012-04-23T18:30:43.511Z" * Deleting specific eventType in time range:// `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view" *// Deleting all events for a specific visitor: `visitorId = "visitor1024" The// filtering fields are assumed to have an implicit AND.Filterstring `json:"filter,omitempty"`// Force: Actually perform the purge. If `force` is set to false, the method// will return the expected purge count without deleting any user events.Forcebool `json:"force,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Filter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPurgeUserEventsRequest: Request message forPurgeUserEvents method.

func (GoogleCloudRetailV2alphaPurgeUserEventsRequest)MarshalJSON

typeGoogleCloudRetailV2alphaPurgeUserEventsResponse

type GoogleCloudRetailV2alphaPurgeUserEventsResponse struct {// PurgedEventsCount: The total count of events purged as a result of the// operation.PurgedEventsCountint64 `json:"purgedEventsCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "PurgedEventsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PurgedEventsCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaPurgeUserEventsResponse: Response of thePurgeUserEventsRequest. If the long running operation is successfully done,then this message is returned by the google.longrunning.Operations.responsefield.

func (GoogleCloudRetailV2alphaPurgeUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2alphaRatingadded inv0.52.0

type GoogleCloudRetailV2alphaRating struct {// AverageRating: The average rating of the Product. The rating is scaled at// 1-5. Otherwise, an INVALID_ARGUMENT error is returned.AverageRatingfloat64 `json:"averageRating,omitempty"`// RatingCount: The total number of ratings. This value is independent of the// value of rating_histogram. This value must be nonnegative. Otherwise, an// INVALID_ARGUMENT error is returned.RatingCountint64 `json:"ratingCount,omitempty"`// RatingHistogram: List of rating counts per rating value (index = rating -// 1). The list is empty if there is no rating. If the list is non-empty, its// size is always 5. Otherwise, an INVALID_ARGUMENT error is returned. For// example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings// with 1 star, 14 ratings with 2 star, and so on.RatingHistogram []int64 `json:"ratingHistogram,omitempty"`// ForceSendFields is a list of field names (e.g. "AverageRating") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AverageRating") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRating: The rating of a Product.

func (GoogleCloudRetailV2alphaRating)MarshalJSONadded inv0.52.0

func (sGoogleCloudRetailV2alphaRating) MarshalJSON() ([]byte,error)

func (*GoogleCloudRetailV2alphaRating)UnmarshalJSONadded inv0.52.0

func (s *GoogleCloudRetailV2alphaRating) UnmarshalJSON(data []byte)error

typeGoogleCloudRetailV2alphaRejoinUserEventsMetadata

type GoogleCloudRetailV2alphaRejoinUserEventsMetadata struct {}

GoogleCloudRetailV2alphaRejoinUserEventsMetadata: Metadata for`RejoinUserEvents` method.

typeGoogleCloudRetailV2alphaRejoinUserEventsRequest

type GoogleCloudRetailV2alphaRejoinUserEventsRequest struct {// UserEventRejoinScope: The type of the user event rejoin to define the scope// and range of the user events to be rejoined with the latest product catalog.// Defaults to `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set,// or set to an invalid integer value.//// Possible values://   "USER_EVENT_REJOIN_SCOPE_UNSPECIFIED" - Rejoin all events with the latest// product catalog, including both joined events and unjoined events.//   "JOINED_EVENTS" - Only rejoin joined events with the latest product// catalog.//   "UNJOINED_EVENTS" - Only rejoin unjoined events with the latest product// catalog.UserEventRejoinScopestring `json:"userEventRejoinScope,omitempty"`// ForceSendFields is a list of field names (e.g. "UserEventRejoinScope") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "UserEventRejoinScope") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRejoinUserEventsRequest: Request message forRejoinUserEvents method.

func (GoogleCloudRetailV2alphaRejoinUserEventsRequest)MarshalJSON

typeGoogleCloudRetailV2alphaRejoinUserEventsResponse

type GoogleCloudRetailV2alphaRejoinUserEventsResponse struct {// RejoinedUserEventsCount: Number of user events that were joined with latest// product catalog.RejoinedUserEventsCountint64 `json:"rejoinedUserEventsCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "RejoinedUserEventsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RejoinedUserEventsCount") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRejoinUserEventsResponse: Response message for`RejoinUserEvents` method.

func (GoogleCloudRetailV2alphaRejoinUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2alphaRemoveCatalogAttributeRequestadded inv0.71.0

type GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest struct {// Key: Required. The attribute name key of the CatalogAttribute to remove.Keystring `json:"key,omitempty"`// ForceSendFields is a list of field names (e.g. "Key") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Key") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest: Request forCatalogService.RemoveCatalogAttribute method.

func (GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest)MarshalJSONadded inv0.71.0

typeGoogleCloudRetailV2alphaRemoveControlRequestadded inv0.66.0

type GoogleCloudRetailV2alphaRemoveControlRequest struct {// ControlId: Required. The id of the control to apply. Assumed to be in the// same catalog as the serving config.ControlIdstring `json:"controlId,omitempty"`// ForceSendFields is a list of field names (e.g. "ControlId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ControlId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRemoveControlRequest: Request for RemoveControlmethod.

func (GoogleCloudRetailV2alphaRemoveControlRequest)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaRemoveFulfillmentPlacesMetadataadded inv0.52.0

type GoogleCloudRetailV2alphaRemoveFulfillmentPlacesMetadata struct {}

GoogleCloudRetailV2alphaRemoveFulfillmentPlacesMetadata: Metadata related tothe progress of the RemoveFulfillmentPlaces operation. Currently emptybecause there is no meaningful metadata populated from theProductService.RemoveFulfillmentPlaces method.

typeGoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequestadded inv0.52.0

type GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest struct {// AllowMissing: If set to true, and the Product is not found, the fulfillment// information will still be processed and retained for at most 1 day and// processed once the Product is created. If set to false, a NOT_FOUND error is// returned if the Product is not found.AllowMissingbool `json:"allowMissing,omitempty"`// PlaceIds: Required. The IDs for this type, such as the store IDs for// "pickup-in-store" or the region IDs for "same-day-delivery", to be removed// for this type. At least 1 value is required, and a maximum of 2000 values// are allowed. Each value must be a string with a length limit of 10// characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or// "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.PlaceIds []string `json:"placeIds,omitempty"`// RemoveTime: The time when the fulfillment updates are issued, used to// prevent out-of-order updates on fulfillment information. If not provided,// the internal system time will be used.RemoveTimestring `json:"removeTime,omitempty"`// Type: Required. The fulfillment type, including commonly used types (such as// pickup in store and same day delivery), and custom types. Supported values:// * "pickup-in-store" * "ship-to-store" * "same-day-delivery" *// "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" *// "custom-type-4" * "custom-type-5" If this field is set to an invalid value// other than these, an INVALID_ARGUMENT error is returned. This field directly// corresponds to Product.fulfillment_info.type.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowMissing") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowMissing") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest: Request message forProductService.RemoveFulfillmentPlaces method.

func (GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaRemoveFulfillmentPlacesResponseadded inv0.52.0

type GoogleCloudRetailV2alphaRemoveFulfillmentPlacesResponse struct {}

GoogleCloudRetailV2alphaRemoveFulfillmentPlacesResponse: Response of theRemoveFulfillmentPlacesRequest. Currently empty because there is nomeaningful response populated from theProductService.RemoveFulfillmentPlaces method.

typeGoogleCloudRetailV2alphaRemoveLocalInventoriesMetadataadded inv0.61.0

type GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata struct {}

GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata: Metadata related tothe progress of the RemoveLocalInventories operation. Currently emptybecause there is no meaningful metadata populated from theProductService.RemoveLocalInventories method.

typeGoogleCloudRetailV2alphaRemoveLocalInventoriesRequestadded inv0.61.0

type GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest struct {// AllowMissing: If set to true, and the Product is not found, the local// inventory removal request will still be processed and retained for at most 1// day and processed once the Product is created. If set to false, a NOT_FOUND// error is returned if the Product is not found.AllowMissingbool `json:"allowMissing,omitempty"`// PlaceIds: Required. A list of place IDs to have their inventory deleted. At// most 3000 place IDs are allowed per request.PlaceIds []string `json:"placeIds,omitempty"`// RemoveTime: The time when the inventory deletions are issued. Used to// prevent out-of-order updates and deletions on local inventory fields. If not// provided, the internal system time will be used.RemoveTimestring `json:"removeTime,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowMissing") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowMissing") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest: Request message forProductService.RemoveLocalInventories method.

func (GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest)MarshalJSONadded inv0.61.0

typeGoogleCloudRetailV2alphaRemoveLocalInventoriesResponseadded inv0.61.0

type GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse struct {}

GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse: Response of theProductService.RemoveLocalInventories API. Currently empty because there isno meaningful response populated from theProductService.RemoveLocalInventories method.

typeGoogleCloudRetailV2alphaReplaceCatalogAttributeRequestadded inv0.71.0

type GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest struct {// CatalogAttribute: Required. The updated CatalogAttribute.CatalogAttribute *GoogleCloudRetailV2alphaCatalogAttribute `json:"catalogAttribute,omitempty"`// UpdateMask: Indicates which fields in the provided CatalogAttribute to// update. The following are NOT supported: * CatalogAttribute.key If not set,// all supported fields are updated.UpdateMaskstring `json:"updateMask,omitempty"`// ForceSendFields is a list of field names (e.g. "CatalogAttribute") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CatalogAttribute") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest: Request forCatalogService.ReplaceCatalogAttribute method.

func (GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest)MarshalJSONadded inv0.71.0

typeGoogleCloudRetailV2alphaResumeModelRequestadded inv0.89.0

type GoogleCloudRetailV2alphaResumeModelRequest struct {}

GoogleCloudRetailV2alphaResumeModelRequest: Request for resuming training ofa model.

typeGoogleCloudRetailV2alphaRuleadded inv0.66.0

type GoogleCloudRetailV2alphaRule struct {// BoostAction: A boost action.BoostAction *GoogleCloudRetailV2alphaRuleBoostAction `json:"boostAction,omitempty"`// Condition: Required. The condition that triggers the rule. If the condition// is empty, the rule will always apply.Condition *GoogleCloudRetailV2alphaCondition `json:"condition,omitempty"`// DoNotAssociateAction: Prevents term from being associated with other terms.DoNotAssociateAction *GoogleCloudRetailV2alphaRuleDoNotAssociateAction `json:"doNotAssociateAction,omitempty"`// FilterAction: Filters results.FilterAction *GoogleCloudRetailV2alphaRuleFilterAction `json:"filterAction,omitempty"`// ForceReturnFacetAction: Force returns an attribute as a facet in the// request.ForceReturnFacetAction *GoogleCloudRetailV2alphaRuleForceReturnFacetAction `json:"forceReturnFacetAction,omitempty"`// IgnoreAction: Ignores specific terms from query during search.IgnoreAction *GoogleCloudRetailV2alphaRuleIgnoreAction `json:"ignoreAction,omitempty"`// OnewaySynonymsAction: Treats specific term as a synonym with a group of// terms. Group of terms will not be treated as synonyms with the specific// term.OnewaySynonymsAction *GoogleCloudRetailV2alphaRuleOnewaySynonymsAction `json:"onewaySynonymsAction,omitempty"`// PinAction: Pins one or more specified products to a specific position in the// results.PinAction *GoogleCloudRetailV2alphaRulePinAction `json:"pinAction,omitempty"`// RedirectAction: Redirects a shopper to a specific page.RedirectAction *GoogleCloudRetailV2alphaRuleRedirectAction `json:"redirectAction,omitempty"`// RemoveFacetAction: Remove an attribute as a facet in the request (if// present).RemoveFacetAction *GoogleCloudRetailV2alphaRuleRemoveFacetAction `json:"removeFacetAction,omitempty"`// ReplacementAction: Replaces specific terms in the query.ReplacementAction *GoogleCloudRetailV2alphaRuleReplacementAction `json:"replacementAction,omitempty"`// TwowaySynonymsAction: Treats a set of terms as synonyms of one another.TwowaySynonymsAction *GoogleCloudRetailV2alphaRuleTwowaySynonymsAction `json:"twowaySynonymsAction,omitempty"`// ForceSendFields is a list of field names (e.g. "BoostAction") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BoostAction") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRule: A rule is a condition-action pair * Acondition defines when a rule is to be triggered. * An action specifies whatoccurs on that trigger. Currently rules only work for controls withSOLUTION_TYPE_SEARCH.

func (GoogleCloudRetailV2alphaRule)MarshalJSONadded inv0.66.0

func (sGoogleCloudRetailV2alphaRule) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaRuleBoostActionadded inv0.66.0

type GoogleCloudRetailV2alphaRuleBoostAction struct {// Boost: Strength of the condition boost, which must be in [-1, 1]. Negative// boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big// promotion. However, it does not necessarily mean that the boosted item will// be the top result at all times, nor that other items will be excluded.// Results could still be shown even when none of them matches the condition.// And results that are significantly more relevant to the search query can// still trump your heavily favored but irrelevant items. Setting to -1.0 gives// the item a big demotion. However, results that are deeply relevant might// still be shown. The item will have an upstream battle to get a fairly high// ranking, but it is not blocked out completely. Setting to 0.0 means no boost// applied. The boosting condition is ignored.Boostfloat64 `json:"boost,omitempty"`// ProductsFilter: The filter can have a max size of 5000 characters. An// expression which specifies which products to apply an action to. The syntax// and supported fields are the same as a filter expression. See// SearchRequest.filter for detail syntax and limitations. Examples: * To boost// products with product ID "product_1" or "product_2", and color "Red" or// "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies:// ANY("Red", "Blue")) *ProductsFilterstring `json:"productsFilter,omitempty"`// ForceSendFields is a list of field names (e.g. "Boost") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Boost") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleBoostAction: A boost action to apply to resultsmatching condition specified above.

func (GoogleCloudRetailV2alphaRuleBoostAction)MarshalJSONadded inv0.66.0

func (*GoogleCloudRetailV2alphaRuleBoostAction)UnmarshalJSONadded inv0.66.0

func (s *GoogleCloudRetailV2alphaRuleBoostAction) UnmarshalJSON(data []byte)error

typeGoogleCloudRetailV2alphaRuleDoNotAssociateActionadded inv0.66.0

type GoogleCloudRetailV2alphaRuleDoNotAssociateAction struct {// DoNotAssociateTerms: Cannot contain duplicates or the query term. Can// specify up to 100 terms.DoNotAssociateTerms []string `json:"doNotAssociateTerms,omitempty"`// QueryTerms: Terms from the search query. Will not consider// do_not_associate_terms for search if in search query. Can specify up to 100// terms.QueryTerms []string `json:"queryTerms,omitempty"`// Terms: Will be [deprecated = true] post migration;Terms []string `json:"terms,omitempty"`// ForceSendFields is a list of field names (e.g. "DoNotAssociateTerms") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DoNotAssociateTerms") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleDoNotAssociateAction: Prevents `query_term` frombeing associated with specified terms during search. Example: Don'tassociate "gShoe" and "cheap".

func (GoogleCloudRetailV2alphaRuleDoNotAssociateAction)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaRuleFilterActionadded inv0.66.0

type GoogleCloudRetailV2alphaRuleFilterAction struct {// Filter: A filter to apply on the matching condition results. Supported// features: * filter must be set. * Filter syntax is identical to// SearchRequest.filter. For more information, see Filter// (/retail/docs/filter-and-order#filter). * To filter products with product ID// "product_1" or "product_2", and color "Red" or "Blue": *(id:// ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue"))// *Filterstring `json:"filter,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Filter") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleFilterAction: * Rule Condition: - NoCondition.query_terms provided is a global match. - 1 or moreCondition.query_terms provided are combined with OR operator. * ActionInput: The request query and filter that are applied to the retrievedproducts, in addition to any filters already provided with theSearchRequest. The AND operator is used to combine the query's existingfilters with the filter rule(s). NOTE: May result in 0 results when filtersconflict. * Action Result: Filters the returned objects to be ONLY thosethat passed the filter.

func (GoogleCloudRetailV2alphaRuleFilterAction)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaRuleForceReturnFacetActionadded inv0.139.0

type GoogleCloudRetailV2alphaRuleForceReturnFacetAction struct {// FacetPositionAdjustments: Each instance corresponds to a force return// attribute for the given condition. There can't be more 15 instances here.FacetPositionAdjustments []*GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment `json:"facetPositionAdjustments,omitempty"`// ForceSendFields is a list of field names (e.g. "FacetPositionAdjustments")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FacetPositionAdjustments") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleForceReturnFacetAction: Force returns anattribute/facet in the request around a certain position or above. * RuleCondition: Must specify non-empty Condition.query_terms (for search only) orCondition.page_categories (for browse only), but can't specify both. *Action Inputs: attribute name, position * Action Result: Will force return afacet key around a certain position or above if the condition is satisfied.Example: Suppose the query is "shoes", the Condition.query_terms is "shoes",the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size"and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Twocases: a) The facet key "size" is not already in the top 8 slots, then thefacet "size" will appear at a position close to 8. b) The facet key "size"in among the top 8 positions in the request, then it will stay at itscurrent rank.

func (GoogleCloudRetailV2alphaRuleForceReturnFacetAction)MarshalJSONadded inv0.139.0

typeGoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentadded inv0.139.0

type GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment struct {// AttributeName: The attribute name to force return as a facet. Each attribute// name should be a valid attribute name, be non-empty and contain at most 80// characters long.AttributeNamestring `json:"attributeName,omitempty"`// Position: This is the position in the request as explained above. It should// be strictly positive be at most 100.Positionint64 `json:"position,omitempty"`// ForceSendFields is a list of field names (e.g. "AttributeName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AttributeName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment:Each facet position adjustment consists of a single attribute name (i.e.facet key) along with a specified position.

func (GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment)MarshalJSONadded inv0.139.0

typeGoogleCloudRetailV2alphaRuleIgnoreActionadded inv0.66.0

type GoogleCloudRetailV2alphaRuleIgnoreAction struct {// IgnoreTerms: Terms to ignore in the search query.IgnoreTerms []string `json:"ignoreTerms,omitempty"`// ForceSendFields is a list of field names (e.g. "IgnoreTerms") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IgnoreTerms") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleIgnoreAction: Prevents a term in the query frombeing used in search. Example: Don't search for "shoddy".

func (GoogleCloudRetailV2alphaRuleIgnoreAction)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaRuleOnewaySynonymsActionadded inv0.66.0

type GoogleCloudRetailV2alphaRuleOnewaySynonymsAction struct {// OnewayTerms: Will be [deprecated = true] post migration;OnewayTerms []string `json:"onewayTerms,omitempty"`// QueryTerms: Terms from the search query. Will treat synonyms as their// synonyms. Not themselves synonyms of the synonyms. Can specify up to 100// terms.QueryTerms []string `json:"queryTerms,omitempty"`// Synonyms: Defines a set of synonyms. Cannot contain duplicates. Can specify// up to 100 synonyms.Synonyms []string `json:"synonyms,omitempty"`// ForceSendFields is a list of field names (e.g. "OnewayTerms") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "OnewayTerms") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleOnewaySynonymsAction: Maps a set of terms to aset of synonyms. Set of synonyms will be treated as synonyms of each queryterm only. `query_terms` will not be treated as synonyms of each other.Example: "sneakers" will use a synonym of "shoes". "shoes" will not use asynonym of "sneakers".

func (GoogleCloudRetailV2alphaRuleOnewaySynonymsAction)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaRulePinActionadded inv0.216.0

type GoogleCloudRetailV2alphaRulePinAction struct {// PinMap: Required. A map of positions to product_ids. Partial matches per// action are allowed, if a certain position in the map is already filled that// `[position, product_id]` pair will be ignored but the rest may still be// applied. This case will only occur if multiple pin actions are matched to a// single request, as the map guarantees that pin positions are unique within// the same action. Duplicate product_ids are not permitted within a single pin// map. The max size of this map is 120, equivalent to the max request page// size// (https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).PinMap map[string]string `json:"pinMap,omitempty"`// ForceSendFields is a list of field names (e.g. "PinMap") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PinMap") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRulePinAction: Pins one or more specified productsto a specific position in the results. * Rule Condition: Must specifynon-empty Condition.query_terms (for search only) orCondition.page_categories (for browse only), but can't specify both. *Action Input: mapping of `[pin_position, product_id]` pairs (pin positionuses 1-based indexing). * Action Result: Will pin products with matching idsto the position specified in the final result order. Example: Suppose thequery is `shoes`, the Condition.query_terms is `shoes` and the pin_map has`{1, "pid1"}`, then product with `pid1` will be pinned to the top positionin the final results. If multiple PinActions are matched to a single requestthe actions will be processed from most to least recently updated. Pins topositions larger than the max allowed page size of 120 are not allowed.

func (GoogleCloudRetailV2alphaRulePinAction)MarshalJSONadded inv0.216.0

typeGoogleCloudRetailV2alphaRuleRedirectActionadded inv0.66.0

type GoogleCloudRetailV2alphaRuleRedirectAction struct {// RedirectUri: URL must have length equal or less than 2000 characters.RedirectUristring `json:"redirectUri,omitempty"`// ForceSendFields is a list of field names (e.g. "RedirectUri") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RedirectUri") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleRedirectAction: Redirects a shopper to aspecific page. * Rule Condition: Must specify Condition.query_terms. *Action Input: Request Query * Action Result: Redirects shopper to provideduri.

func (GoogleCloudRetailV2alphaRuleRedirectAction)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaRuleRemoveFacetActionadded inv0.139.0

type GoogleCloudRetailV2alphaRuleRemoveFacetAction struct {// AttributeNames: The attribute names (i.e. facet keys) to remove from the// dynamic facets (if present in the request). There can't be more 3 attribute// names. Each attribute name should be a valid attribute name, be non-empty// and contain at most 80 characters.AttributeNames []string `json:"attributeNames,omitempty"`// ForceSendFields is a list of field names (e.g. "AttributeNames") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AttributeNames") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleRemoveFacetAction: Removes an attribute/facet inthe request if is present. * Rule Condition: Must specify non-emptyCondition.query_terms (for search only) or Condition.page_categories (forbrowse only), but can't specify both. * Action Input: attribute name *Action Result: Will remove the attribute (as a facet) from the request if itis present. Example: Suppose the query is "shoes", the Condition.query_termsis "shoes" and the attribute name "size", then facet key "size" will beremoved from the request (if it is present).

func (GoogleCloudRetailV2alphaRuleRemoveFacetAction)MarshalJSONadded inv0.139.0

typeGoogleCloudRetailV2alphaRuleReplacementActionadded inv0.66.0

type GoogleCloudRetailV2alphaRuleReplacementAction struct {// QueryTerms: Terms from the search query. Will be replaced by replacement// term. Can specify up to 100 terms.QueryTerms []string `json:"queryTerms,omitempty"`// ReplacementTerm: Term that will be used for replacement.ReplacementTermstring `json:"replacementTerm,omitempty"`// Term: Will be [deprecated = true] post migration;Termstring `json:"term,omitempty"`// ForceSendFields is a list of field names (e.g. "QueryTerms") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "QueryTerms") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleReplacementAction: Replaces a term in the query.Multiple replacement candidates can be specified. All `query_terms` will bereplaced with the replacement term. Example: Replace "gShoe" with "googleshoe".

func (GoogleCloudRetailV2alphaRuleReplacementAction)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaRuleTwowaySynonymsActionadded inv0.66.0

type GoogleCloudRetailV2alphaRuleTwowaySynonymsAction struct {// Synonyms: Defines a set of synonyms. Can specify up to 100 synonyms. Must// specify at least 2 synonyms.Synonyms []string `json:"synonyms,omitempty"`// ForceSendFields is a list of field names (e.g. "Synonyms") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Synonyms") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaRuleTwowaySynonymsAction: Creates a set of termsthat will be treated as synonyms of each other. Example: synonyms of"sneakers" and "shoes": * "sneakers" will use a synonym of "shoes". *"shoes" will use a synonym of "sneakers".

func (GoogleCloudRetailV2alphaRuleTwowaySynonymsAction)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaSafetySettingadded inv0.244.0

type GoogleCloudRetailV2alphaSafetySetting struct {// Category: Harm category.//// Possible values://   "HARM_CATEGORY_UNSPECIFIED" - The harm category is unspecified.//   "HARM_CATEGORY_HATE_SPEECH" - The harm category is hate speech.//   "HARM_CATEGORY_DANGEROUS_CONTENT" - The harm category is dangerous// content.//   "HARM_CATEGORY_HARASSMENT" - The harm category is harassment.//   "HARM_CATEGORY_SEXUALLY_EXPLICIT" - The harm category is sexually explicit// content.//   "HARM_CATEGORY_CIVIC_INTEGRITY" - The harm category is civic integrity.Categorystring `json:"category,omitempty"`// Method: Optional. Specify if the threshold is used for probability or// severity score. If not specified, the threshold is used for probability// score.//// Possible values://   "HARM_BLOCK_METHOD_UNSPECIFIED" - The harm block method is unspecified.//   "SEVERITY" - The harm block method uses both probability and severity// scores.//   "PROBABILITY" - The harm block method uses the probability score.Methodstring `json:"method,omitempty"`// Threshold: The harm block threshold.//// Possible values://   "HARM_BLOCK_THRESHOLD_UNSPECIFIED" - Unspecified harm block threshold.//   "BLOCK_LOW_AND_ABOVE" - Block low threshold and above (i.e. block more).//   "BLOCK_MEDIUM_AND_ABOVE" - Block medium threshold and above.//   "BLOCK_ONLY_HIGH" - Block only high threshold (i.e. block less).//   "BLOCK_NONE" - Block none.//   "OFF" - Turn off the safety filter.Thresholdstring `json:"threshold,omitempty"`// ForceSendFields is a list of field names (e.g. "Category") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Category") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSafetySetting: Safety settings.

func (GoogleCloudRetailV2alphaSafetySetting)MarshalJSONadded inv0.244.0

typeGoogleCloudRetailV2alphaSearchRequestadded inv0.52.0

type GoogleCloudRetailV2alphaSearchRequest struct {// BoostSpec: Boost specification to boost certain products. For more// information, see Boost results// (https://cloud.google.com/retail/docs/boosting). Notice that if both// ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the// boost conditions from both places are evaluated. If a search request matches// multiple boost conditions, the final boost score is equal to the sum of the// boost scores from all matched boost conditions.BoostSpec *GoogleCloudRetailV2alphaSearchRequestBoostSpec `json:"boostSpec,omitempty"`// Branch: The branch resource name, such as// `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use// "default_branch" as the branch ID or leave this field empty, to search// products under the default branch.Branchstring `json:"branch,omitempty"`// CanonicalFilter: The default filter that is applied when a user performs a// search without checking any filters on the search page. The filter applied// to every search request when quality improvement such as query expansion is// needed. In the case a query does not have a sufficient amount of results// this filter will be used to determine whether or not to enable the query// expansion flow. The original filter will still be used for the query// expanded search. This field is strongly recommended to achieve high search// quality. For more information about filter syntax, see SearchRequest.filter.CanonicalFilterstring `json:"canonicalFilter,omitempty"`// ConversationalSearchSpec: Optional. This field specifies all conversational// related parameters addition to traditional retail search.ConversationalSearchSpec *GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec `json:"conversationalSearchSpec,omitempty"`// DynamicFacetSpec: Deprecated. Refer to//https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic// facets. Do not set this field. The specification for dynamically generated// facets. Notice that only textual facets can be dynamically generated.DynamicFacetSpec *GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec `json:"dynamicFacetSpec,omitempty"`// Entity: 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 search results boosted by entity.Entitystring `json:"entity,omitempty"`// ExperimentId: Optional. An ID for the experiment group this search belongs// to.ExperimentIdstring `json:"experimentId,omitempty"`// FacetSpecs: Facet specifications for faceted search. If empty, no facets are// returned. A maximum of 200 values are allowed. Otherwise, an// INVALID_ARGUMENT error is returned.FacetSpecs []*GoogleCloudRetailV2alphaSearchRequestFacetSpec `json:"facetSpecs,omitempty"`// Filter: The filter syntax consists of an expression language for// constructing a predicate from one or more fields of the products being// filtered. Filter expression is case-sensitive. For more information, see// Filter (https://cloud.google.com/retail/docs/filter-and-order#filter). If// this field is unrecognizable, an INVALID_ARGUMENT is returned.Filterstring `json:"filter,omitempty"`// Labels: The labels applied to a resource must meet the following// requirements: * Each resource can have multiple labels, up to a maximum of// 64. * Each label must be a key-value pair. * Keys have a minimum length of 1// character and a maximum length of 63 characters and cannot be empty. Values// can be empty and have a maximum length of 63 characters. * Keys and values// can contain only lowercase letters, numeric characters, underscores, and// dashes. All characters must use UTF-8 encoding, and international characters// are allowed. * The key portion of a label must be unique. However, you can// use the same key with multiple resources. * Keys must start with a lowercase// letter or international character. For more information, see Requirements// for labels// (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)// in the Resource Manager documentation.Labels map[string]string `json:"labels,omitempty"`// LanguageCode: Optional. The BCP-47 language code, such as "en-US" or// "sr-Latn" list (https://www.unicode.org/cldr/charts/46/summary/root.html).// For more information, see Standardized codes (https://google.aip.dev/143).// This field helps to better interpret the query. If a value isn't specified,// the query language code is automatically detected, which may not be// accurate.LanguageCodestring `json:"languageCode,omitempty"`// Offset: A 0-indexed integer that specifies the current offset (that is,// starting result location, amongst the Products deemed by the API as// relevant) in search results. This field is only considered if page_token is// unset. If this field is negative, an INVALID_ARGUMENT is returned.Offsetint64 `json:"offset,omitempty"`// OrderBy: The order in which products are returned. Products can be ordered// by a field in an Product object. Leave it unset if ordered by relevance.// OrderBy expression is case-sensitive. For more information, see Order// (https://cloud.google.com/retail/docs/filter-and-order#order). If this field// is unrecognizable, an INVALID_ARGUMENT is returned.OrderBystring `json:"orderBy,omitempty"`// PageCategories: The categories associated with a category page. Must be set// for category navigation queries to achieve good search quality. The format// should be the same as UserEvent.page_categories; To represent full path of// category, use '>' sign to separate different hierarchies. If '>' is part of// the category name, replace it with other character(s). Category pages// include special pages such as sales or promotions. For instance, a special// sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017// Black Friday Deals"].PageCategories []string `json:"pageCategories,omitempty"`// PageSize: Maximum number of Products to return. If unspecified, defaults to// a reasonable value. The maximum allowed value is 120. Values above 120 will// be coerced to 120. If this field is negative, an INVALID_ARGUMENT is// returned.PageSizeint64 `json:"pageSize,omitempty"`// PageToken: A page token SearchResponse.next_page_token, received from a// previous SearchService.Search call. Provide this to retrieve the subsequent// page. When paginating, all other parameters provided to SearchService.Search// must match the call that provided the page token. Otherwise, an// INVALID_ARGUMENT error is returned.PageTokenstring `json:"pageToken,omitempty"`// PersonalizationSpec: The specification for personalization. Notice that if// both ServingConfig.personalization_spec and// SearchRequest.personalization_spec are set.// SearchRequest.personalization_spec will override// ServingConfig.personalization_spec.PersonalizationSpec *GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec `json:"personalizationSpec,omitempty"`// PlaceId: Optional. An id corresponding to a place, such as a store id or// region id. When specified, we use the price from the local inventory with// the matching product's LocalInventory.place_id for revenue optimization.PlaceIdstring `json:"placeId,omitempty"`// Query: Raw search query. If this field is empty, the request is considered a// category browsing request and returned results are based on filter and// page_categories.Querystring `json:"query,omitempty"`// QueryExpansionSpec: The query expansion specification that specifies the// conditions under which query expansion occurs. For more information, see// Query expansion// (https://cloud.google.com/retail/docs/result-size#query_expansion).QueryExpansionSpec *GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec `json:"queryExpansionSpec,omitempty"`// RegionCode: Optional. The Unicode country/region code (CLDR) of a location,// such as "US" and "419" list// (https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html).// For more information, see Standardized codes (https://google.aip.dev/143).// If set, then results will be boosted based on the region_code provided.RegionCodestring `json:"regionCode,omitempty"`// RelevanceThreshold: The relevance threshold of the search results. Defaults// to RelevanceThreshold.HIGH, which means only the most relevant results are// shown, and the least number of results are returned. For more information,// see Adjust result size// (https://cloud.google.com/retail/docs/result-size#relevance_thresholding).//// Possible values://   "RELEVANCE_THRESHOLD_UNSPECIFIED" - Default value. In this case, server// behavior defaults to RelevanceThreshold.HIGH.//   "HIGH" - High relevance threshold.//   "MEDIUM" - Medium relevance threshold.//   "LOW" - Low relevance threshold.//   "LOWEST" - Lowest relevance threshold.RelevanceThresholdstring `json:"relevanceThreshold,omitempty"`// SearchMode: The search mode of the search request. If not specified, a// single search request triggers both product search and faceted search.//// Possible values://   "SEARCH_MODE_UNSPECIFIED" - Default value. In this case both product// search and faceted search will be performed. Both// SearchResponse.SearchResult and SearchResponse.Facet will be returned.//   "PRODUCT_SEARCH_ONLY" - Only product search will be performed. The faceted// search will be disabled. Only SearchResponse.SearchResult will be returned.// SearchResponse.Facet will not be returned, even if SearchRequest.facet_specs// or SearchRequest.dynamic_facet_spec is set.//   "FACETED_SEARCH_ONLY" - Only faceted search will be performed. The product// search will be disabled. When in this mode, one or both of// SearchRequest.facet_specs and SearchRequest.dynamic_facet_spec should be// set. Otherwise, an INVALID_ARGUMENT error is returned. Only// SearchResponse.Facet will be returned. SearchResponse.SearchResult will not// be returned.SearchModestring `json:"searchMode,omitempty"`// SpellCorrectionSpec: The spell correction specification that specifies the// mode under which spell correction will take effect.SpellCorrectionSpec *GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec `json:"spellCorrectionSpec,omitempty"`// TileNavigationSpec: Optional. This field specifies tile navigation related// parameters.TileNavigationSpec *GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec `json:"tileNavigationSpec,omitempty"`// UserAttributes: Optional. The user attributes that could be used for// personalization of search results. * Populate at most 100 key-value pairs// per query. * Only supports string keys and repeated string values. *// Duplicate keys are not allowed within a single query. Example:// user_attributes: [ { key: "pets" value { values: "dog" values: "cat" } }, {// key: "state" value { values: "CA" } } ]UserAttributes map[string]GoogleCloudRetailV2alphaStringList `json:"userAttributes,omitempty"`// UserInfo: User information.UserInfo *GoogleCloudRetailV2alphaUserInfo `json:"userInfo,omitempty"`// VariantRollupKeys: The keys to fetch and rollup the matching variant// Products attributes, FulfillmentInfo or LocalInventorys attributes. The// attributes from all the matching variant Products or LocalInventorys are// merged and de-duplicated. Notice that rollup attributes will lead to extra// query latency. Maximum number of keys is 30. For FulfillmentInfo, a// fulfillment type and a fulfillment ID must be provided in the format of// "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123",// "pickupInStore" is fulfillment type and "store123" is the store ID.// Supported keys are: * colorFamilies * price * originalPrice * discount *// variantId * inventory(place_id,price) * inventory(place_id,original_price) *// inventory(place_id,attributes.key), where key is any key in the// Product.local_inventories.attributes map. * attributes.key, where key is any// key in the Product.attributes map. * pickupInStore.id, where id is any// FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *// shipToStore.id, where id is any FulfillmentInfo.place_ids for// FulfillmentInfo.type "ship-to-store". * sameDayDelivery.id, where id is any// FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery". *// nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for// FulfillmentInfo.type "next-day-delivery". * customFulfillment1.id, where id// is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1". *// customFulfillment2.id, where id is any FulfillmentInfo.place_ids for// FulfillmentInfo.type "custom-type-2". * customFulfillment3.id, where id is// any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3". *// customFulfillment4.id, where id is any FulfillmentInfo.place_ids for// FulfillmentInfo.type "custom-type-4". * customFulfillment5.id, where id is// any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5". If// this field is set to an invalid value other than these, an INVALID_ARGUMENT// error is returned.VariantRollupKeys []string `json:"variantRollupKeys,omitempty"`// VisitorId: Required. 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. This should// be the same identifier as UserEvent.visitor_id. The field must be a UTF-8// encoded string with a length limit of 128 characters. Otherwise, an// INVALID_ARGUMENT error is returned.VisitorIdstring `json:"visitorId,omitempty"`// ForceSendFields is a list of field names (e.g. "BoostSpec") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BoostSpec") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequest: Request message forSearchService.Search method.

func (GoogleCloudRetailV2alphaSearchRequest)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchRequestBoostSpecadded inv0.52.0

type GoogleCloudRetailV2alphaSearchRequestBoostSpec struct {// ConditionBoostSpecs: Condition boost specifications. If a product matches// multiple conditions in the specifications, boost scores from these// specifications are all applied and combined in a non-linear way. Maximum// number of specifications is 20.ConditionBoostSpecs []*GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec `json:"conditionBoostSpecs,omitempty"`// SkipBoostSpecValidation: Whether to skip boostspec validation. If this field// is set to true, invalid BoostSpec.condition_boost_specs will be ignored and// valid BoostSpec.condition_boost_specs will still be applied.SkipBoostSpecValidationbool `json:"skipBoostSpecValidation,omitempty"`// ForceSendFields is a list of field names (e.g. "ConditionBoostSpecs") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConditionBoostSpecs") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestBoostSpec: Boost specification to boostcertain items.

func (GoogleCloudRetailV2alphaSearchRequestBoostSpec)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpecadded inv0.52.0

type GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec struct {// Boost: Strength of the condition boost, which should be in [-1, 1]. Negative// boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big// promotion. However, it does not necessarily mean that the boosted item will// be the top result at all times, nor that other items will be excluded.// Results could still be shown even when none of them matches the condition.// And results that are significantly more relevant to the search query can// still trump your heavily favored but irrelevant items. Setting to -1.0 gives// the item a big demotion. However, results that are deeply relevant might// still be shown. The item will have an upstream battle to get a fairly high// ranking, but it is not blocked out completely. Setting to 0.0 means no boost// applied. The boosting condition is ignored.Boostfloat64 `json:"boost,omitempty"`// Condition: An expression which specifies a boost condition. The syntax and// supported fields are the same as a filter expression. See// SearchRequest.filter for detail syntax and limitations. Examples: * To boost// products with product ID "product_1" or "product_2", and color "Red" or// "Blue": * (id: ANY("product_1", "product_2")) AND (colorFamilies:// ANY("Red","Blue"))Conditionstring `json:"condition,omitempty"`// ForceSendFields is a list of field names (e.g. "Boost") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Boost") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec: Boostapplies to products which match a condition.

func (GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec)MarshalJSONadded inv0.52.0

func (*GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec)UnmarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecadded inv0.198.0

type GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec struct {// ConversationId: This field specifies the conversation id, which maintains// the state of the conversation between client side and server side. Use the// value from the previous ConversationalSearchResult.conversation_id. For the// initial request, this should be empty.ConversationIdstring `json:"conversationId,omitempty"`// FollowupConversationRequested: This field specifies whether the customer// would like to do conversational search. If this field is set to true,// conversational related extra information will be returned from server side,// including follow-up question, answer options, etc.FollowupConversationRequestedbool `json:"followupConversationRequested,omitempty"`// UserAnswer: This field specifies the current user answer during the// conversational search. This can be either user selected from suggested// answers or user input plain text.UserAnswer *GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer `json:"userAnswer,omitempty"`// ForceSendFields is a list of field names (e.g. "ConversationId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConversationId") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec: This fieldspecifies all conversational related parameters addition to traditionalretail search.

func (GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec)MarshalJSONadded inv0.198.0

typeGoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnsweradded inv0.198.0

type GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer struct {// SelectedAnswer: This field specifies the selected attributes during the// conversational search. This should be a subset of// ConversationalSearchResult.suggested_answers.SelectedAnswer *GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer `json:"selectedAnswer,omitempty"`// TextAnswer: This field specifies the incremental input text from the user// during the conversational search.TextAnswerstring `json:"textAnswer,omitempty"`// ForceSendFields is a list of field names (e.g. "SelectedAnswer") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SelectedAnswer") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer:This field specifies the current user answer during the conversationalsearch. This can be either user selected from suggested answers or userinput plain text.

func (GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer)MarshalJSONadded inv0.198.0

typeGoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnsweradded inv0.198.0

type GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer struct {// ProductAttributeValue: This field specifies the selected answer which is a// attribute key-value.ProductAttributeValue *GoogleCloudRetailV2alphaProductAttributeValue `json:"productAttributeValue,omitempty"`// ProductAttributeValues: This field is deprecated and should not be set.ProductAttributeValues []*GoogleCloudRetailV2alphaProductAttributeValue `json:"productAttributeValues,omitempty"`// ForceSendFields is a list of field names (e.g. "ProductAttributeValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProductAttributeValue") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer: This field specifies the selected answers during theconversational search.

func (GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer)MarshalJSONadded inv0.198.0

typeGoogleCloudRetailV2alphaSearchRequestDynamicFacetSpecadded inv0.52.0

type GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec struct {// Mode: Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's// unset.//// Possible values://   "MODE_UNSPECIFIED" - Default value.//   "DISABLED" - Disable Dynamic Facet.//   "ENABLED" - Automatic mode built by Google Retail Search.Modestring `json:"mode,omitempty"`// ForceSendFields is a list of field names (e.g. "Mode") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Mode") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec: The specifications ofdynamically generated facets.

func (GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchRequestFacetSpecadded inv0.52.0

type GoogleCloudRetailV2alphaSearchRequestFacetSpec struct {// EnableDynamicPosition: Enables dynamic position for this facet. If set to// true, the position of this facet among all facets in the response is// determined by Google Retail Search. It is ordered together with dynamic// facets if dynamic facets is enabled. If set to false, the position of this// facet in the response is the same as in the request, and it is ranked before// the facets with dynamic position enable and all dynamic facets. For example,// you may always want to have rating facet returned in the response, but it's// not necessarily to always display the rating facet at the top. In that case,// you can set enable_dynamic_position to true so that the position of rating// facet in response is determined by Google Retail Search. Another example,// assuming you have the following facets in the request: * "rating",// enable_dynamic_position = true * "price", enable_dynamic_position = false *// "brands", enable_dynamic_position = false And also you have a dynamic facets// enable, which generates a facet "gender". Then, the final order of the// facets in the response can be ("price", "brands", "rating", "gender") or// ("price", "brands", "gender", "rating") depends on how Google Retail Search// orders "gender" and "rating" facets. However, notice that "price" and// "brands" are always ranked at first and second position because their// enable_dynamic_position values are false.EnableDynamicPositionbool `json:"enableDynamicPosition,omitempty"`// ExcludedFilterKeys: List of keys to exclude when faceting. By default,// FacetKey.key is not excluded from the filter unless it is listed in this// field. Listing a facet key in this field allows its values to appear as// facet results, even when they are filtered out of search results. Using this// field does not affect what search results are returned. For example, suppose// there are 100 products with the color facet "Red" and 200 products with the// color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")"// and having "colorFamilies" as FacetKey.key would by default return only// "Red" products in the search results, and also return "Red" with count 100// as the only color facet. Although there are also blue products available,// "Blue" would not be shown as an available facet value. If "colorFamilies" is// listed in "excludedFilterKeys", then the query returns the facet values// "Red" with count 100 and "Blue" with count 200, because the "colorFamilies"// key is now excluded from the filter. Because this field doesn't affect// search results, the search results are still correctly filtered to return// only "Red" products. A maximum of 100 values are allowed. Otherwise, an// INVALID_ARGUMENT error is returned.ExcludedFilterKeys []string `json:"excludedFilterKeys,omitempty"`// FacetKey: Required. The facet key specification.FacetKey *GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey `json:"facetKey,omitempty"`// Limit: Maximum of facet values that should be returned for this facet. If// unspecified, defaults to 50. The maximum allowed value is 300. Values above// 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT// is returned.Limitint64 `json:"limit,omitempty"`// ForceSendFields is a list of field names (e.g. "EnableDynamicPosition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EnableDynamicPosition") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestFacetSpec: A facet specification toperform faceted search.

func (GoogleCloudRetailV2alphaSearchRequestFacetSpec)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyadded inv0.52.0

type GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey struct {// CaseInsensitive: True to make facet keys case insensitive when getting// faceting values with prefixes or contains; false otherwise.CaseInsensitivebool `json:"caseInsensitive,omitempty"`// Contains: Only get facet values that contains the given strings. For// example, suppose "categories" has three values "Women > Shoe", "Women >// Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet// gives only "Women > Shoe" and "Men > Shoe". Only supported on textual// fields. Maximum is 10.Contains []string `json:"contains,omitempty"`// Intervals: Set only if values should be bucketized into intervals. Must be// set for facets with numerical values. Must not be set for facet with text// values. Maximum number of intervals is 40. For all numerical facet keys that// appear in the list of products from the catalog, the percentiles 0, 10, 30,// 50, 70, 90, and 100 are computed from their distribution weekly. If the// model assigns a high score to a numerical facet key and its intervals are// not specified in the search request, these percentiles become the bounds for// its intervals and are returned in the response. If the facet key intervals// are specified in the request, then the specified intervals are returned// instead.Intervals []*GoogleCloudRetailV2alphaInterval `json:"intervals,omitempty"`// Key: Required. Supported textual and numerical facet keys in Product object,// over which the facet values are computed. Facet key is case-sensitive.// Allowed facet keys when FacetKey.query is not specified: * textual_field = *// "brands" * "categories" * "genders" * "ageGroups" * "availability" *// "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" *// "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" *// "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" *// "customFulfillment2" * "customFulfillment3" * "customFulfillment4" *// "customFulfillment5" * "inventory(place_id,attributes.key)" *// numerical_field = * "price" * "discount" * "rating" * "ratingCount" *// "attributes.key" * "inventory(place_id,price)" *// "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"Keystring `json:"key,omitempty"`// OrderBy: The order in which SearchResponse.Facet.values are returned.// Allowed values are: * "count desc", which means order by// SearchResponse.Facet.values.count descending. * "value desc", which means// order by SearchResponse.Facet.values.value descending. Only applies to// textual facets. If not set, textual values are sorted in natural order// (https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are// sorted in the order given by FacetSpec.FacetKey.intervals;// FulfillmentInfo.place_ids are sorted in the order given by// FacetSpec.FacetKey.restricted_values.OrderBystring `json:"orderBy,omitempty"`// Prefixes: Only get facet values that start with the given string prefix. For// example, suppose "categories" has three values "Women > Shoe", "Women >// Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories"// facet gives only "Women > Shoe" and "Women > Dress". Only supported on// textual fields. Maximum is 10.Prefixes []string `json:"prefixes,omitempty"`// Query: The query that is used to compute facet for the given facet key. When// provided, it overrides the default behavior of facet computation. The query// syntax is the same as a filter expression. See SearchRequest.filter for// detail syntax and limitations. Notice that there is no limitation on// FacetKey.key when query is specified. In the response,// SearchResponse.Facet.values.value is always "1" and// SearchResponse.Facet.values.count is the number of results that match the// query. For example, you can set a customized facet for "shipToStore", where// FacetKey.key is "customizedShipToStore", and FacetKey.query is// "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the// facet counts the products that are both in stock and ship to store "123".Querystring `json:"query,omitempty"`// RestrictedValues: Only get facet for the given restricted values. For// example, when using "pickupInStore" as key and set restricted values to// ["store123", "store456"], only facets for "store123" and "store456" are// returned. Only supported on predefined textual fields, custom textual// attributes and fulfillments. Maximum is 20. Must be set for the fulfillment// facet keys: * pickupInStore * shipToStore * sameDayDelivery *// nextDayDelivery * customFulfillment1 * customFulfillment2 *// customFulfillment3 * customFulfillment4 * customFulfillment5RestrictedValues []string `json:"restrictedValues,omitempty"`// ReturnMinMax: Returns the min and max value for each numerical facet// intervals. Ignored for textual facets.ReturnMinMaxbool `json:"returnMinMax,omitempty"`// ForceSendFields is a list of field names (e.g. "CaseInsensitive") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CaseInsensitive") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey: Specifies how afacet is computed.

func (GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchRequestPersonalizationSpecadded inv0.67.0

type GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec struct {// Mode: Defaults to Mode.AUTO.//// Possible values://   "MODE_UNSPECIFIED" - Default value. In this case, server behavior defaults// to Mode.AUTO.//   "AUTO" - Let CRS decide whether to use personalization based on quality of// user event data.//   "DISABLED" - Disable personalization.Modestring `json:"mode,omitempty"`// ForceSendFields is a list of field names (e.g. "Mode") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Mode") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec: The specificationfor personalization.

func (GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec)MarshalJSONadded inv0.67.0

typeGoogleCloudRetailV2alphaSearchRequestQueryExpansionSpecadded inv0.52.0

type GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec struct {// Condition: The condition under which query expansion should occur. Default// to Condition.DISABLED.//// Possible values://   "CONDITION_UNSPECIFIED" - Unspecified query expansion condition. In this// case, server behavior defaults to Condition.DISABLED.//   "DISABLED" - Disabled query expansion. Only the exact search query is// used, even if SearchResponse.total_size is zero.//   "AUTO" - Automatic query expansion built by Google Retail Search.Conditionstring `json:"condition,omitempty"`// PinUnexpandedResults: Whether to pin unexpanded results. The default value// is false. If this field is set to true, unexpanded products are always at// the top of the search results, followed by the expanded results.PinUnexpandedResultsbool `json:"pinUnexpandedResults,omitempty"`// ForceSendFields is a list of field names (e.g. "Condition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Condition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec: Specification todetermine under which conditions query expansion should occur.

func (GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpecadded inv0.80.0

type GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec struct {// Mode: The mode under which spell correction should take effect to replace// the original search query. Default to Mode.AUTO.//// Possible values://   "MODE_UNSPECIFIED" - Unspecified spell correction mode. In this case,// server behavior defaults to Mode.AUTO.//   "SUGGESTION_ONLY" - Google Retail Search will try to find a spell// suggestion if there is any and put in the SearchResponse.corrected_query.// The spell suggestion will not be used as the search query.//   "AUTO" - Automatic spell correction built by Google Retail Search. Search// will be based on the corrected query if found.Modestring `json:"mode,omitempty"`// ForceSendFields is a list of field names (e.g. "Mode") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Mode") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec: The specificationfor query spell correction.

func (GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec)MarshalJSONadded inv0.80.0

typeGoogleCloudRetailV2alphaSearchRequestTileNavigationSpecadded inv0.198.0

type GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec struct {// AppliedTiles: This optional field specifies the tiles which are already// clicked in client side. While the feature works without this field set,// particularly for an initial query, it is highly recommended to set this// field because it can improve the quality of the search response and removes// possible duplicate tiles. NOTE: This field is not being used for filtering// search products. Client side should also put all the applied tiles in// SearchRequest.filter.AppliedTiles []*GoogleCloudRetailV2alphaTile `json:"appliedTiles,omitempty"`// TileNavigationRequested: This field specifies whether the customer would// like to request tile navigation.TileNavigationRequestedbool `json:"tileNavigationRequested,omitempty"`// ForceSendFields is a list of field names (e.g. "AppliedTiles") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppliedTiles") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec: This fieldspecifies tile navigation related parameters.

func (GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec)MarshalJSONadded inv0.198.0

typeGoogleCloudRetailV2alphaSearchResponseadded inv0.52.0

type GoogleCloudRetailV2alphaSearchResponse struct {// AppliedControls: The fully qualified resource name of applied controls// (https://cloud.google.com/retail/docs/serving-control-rules).AppliedControls []string `json:"appliedControls,omitempty"`// AttributionToken: A unique search token. This should be included in the// UserEvent logs resulting from this search, which enables accurate// attribution of search model performance.AttributionTokenstring `json:"attributionToken,omitempty"`// ConversationalSearchResult: This field specifies all related information// that is needed on client side for UI rendering of conversational retail// search.ConversationalSearchResult *GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult `json:"conversationalSearchResult,omitempty"`// CorrectedQuery: Contains the spell corrected query, if found. If the spell// correction type is AUTOMATIC, then the search results are based on// corrected_query. Otherwise the original query is used for search.CorrectedQuerystring `json:"correctedQuery,omitempty"`// ExperimentInfo: Metadata related to A/B testing experiment associated with// this response. Only exists when an experiment is triggered.ExperimentInfo []*GoogleCloudRetailV2alphaExperimentInfo `json:"experimentInfo,omitempty"`// Facets: Results of facets requested by user.Facets []*GoogleCloudRetailV2alphaSearchResponseFacet `json:"facets,omitempty"`// InvalidConditionBoostSpecs: The invalid// SearchRequest.BoostSpec.condition_boost_specs that are not applied during// serving.InvalidConditionBoostSpecs []*GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec `json:"invalidConditionBoostSpecs,omitempty"`// NextPageToken: A token that can be sent as SearchRequest.page_token to// retrieve the next page. If this field is omitted, there are no subsequent// pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// PinControlMetadata: Metadata for pin controls which were applicable to the// request. This contains two map fields, one for all matched pins and one for// pins which were matched but not applied. The two maps are keyed by pin// position, and the values are the product ids which were matched to that pin.PinControlMetadata *GoogleCloudRetailV2alphaPinControlMetadata `json:"pinControlMetadata,omitempty"`// QueryExpansionInfo: Query expansion information for the returned results.QueryExpansionInfo *GoogleCloudRetailV2alphaSearchResponseQueryExpansionInfo `json:"queryExpansionInfo,omitempty"`// RedirectUri: The URI of a customer-defined redirect page. If redirect action// is triggered, no search is performed, and only redirect_uri and// attribution_token are set in the response.RedirectUristring `json:"redirectUri,omitempty"`// Results: A list of matched items. The order represents the ranking.Results []*GoogleCloudRetailV2alphaSearchResponseSearchResult `json:"results,omitempty"`// TileNavigationResult: This field specifies all related information for tile// navigation that will be used in client side.TileNavigationResult *GoogleCloudRetailV2alphaSearchResponseTileNavigationResult `json:"tileNavigationResult,omitempty"`// TotalSize: The estimated total count of matched items irrespective of// pagination. The count of results returned by pagination may be less than the// total_size that matches.TotalSizeint64 `json:"totalSize,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AppliedControls") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AppliedControls") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchResponse: Response message forSearchService.Search method.

func (GoogleCloudRetailV2alphaSearchResponse)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchResponseConversationalSearchResultadded inv0.198.0

type GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult struct {// AdditionalFilter: This is the incremental additional filters implied from// the current user answer. User should add the suggested addition filters to// the previous SearchRequest.filter, and use the merged filter in the follow// up search request.AdditionalFilter *GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter `json:"additionalFilter,omitempty"`// AdditionalFilters: This field is deprecated but will be kept for backward// compatibility. There is expected to have only one additional filter and the// value will be the same to the same as field `additional_filter`.AdditionalFilters []*GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter `json:"additionalFilters,omitempty"`// ConversationId: Conversation UUID. This field will be stored in client side// storage to maintain the conversation session with server and will be used// for next search request's// SearchRequest.ConversationalSearchSpec.conversation_id to restore// conversation state in server.ConversationIdstring `json:"conversationId,omitempty"`// FollowupQuestion: The follow-up question. e.g., `What is the color?`FollowupQuestionstring `json:"followupQuestion,omitempty"`// RefinedQuery: The current refined query for the conversational search. This// field will be used in customer UI that the query in the search bar should be// replaced with the refined query. For example, if SearchRequest.query is// `dress` and next// SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red// color`, which does not match any product attribute value filters, the// refined query will be `dress, red color`.RefinedQuerystring `json:"refinedQuery,omitempty"`// SuggestedAnswers: The answer options provided to client for the follow-up// question.SuggestedAnswers []*GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer `json:"suggestedAnswers,omitempty"`// ForceSendFields is a list of field names (e.g. "AdditionalFilter") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AdditionalFilter") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult: This fieldspecifies all related information that is needed on client side for UIrendering of conversational retail search.

func (GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult)MarshalJSONadded inv0.198.0

typeGoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilteradded inv0.198.0

type GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter struct {// ProductAttributeValue: Product attribute value, including an attribute key// and an attribute value. Other types can be added here in the future.ProductAttributeValue *GoogleCloudRetailV2alphaProductAttributeValue `json:"productAttributeValue,omitempty"`// ForceSendFields is a list of field names (e.g. "ProductAttributeValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProductAttributeValue") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter: Additional filter that client side need to apply.

func (GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter)MarshalJSONadded inv0.198.0

typeGoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnsweradded inv0.198.0

type GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer struct {// ProductAttributeValue: Product attribute value, including an attribute key// and an attribute value. Other types can be added here in the future.ProductAttributeValue *GoogleCloudRetailV2alphaProductAttributeValue `json:"productAttributeValue,omitempty"`// ForceSendFields is a list of field names (e.g. "ProductAttributeValue") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProductAttributeValue") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer: Suggested answers to the follow-up question.

func (GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer)MarshalJSONadded inv0.198.0

typeGoogleCloudRetailV2alphaSearchResponseFacetadded inv0.52.0

type GoogleCloudRetailV2alphaSearchResponseFacet struct {// DynamicFacet: Whether the facet is dynamically generated.DynamicFacetbool `json:"dynamicFacet,omitempty"`// Key: The key for this facet. E.g., "colorFamilies" or "price" or// "attributes.attr1".Keystring `json:"key,omitempty"`// Values: The facet values for this field.Values []*GoogleCloudRetailV2alphaSearchResponseFacetFacetValue `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "DynamicFacet") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DynamicFacet") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchResponseFacet: A facet result.

func (GoogleCloudRetailV2alphaSearchResponseFacet)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchResponseFacetFacetValueadded inv0.52.0

type GoogleCloudRetailV2alphaSearchResponseFacetFacetValue struct {// Count: Number of items that have this facet value.Countint64 `json:"count,omitempty,string"`// Interval: Interval value for a facet, such as [10, 20) for facet "price".Interval *GoogleCloudRetailV2alphaInterval `json:"interval,omitempty"`// MaxValue: The maximum value in the FacetValue.interval. Only supported on// numerical facets and returned if// SearchRequest.FacetSpec.FacetKey.return_min_max is true.MaxValuefloat64 `json:"maxValue,omitempty"`// MinValue: The minimum value in the FacetValue.interval. Only supported on// numerical facets and returned if// SearchRequest.FacetSpec.FacetKey.return_min_max is true.MinValuefloat64 `json:"minValue,omitempty"`// Value: Text value of a facet, such as "Black" for facet "colorFamilies".Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Count") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Count") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchResponseFacetFacetValue: A facet value whichcontains value names and their count.

func (GoogleCloudRetailV2alphaSearchResponseFacetFacetValue)MarshalJSONadded inv0.52.0

func (*GoogleCloudRetailV2alphaSearchResponseFacetFacetValue)UnmarshalJSONadded inv0.92.0

typeGoogleCloudRetailV2alphaSearchResponseQueryExpansionInfoadded inv0.52.0

type GoogleCloudRetailV2alphaSearchResponseQueryExpansionInfo struct {// ExpandedQuery: Bool describing whether query expansion has occurred.ExpandedQuerybool `json:"expandedQuery,omitempty"`// PinnedResultCount: Number of pinned results. This field will only be set// when expansion happens and// SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.PinnedResultCountint64 `json:"pinnedResultCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "ExpandedQuery") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExpandedQuery") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchResponseQueryExpansionInfo: Informationdescribing query expansion including whether expansion has occurred.

func (GoogleCloudRetailV2alphaSearchResponseQueryExpansionInfo)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchResponseSearchResultadded inv0.52.0

type GoogleCloudRetailV2alphaSearchResponseSearchResult struct {// Id: Product.id of the searched Product.Idstring `json:"id,omitempty"`// MatchingVariantCount: The count of matched variant Products.MatchingVariantCountint64 `json:"matchingVariantCount,omitempty"`// MatchingVariantFields: If a variant Product matches the search query, this// map indicates which Product fields are matched. The key is the Product.name,// the value is a field mask of the matched Product fields. If matched// attributes cannot be determined, this map will be empty. For example, a key// "sku1" with field mask "products.color_info" indicates there is a match// between "sku1" ColorInfo and the query.MatchingVariantFields map[string]string `json:"matchingVariantFields,omitempty"`// ModelScores: Google provided available scores.ModelScores map[string]GoogleCloudRetailV2alphaDoubleList `json:"modelScores,omitempty"`// PersonalLabels: Specifies previous events related to this product for this// user based on UserEvent with same SearchRequest.visitor_id or// UserInfo.user_id. This is set only when// SearchRequest.PersonalizationSpec.mode is// SearchRequest.PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`:// Indicates that this product has been purchased before.PersonalLabels []string `json:"personalLabels,omitempty"`// Product: The product data snippet in the search response. Only Product.name// is guaranteed to be populated. Product.variants contains the product// variants that match the search query. If there are multiple product variants// matching the query, top 5 most relevant product variants are returned and// ordered by relevancy. If relevancy can be deternmined, use// matching_variant_fields to look up matched product variants fields. If// relevancy cannot be determined, e.g. when searching "shoe" all products in a// shoe product can be a match, 5 product variants are returned but order is// meaningless.Product *GoogleCloudRetailV2alphaProduct `json:"product,omitempty"`// VariantRollupValues: The rollup matching variant Product attributes. The key// is one of the SearchRequest.variant_rollup_keys. The values are the merged// and de-duplicated Product attributes. Notice that the rollup values are// respect filter. For example, when filtering by "colorFamilies:ANY(\"red\")"// and rollup "colorFamilies", only "red" is returned. For textual and// numerical attributes, the rollup values is a list of string or double values// with type google.protobuf.ListValue. For example, if there are two variants// with colors "red" and "blue", the rollup values are { key: "colorFamilies"// value { list_value { values { string_value: "red" } values { string_value:// "blue" } } } } For FulfillmentInfo, the rollup values is a double value with// type google.protobuf.Value. For example, `{key: "pickupInStore.store1" value// { number_value: 10 }}` means a there are 10 variants in this product are// available in the store "store1".VariantRollupValuesgoogleapi.RawMessage `json:"variantRollupValues,omitempty"`// ForceSendFields is a list of field names (e.g. "Id") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Id") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchResponseSearchResult: Represents the searchresults.

func (GoogleCloudRetailV2alphaSearchResponseSearchResult)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSearchResponseTileNavigationResultadded inv0.198.0

type GoogleCloudRetailV2alphaSearchResponseTileNavigationResult struct {// Tiles: The current tiles that are used for tile navigation, sorted by// engagement.Tiles []*GoogleCloudRetailV2alphaTile `json:"tiles,omitempty"`// ForceSendFields is a list of field names (e.g. "Tiles") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Tiles") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSearchResponseTileNavigationResult: This fieldspecifies all related information for tile navigation that will be used inclient side.

func (GoogleCloudRetailV2alphaSearchResponseTileNavigationResult)MarshalJSONadded inv0.198.0

typeGoogleCloudRetailV2alphaServingConfigadded inv0.66.0

type GoogleCloudRetailV2alphaServingConfig struct {// BoostControlIds: Condition boost specifications. If a product matches// multiple conditions in the specifications, boost scores from these// specifications are all applied and combined in a non-linear way. Maximum// number of specifications is 100. Notice that if both// ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the// boost conditions from both places are evaluated. If a search request matches// multiple boost conditions, the final boost score is equal to the sum of the// boost scores from all matched boost conditions. Can only be set if// solution_types is SOLUTION_TYPE_SEARCH.BoostControlIds []string `json:"boostControlIds,omitempty"`// DisplayName: Required. The human readable serving config display name. Used// in Retail UI. This field must be a UTF-8 encoded string with a length limit// of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.DisplayNamestring `json:"displayName,omitempty"`// DiversityLevel: How much diversity to use in recommendation model results// e.g. `medium-diversity` or `high-diversity`. Currently supported values: *// `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` *// `auto-diversity` If not specified, we choose default based on recommendation// model type. Default value: `no-diversity`. Can only be set if solution_types// is SOLUTION_TYPE_RECOMMENDATION.DiversityLevelstring `json:"diversityLevel,omitempty"`// DiversityType: What kind of diversity to use - data driven or rule based. If// unset, the server behavior defaults to RULE_BASED_DIVERSITY.//// Possible values://   "DIVERSITY_TYPE_UNSPECIFIED" - Default value.//   "RULE_BASED_DIVERSITY" - Rule based diversity.//   "DATA_DRIVEN_DIVERSITY" - Data driven diversity.DiversityTypestring `json:"diversityType,omitempty"`// DoNotAssociateControlIds: Condition do not associate specifications. If// multiple do not associate conditions match, all matching do not associate// controls in the list will execute. - Order does not matter. - Maximum number// of specifications is 100. Can only be set if solution_types is// SOLUTION_TYPE_SEARCH.DoNotAssociateControlIds []string `json:"doNotAssociateControlIds,omitempty"`// DynamicFacetSpec: The specification for dynamically generated facets. Notice// that only textual facets can be dynamically generated. Can only be set if// solution_types is SOLUTION_TYPE_SEARCH.DynamicFacetSpec *GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec `json:"dynamicFacetSpec,omitempty"`// EnableCategoryFilterLevel: Whether to add additional category filters on the// `similar-items` model. If not specified, we enable it by default. Allowed// values are: * `no-category-match`: No additional filtering of original// results from the model and the customer's filters. *// `relaxed-category-match`: Only keep results with categories that match at// least one item categories in the PredictRequests's context item. * If// customer also sends filters in the PredictRequest, then the results will// satisfy both conditions (user given and category match). Can only be set if// solution_types is SOLUTION_TYPE_RECOMMENDATION.EnableCategoryFilterLevelstring `json:"enableCategoryFilterLevel,omitempty"`// FacetControlIds: Facet specifications for faceted search. If empty, no// facets are returned. The ids refer to the ids of Control resources with only// the Facet control set. These controls are assumed to be in the same Catalog// as the ServingConfig. A maximum of 100 values are allowed. Otherwise, an// INVALID_ARGUMENT error is returned. Can only be set if solution_types is// SOLUTION_TYPE_SEARCH.FacetControlIds []string `json:"facetControlIds,omitempty"`// FilterControlIds: Condition filter specifications. If a product matches// multiple conditions in the specifications, filters from these specifications// are all applied and combined via the AND operator. Maximum number of// specifications is 100. Can only be set if solution_types is// SOLUTION_TYPE_SEARCH.FilterControlIds []string `json:"filterControlIds,omitempty"`// IgnoreControlIds: Condition ignore specifications. If multiple ignore// conditions match, all matching ignore controls in the list will execute. -// Order does not matter. - Maximum number of specifications is 100. Can only// be set if solution_types is SOLUTION_TYPE_SEARCH.IgnoreControlIds []string `json:"ignoreControlIds,omitempty"`// IgnoreRecsDenylist: When the flag is enabled, the products in the denylist// will not be filtered out in the recommendation filtering results.IgnoreRecsDenylistbool `json:"ignoreRecsDenylist,omitempty"`// ModelId: The id of the model in the same Catalog to use at serving time.// Currently only RecommendationModels are supported://https://cloud.google.com/retail/recommendations-ai/docs/create-models Can be// changed but only to a compatible model (e.g. others-you-may-like CTR to// others-you-may-like CVR). Required when solution_types is// SOLUTION_TYPE_RECOMMENDATION.ModelIdstring `json:"modelId,omitempty"`// Name: Immutable. Fully qualified name// `projects/*/locations/global/catalogs/*/servingConfig/*`Namestring `json:"name,omitempty"`// OnewaySynonymsControlIds: Condition oneway synonyms specifications. If// multiple oneway synonyms conditions match, all matching oneway synonyms// controls in the list will execute. Order of controls in the list will not// matter. Maximum number of specifications is 100. Can only be set if// solution_types is SOLUTION_TYPE_SEARCH.OnewaySynonymsControlIds []string `json:"onewaySynonymsControlIds,omitempty"`// PersonalizationSpec: The specification for personalization spec. Can only be// set if solution_types is SOLUTION_TYPE_SEARCH. Notice that if both// ServingConfig.personalization_spec and SearchRequest.personalization_spec// are set. SearchRequest.personalization_spec will override// ServingConfig.personalization_spec.PersonalizationSpec *GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec `json:"personalizationSpec,omitempty"`// PriceRerankingLevel: How much price ranking we want in serving results.// Price reranking causes product items with a similar recommendation// probability to be ordered by price, with the highest-priced items first.// This setting could result in a decrease in click-through and conversion// rates. Allowed values are: * `no-price-reranking` * `low-price-reranking` *// `medium-price-reranking` * `high-price-reranking` If not specified, we// choose default based on model type. Default value: `no-price-reranking`. Can// only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION.PriceRerankingLevelstring `json:"priceRerankingLevel,omitempty"`// RedirectControlIds: Condition redirect specifications. Only the first// triggered redirect action is applied, even if multiple apply. Maximum number// of specifications is 1000. Can only be set if solution_types is// SOLUTION_TYPE_SEARCH.RedirectControlIds []string `json:"redirectControlIds,omitempty"`// ReplacementControlIds: Condition replacement specifications. - Applied// according to the order in the list. - A previously replaced term can not be// re-replaced. - Maximum number of specifications is 100. Can only be set if// solution_types is SOLUTION_TYPE_SEARCH.ReplacementControlIds []string `json:"replacementControlIds,omitempty"`// SolutionTypes: Required. Immutable. Specifies the solution types that a// serving config can be associated with. Currently we support setting only one// type of solution.//// Possible values://   "SOLUTION_TYPE_UNSPECIFIED" - Default value.//   "SOLUTION_TYPE_RECOMMENDATION" - Used for Recommendations AI.//   "SOLUTION_TYPE_SEARCH" - Used for Retail Search.SolutionTypes []string `json:"solutionTypes,omitempty"`// TwowaySynonymsControlIds: Condition synonyms specifications. If multiple// syonyms conditions match, all matching synonyms control in the list will// execute. Order of controls in the list will not matter. Maximum number of// specifications is 100. Can only be set if solution_types is// SOLUTION_TYPE_SEARCH.TwowaySynonymsControlIds []string `json:"twowaySynonymsControlIds,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BoostControlIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BoostControlIds") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaServingConfig: Configures metadata that is used togenerate serving time results (e.g. search results or recommendationpredictions).

func (GoogleCloudRetailV2alphaServingConfig)MarshalJSONadded inv0.66.0

typeGoogleCloudRetailV2alphaSetDefaultBranchRequestadded inv0.52.0

type GoogleCloudRetailV2alphaSetDefaultBranchRequest struct {// BranchId: The final component of the resource name of a branch. This field// must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is// returned. If there are no sufficient active products in the targeted branch// and force is not set, a FAILED_PRECONDITION error is returned.BranchIdstring `json:"branchId,omitempty"`// Force: If set to true, it permits switching to a branch with branch_id even// if it has no sufficient active products.Forcebool `json:"force,omitempty"`// Note: Some note on this request, this can be retrieved by// CatalogService.GetDefaultBranch before next valid default branch set occurs.// This field must be a UTF-8 encoded string with a length limit of 1,000// characters. Otherwise, an INVALID_ARGUMENT error is returned.Notestring `json:"note,omitempty"`// ForceSendFields is a list of field names (e.g. "BranchId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BranchId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSetDefaultBranchRequest: Request message to set aspecified branch as new default_branch.

func (GoogleCloudRetailV2alphaSetDefaultBranchRequest)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSetInventoryMetadataadded inv0.52.0

type GoogleCloudRetailV2alphaSetInventoryMetadata struct {}

GoogleCloudRetailV2alphaSetInventoryMetadata: Metadata related to theprogress of the SetInventory operation. Currently empty because there is nomeaningful metadata populated from the ProductService.SetInventory method.

typeGoogleCloudRetailV2alphaSetInventoryRequestadded inv0.52.0

type GoogleCloudRetailV2alphaSetInventoryRequest struct {// AllowMissing: If set to true, and the Product with name Product.name is not// found, the inventory update will still be processed and retained for at most// 1 day until the Product is created. If set to false, a NOT_FOUND error is// returned if the Product is not found.AllowMissingbool `json:"allowMissing,omitempty"`// Inventory: Required. The inventory information to update. The allowable// fields to update are: * Product.price_info * Product.availability *// Product.available_quantity * Product.fulfillment_info The updated inventory// fields must be specified in SetInventoryRequest.set_mask. If// SetInventoryRequest.inventory.name is empty or invalid, an INVALID_ARGUMENT// error is returned. If the caller does not have permission to update the// Product named in Product.name, regardless of whether or not it exists, a// PERMISSION_DENIED error is returned. If the Product to update does not have// existing inventory information, the provided inventory information will be// inserted. If the Product to update has existing inventory information, the// provided inventory information will be merged while respecting the last// update time for each inventory field, using the provided or default value// for SetInventoryRequest.set_time. The caller can replace place IDs for a// subset of fulfillment types in the following ways: * Adds "fulfillment_info"// in SetInventoryRequest.set_mask * Specifies only the desired fulfillment// types and corresponding place IDs to update in// SetInventoryRequest.inventory.fulfillment_info The caller can clear all// place IDs from a subset of fulfillment types in the following ways: * Adds// "fulfillment_info" in SetInventoryRequest.set_mask * Specifies only the// desired fulfillment types to clear in// SetInventoryRequest.inventory.fulfillment_info * Checks that only the// desired fulfillment info types have empty// SetInventoryRequest.inventory.fulfillment_info.place_ids The last update// time is recorded for the following inventory fields: * Product.price_info *// Product.availability * Product.available_quantity * Product.fulfillment_info// If a full overwrite of inventory information while ignoring timestamps is// needed, ProductService.UpdateProduct should be invoked instead.Inventory *GoogleCloudRetailV2alphaProduct `json:"inventory,omitempty"`// SetMask: Indicates which inventory fields in the provided Product to update.// At least one field must be provided. If an unsupported or unknown field is// provided, an INVALID_ARGUMENT error is returned and the entire update will// be ignored.SetMaskstring `json:"setMask,omitempty"`// SetTime: The time when the request is issued, used to prevent out-of-order// updates on inventory fields with the last update time recorded. If not// provided, the internal system time will be used.SetTimestring `json:"setTime,omitempty"`// ForceSendFields is a list of field names (e.g. "AllowMissing") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AllowMissing") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaSetInventoryRequest: Request message forProductService.SetInventory method.

func (GoogleCloudRetailV2alphaSetInventoryRequest)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2alphaSetInventoryResponseadded inv0.52.0

type GoogleCloudRetailV2alphaSetInventoryResponse struct {}

GoogleCloudRetailV2alphaSetInventoryResponse: Response of theSetInventoryRequest. Currently empty because there is no meaningful responsepopulated from the ProductService.SetInventory method.

typeGoogleCloudRetailV2alphaStringListadded inv0.235.0

type GoogleCloudRetailV2alphaStringList struct {// Values: String values.Values []string `json:"values,omitempty"`// ForceSendFields is a list of field names (e.g. "Values") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Values") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaStringList: A list of string values.

func (GoogleCloudRetailV2alphaStringList)MarshalJSONadded inv0.235.0

typeGoogleCloudRetailV2alphaTileadded inv0.198.0

type GoogleCloudRetailV2alphaTile struct {// ProductAttributeInterval: The product attribute key-numeric interval.ProductAttributeInterval *GoogleCloudRetailV2alphaProductAttributeInterval `json:"productAttributeInterval,omitempty"`// ProductAttributeValue: The product attribute key-value.ProductAttributeValue *GoogleCloudRetailV2alphaProductAttributeValue `json:"productAttributeValue,omitempty"`// RepresentativeProductId: The representative product id for this tile.RepresentativeProductIdstring `json:"representativeProductId,omitempty"`// ForceSendFields is a list of field names (e.g. "ProductAttributeInterval")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ProductAttributeInterval") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaTile: This field specifies the tile informationincluding an attribute key, attribute value. More fields will be added inthe future, eg: product id or product counts, etc.

func (GoogleCloudRetailV2alphaTile)MarshalJSONadded inv0.198.0

func (sGoogleCloudRetailV2alphaTile) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaTransformedUserEventsMetadataadded inv0.92.0

type GoogleCloudRetailV2alphaTransformedUserEventsMetadata struct {// SourceEventsCount: Count of entries in the source user events BigQuery// table.SourceEventsCountint64 `json:"sourceEventsCount,omitempty,string"`// TransformedEventsCount: Count of entries in the transformed user events// BigQuery table, which could be different from the actually imported number// of user events.TransformedEventsCountint64 `json:"transformedEventsCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "SourceEventsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SourceEventsCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaTransformedUserEventsMetadata: Metadata related totransform user events operation.

func (GoogleCloudRetailV2alphaTransformedUserEventsMetadata)MarshalJSONadded inv0.92.0

typeGoogleCloudRetailV2alphaTuneModelMetadataadded inv0.89.0

type GoogleCloudRetailV2alphaTuneModelMetadata struct {// Model: The resource name of the model that this tune applies to. Format:// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/mode// ls/{model_id}`Modelstring `json:"model,omitempty"`// ForceSendFields is a list of field names (e.g. "Model") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Model") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaTuneModelMetadata: Metadata associated with a tuneoperation.

func (GoogleCloudRetailV2alphaTuneModelMetadata)MarshalJSONadded inv0.89.0

typeGoogleCloudRetailV2alphaTuneModelRequestadded inv0.89.0

type GoogleCloudRetailV2alphaTuneModelRequest struct {}

GoogleCloudRetailV2alphaTuneModelRequest: Request to manually start a tuningprocess now (instead of waiting for the periodically scheduled tuning tohappen).

typeGoogleCloudRetailV2alphaTuneModelResponseadded inv0.89.0

type GoogleCloudRetailV2alphaTuneModelResponse struct {}

GoogleCloudRetailV2alphaTuneModelResponse: Response associated with a tuneoperation.

typeGoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequestadded inv0.199.0

type GoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequest struct {// GenerativeQuestionConfig: Required. The question to update.GenerativeQuestionConfig *GoogleCloudRetailV2alphaGenerativeQuestionConfig `json:"generativeQuestionConfig,omitempty"`// UpdateMask: Optional. Indicates which fields in the provided// GenerativeQuestionConfig to update. The following are NOT supported: *// GenerativeQuestionConfig.frequency If not set or empty, all supported fields// are updated.UpdateMaskstring `json:"updateMask,omitempty"`// ForceSendFields is a list of field names (e.g. "GenerativeQuestionConfig")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GenerativeQuestionConfig") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequest: Request forUpdateGenerativeQuestionConfig method.

func (GoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequest)MarshalJSONadded inv0.199.0

typeGoogleCloudRetailV2alphaUserEvent

type GoogleCloudRetailV2alphaUserEvent struct {// Attributes: Extra user event features to include in the recommendation// model. If you provide custom attributes for ingested user events, also// include them in the user events that you associate with prediction requests.// Custom attribute formatting must be consistent between imported events and// events provided with prediction requests. This lets the Retail API use those// custom attributes when training models and serving predictions, which helps// improve recommendation quality. This field needs to pass all below criteria,// otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8// encoded string with a length limit of 5,000 characters. * For text// attributes, at most 400 values are allowed. Empty values are not allowed.// Each value must be a UTF-8 encoded string with a length limit of 256// characters. * For number attributes, at most 400 values are allowed. For// product recommendations, an example of extra user information is// traffic_channel, which is how a user arrives at the site. Users can arrive// at the site by coming to the site directly, coming through Google search, or// in other ways.Attributes map[string]GoogleCloudRetailV2alphaCustomAttribute `json:"attributes,omitempty"`// AttributionToken: Highly recommended for user events that are the result of// PredictionService.Predict. This field enables accurate attribution of// recommendation model performance. The value must be a valid// PredictResponse.attribution_token for user events that are the result of// PredictionService.Predict. The value must be a valid// SearchResponse.attribution_token for user events that are the result of// SearchService.Search. This token enables us to accurately attribute page// view or purchase back to the event and the particular predict response// containing this clicked/purchased product. If user clicks on product K in// the recommendation results, pass PredictResponse.attribution_token as a URL// parameter to product K's page. When recording events on product K's page,// log the PredictResponse.attribution_token to this field.AttributionTokenstring `json:"attributionToken,omitempty"`// CartId: The ID or name of the associated shopping cart. This ID is used to// associate multiple items added or present in the cart before purchase. This// can only be set for `add-to-cart`, `purchase-complete`, or// `shopping-cart-page-view` events.CartIdstring `json:"cartId,omitempty"`// CompletionDetail: The main auto-completion details related to the event.// This field should be set for `search` event when autocomplete function is// enabled and the user clicks a suggestion for search.CompletionDetail *GoogleCloudRetailV2alphaCompletionDetail `json:"completionDetail,omitempty"`// Entity: 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. We recommend that you set this field to// get better per-entity search, completion, and prediction results.Entitystring `json:"entity,omitempty"`// EventTime: Only required for UserEventService.ImportUserEvents method.// Timestamp of when the user event happened.EventTimestring `json:"eventTime,omitempty"`// EventType: Required. User event type. Allowed values are: * `add-to-cart`:// Products being added to cart. * `remove-from-cart`: Products being removed// from cart. * `category-page-view`: Special pages such as sale or promotion// pages viewed. * `detail-page-view`: Products detail page viewed. *// `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a// purchase. * `search`: Product search. * `shopping-cart-page-view`: User// viewing a shopping cart.EventTypestring `json:"eventType,omitempty"`// ExperimentIds: A list of identifiers for the independent experiment groups// this user event belongs to. This is used to distinguish between user events// associated with different experiment setups (e.g. using Retail API, using// different recommendation models).ExperimentIds []string `json:"experimentIds,omitempty"`// Filter: The filter syntax consists of an expression language for// constructing a predicate from one or more fields of the products being// filtered. See SearchRequest.filter 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.Filterstring `json:"filter,omitempty"`// Offset: 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.Offsetint64 `json:"offset,omitempty"`// OrderBy: The order in which products are returned. 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.OrderBystring `json:"orderBy,omitempty"`// PageCategories: The categories associated with a category page. To represent// full path of category, use '>' sign to separate different hierarchies. If// '>' is part of the category name, replace it with other character(s).// Category pages include special pages such as sales or promotions. For// instance, a special sale page may have the category hierarchy:// "pageCategories" : ["Sales > 2017 Black Friday Deals"]. Required for// `category-page-view` events. At least one of search_query or page_categories// is required for `search` events. Other event types should not set this// field. Otherwise, an INVALID_ARGUMENT error is returned.PageCategories []string `json:"pageCategories,omitempty"`// PageViewId: A unique ID of a web page view. This should be kept the same for// all user events triggered from the same pageview. For example, an item// detail page view could trigger multiple events as the user is browsing the// page. The `pageViewId` property should be kept the same for all these events// so that they can be grouped together properly. When using the client side// event reporting with JavaScript pixel and Google Tag Manager, this value is// filled in automatically.PageViewIdstring `json:"pageViewId,omitempty"`// Panels: Optional. List of panels associated with this event. Used for// panel-level impression data.Panels []*GoogleCloudRetailV2alphaPanelInfo `json:"panels,omitempty"`// ProductDetails: The main product details related to the event. This field is// optional except for the following event types: * `add-to-cart` *// `detail-page-view` * `purchase-complete` In a `search` event, this field// represents the products returned to the end user on the current page (the// end user may have not finished browsing the whole page yet). When a new page// is returned to the end user, after pagination/filtering/ordering even for// the same query, a new `search` event with different product_details is// desired. The end user may have not finished browsing the whole page yet.ProductDetails []*GoogleCloudRetailV2alphaProductDetail `json:"productDetails,omitempty"`// PurchaseTransaction: A transaction represents the entire purchase// transaction. Required for `purchase-complete` events. Other event types// should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.PurchaseTransaction *GoogleCloudRetailV2alphaPurchaseTransaction `json:"purchaseTransaction,omitempty"`// ReferrerUri: The referrer URL of the current page. When using the client// side event reporting with JavaScript pixel and Google Tag Manager, this// value is filled in automatically.ReferrerUristring `json:"referrerUri,omitempty"`// SearchQuery: 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 page_categories is required for `search` events.// Other event types should not set this field. Otherwise, an INVALID_ARGUMENT// error is returned.SearchQuerystring `json:"searchQuery,omitempty"`// SessionId: A unique identifier for tracking a visitor session with a length// limit of 128 bytes. A session is an aggregation of an end user behavior in a// time span. A general guideline to populate the session_id: 1. If user has no// activity for 30 min, a new session_id should be assigned. 2. The session_id// should be unique across users, suggest use uuid or add visitor_id as prefix.SessionIdstring `json:"sessionId,omitempty"`// Uri: Complete URL (window.location.href) of the user's current page. When// using the client side event reporting with JavaScript pixel and Google Tag// Manager, this value is filled in automatically. Maximum length 5,000// characters.Uristring `json:"uri,omitempty"`// UserInfo: User information.UserInfo *GoogleCloudRetailV2alphaUserInfo `json:"userInfo,omitempty"`// VisitorId: Required. 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 log in/out of the website. Don't set the// field to the same fixed ID for different users. This mixes the event history// of those users together, which results in degraded model quality. The field// must be a UTF-8 encoded string with a length limit of 128 characters.// Otherwise, an INVALID_ARGUMENT error is returned. The field should not// contain PII or user-data. We recommend to use Google Analytics Client ID// (https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)// for this field.VisitorIdstring `json:"visitorId,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Attributes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Attributes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaUserEvent: UserEvent captures all metadatainformation Retail API needs to know about how end users interact withcustomers' website.

func (GoogleCloudRetailV2alphaUserEvent)MarshalJSON

func (sGoogleCloudRetailV2alphaUserEvent) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2alphaUserEventImportSummary

type GoogleCloudRetailV2alphaUserEventImportSummary struct {// JoinedEventsCount: Count of user events imported with complete existing// catalog information.JoinedEventsCountint64 `json:"joinedEventsCount,omitempty,string"`// UnjoinedEventsCount: Count of user events imported, but with catalog// information not found in the imported catalog.UnjoinedEventsCountint64 `json:"unjoinedEventsCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "JoinedEventsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "JoinedEventsCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaUserEventImportSummary: A summary of import result.The UserEventImportSummary summarizes the import status for user events.

func (GoogleCloudRetailV2alphaUserEventImportSummary)MarshalJSON

typeGoogleCloudRetailV2alphaUserEventInlineSource

type GoogleCloudRetailV2alphaUserEventInlineSource struct {// UserEvents: Required. A list of user events to import. Recommended max of// 10k items.UserEvents []*GoogleCloudRetailV2alphaUserEvent `json:"userEvents,omitempty"`// ForceSendFields is a list of field names (e.g. "UserEvents") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "UserEvents") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaUserEventInlineSource: The inline source for theinput config for ImportUserEvents method.

func (GoogleCloudRetailV2alphaUserEventInlineSource)MarshalJSON

typeGoogleCloudRetailV2alphaUserEventInputConfig

type GoogleCloudRetailV2alphaUserEventInputConfig struct {// BigQuerySource: Required. BigQuery input source.BigQuerySource *GoogleCloudRetailV2alphaBigQuerySource `json:"bigQuerySource,omitempty"`// GcsSource: Required. Google Cloud Storage location for the input content.GcsSource *GoogleCloudRetailV2alphaGcsSource `json:"gcsSource,omitempty"`// UserEventInlineSource: Required. The Inline source for the input content for// UserEvents.UserEventInlineSource *GoogleCloudRetailV2alphaUserEventInlineSource `json:"userEventInlineSource,omitempty"`// ForceSendFields is a list of field names (e.g. "BigQuerySource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BigQuerySource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaUserEventInputConfig: The input config source foruser events.

func (GoogleCloudRetailV2alphaUserEventInputConfig)MarshalJSON

typeGoogleCloudRetailV2alphaUserInfo

type GoogleCloudRetailV2alphaUserInfo struct {// DirectUserRequest: True if the request is made directly from the end user,// in which case the ip_address and user_agent can be populated from the HTTP// request. This flag should be set only if the API request is made directly// from the end user such as a mobile app (and not if a gateway or a server is// processing and pushing the user events). This should not be set when using// the JavaScript tag in UserEventService.CollectUserEvent.DirectUserRequestbool `json:"directUserRequest,omitempty"`// IpAddress: The end user's IP address. This field is used to extract location// information for personalization. This field must be either an IPv4 address// (e.g. "104.133.9.80") or an IPv6 address (e.g.// "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT// error is returned. This should not be set when: * setting// SearchRequest.user_info. * using the JavaScript tag in// UserEventService.CollectUserEvent or if direct_user_request is set.IpAddressstring `json:"ipAddress,omitempty"`// UserAgent: User agent as included in the HTTP header. The field must be a// UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an// INVALID_ARGUMENT error is returned. This should not be set when using the// client side event reporting with GTM or JavaScript tag in// UserEventService.CollectUserEvent or if direct_user_request is set.UserAgentstring `json:"userAgent,omitempty"`// UserId: Highly recommended for logged-in users. Unique identifier for// logged-in user, such as a user name. Don't set for anonymous users. Always// use a hashed value for this ID. Don't set the field to the same fixed ID for// different users. This mixes the event history of those users together, which// results in degraded model quality. The field must be a UTF-8 encoded string// with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error// is returned.UserIdstring `json:"userId,omitempty"`// ForceSendFields is a list of field names (e.g. "DirectUserRequest") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DirectUserRequest") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2alphaUserInfo: Information of an end user.

func (GoogleCloudRetailV2alphaUserInfo)MarshalJSON

func (sGoogleCloudRetailV2alphaUserInfo) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2betaAddFulfillmentPlacesMetadataadded inv0.52.0

type GoogleCloudRetailV2betaAddFulfillmentPlacesMetadata struct {}

GoogleCloudRetailV2betaAddFulfillmentPlacesMetadata: Metadata related to theprogress of the AddFulfillmentPlaces operation. Currently empty becausethere is no meaningful metadata populated from theProductService.AddFulfillmentPlaces method.

typeGoogleCloudRetailV2betaAddFulfillmentPlacesResponseadded inv0.52.0

type GoogleCloudRetailV2betaAddFulfillmentPlacesResponse struct {}

GoogleCloudRetailV2betaAddFulfillmentPlacesResponse: Response of theAddFulfillmentPlacesRequest. Currently empty because there is no meaningfulresponse populated from the ProductService.AddFulfillmentPlaces method.

typeGoogleCloudRetailV2betaAddLocalInventoriesMetadataadded inv0.75.0

type GoogleCloudRetailV2betaAddLocalInventoriesMetadata struct {}

GoogleCloudRetailV2betaAddLocalInventoriesMetadata: Metadata related to theprogress of the AddLocalInventories operation. Currently empty because thereis no meaningful metadata populated from theProductService.AddLocalInventories method.

typeGoogleCloudRetailV2betaAddLocalInventoriesResponseadded inv0.75.0

type GoogleCloudRetailV2betaAddLocalInventoriesResponse struct {}

GoogleCloudRetailV2betaAddLocalInventoriesResponse: Response of theProductService.AddLocalInventories API. Currently empty because there is nomeaningful response populated from the ProductService.AddLocalInventoriesmethod.

typeGoogleCloudRetailV2betaBigQueryOutputResultadded inv0.90.0

type GoogleCloudRetailV2betaBigQueryOutputResult struct {// DatasetId: The ID of a BigQuery Dataset.DatasetIdstring `json:"datasetId,omitempty"`// TableId: The ID of a BigQuery Table.TableIdstring `json:"tableId,omitempty"`// ForceSendFields is a list of field names (e.g. "DatasetId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DatasetId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaBigQueryOutputResult: A BigQuery output result.

func (GoogleCloudRetailV2betaBigQueryOutputResult)MarshalJSONadded inv0.90.0

typeGoogleCloudRetailV2betaCreateModelMetadataadded inv0.98.0

type GoogleCloudRetailV2betaCreateModelMetadata struct {// Model: The resource name of the model that this create applies to. Format:// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/mode// ls/{model_id}`Modelstring `json:"model,omitempty"`// ForceSendFields is a list of field names (e.g. "Model") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Model") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaCreateModelMetadata: Metadata associated with acreate operation.

func (GoogleCloudRetailV2betaCreateModelMetadata)MarshalJSONadded inv0.98.0

typeGoogleCloudRetailV2betaExportAnalyticsMetricsResponseadded inv0.158.0

type GoogleCloudRetailV2betaExportAnalyticsMetricsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: This field is never set.ErrorsConfig *GoogleCloudRetailV2betaExportErrorsConfig `json:"errorsConfig,omitempty"`// OutputResult: Output result indicating where the data were exported to.OutputResult *GoogleCloudRetailV2betaOutputResult `json:"outputResult,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaExportAnalyticsMetricsResponse: Response of theExportAnalyticsMetricsRequest. If the long running operation was successful,then this message is returned by the google.longrunning.Operations.responsefield if the operation was successful.

func (GoogleCloudRetailV2betaExportAnalyticsMetricsResponse)MarshalJSONadded inv0.158.0

typeGoogleCloudRetailV2betaExportErrorsConfig

type GoogleCloudRetailV2betaExportErrorsConfig struct {// GcsPrefix: Google Cloud Storage path for import errors. This must be an// empty, existing Cloud Storage bucket. Export errors will be written to a// file in this bucket, one per line, as a JSON-encoded `google.rpc.Status`// message.GcsPrefixstring `json:"gcsPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsPrefix") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaExportErrorsConfig: Configuration of destination forExport related errors.

func (GoogleCloudRetailV2betaExportErrorsConfig)MarshalJSON

typeGoogleCloudRetailV2betaExportMetadata

type GoogleCloudRetailV2betaExportMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// UpdateTime: Operation last update time. If the operation is done, this is// also the finish time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaExportMetadata: Metadata related to the progress ofthe Export operation. This is returned by thegoogle.longrunning.Operation.metadata field.

func (GoogleCloudRetailV2betaExportMetadata)MarshalJSON

typeGoogleCloudRetailV2betaExportProductsResponse

type GoogleCloudRetailV2betaExportProductsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: This field is never set.ErrorsConfig *GoogleCloudRetailV2betaExportErrorsConfig `json:"errorsConfig,omitempty"`// OutputResult: Output result indicating where the data were exported to.OutputResult *GoogleCloudRetailV2betaOutputResult `json:"outputResult,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaExportProductsResponse: Response of theExportProductsRequest. If the long running operation is done, then thismessage is returned by the google.longrunning.Operations.response field ifthe operation was successful.

func (GoogleCloudRetailV2betaExportProductsResponse)MarshalJSON

typeGoogleCloudRetailV2betaExportUserEventsResponse

type GoogleCloudRetailV2betaExportUserEventsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: This field is never set.ErrorsConfig *GoogleCloudRetailV2betaExportErrorsConfig `json:"errorsConfig,omitempty"`// OutputResult: Output result indicating where the data were exported to.OutputResult *GoogleCloudRetailV2betaOutputResult `json:"outputResult,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaExportUserEventsResponse: Response of theExportUserEventsRequest. If the long running operation was successful, thenthis message is returned by the google.longrunning.Operations.response fieldif the operation was successful.

func (GoogleCloudRetailV2betaExportUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2betaGcsOutputResultadded inv0.101.0

type GoogleCloudRetailV2betaGcsOutputResult struct {// OutputUri: The uri of Gcs outputOutputUristring `json:"outputUri,omitempty"`// ForceSendFields is a list of field names (e.g. "OutputUri") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "OutputUri") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaGcsOutputResult: A Gcs output result.

func (GoogleCloudRetailV2betaGcsOutputResult)MarshalJSONadded inv0.101.0

typeGoogleCloudRetailV2betaImportCompletionDataResponseadded inv0.52.0

type GoogleCloudRetailV2betaImportCompletionDataResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaImportCompletionDataResponse: Response of theImportCompletionDataRequest. If the long running operation is done, thismessage is returned by the google.longrunning.Operations.response field ifthe operation is successful.

func (GoogleCloudRetailV2betaImportCompletionDataResponse)MarshalJSONadded inv0.52.0

typeGoogleCloudRetailV2betaImportErrorsConfig

type GoogleCloudRetailV2betaImportErrorsConfig struct {// GcsPrefix: Google Cloud Storage prefix for import errors. This must be an// empty, existing Cloud Storage directory. Import errors are written to// sharded files in this directory, one per line, as a JSON-encoded// `google.rpc.Status` message.GcsPrefixstring `json:"gcsPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "GcsPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "GcsPrefix") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaImportErrorsConfig: Configuration of destination forImport related errors.

func (GoogleCloudRetailV2betaImportErrorsConfig)MarshalJSON

typeGoogleCloudRetailV2betaImportMetadata

type GoogleCloudRetailV2betaImportMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// FailureCount: Count of entries that encountered errors while processing.FailureCountint64 `json:"failureCount,omitempty,string"`// NotificationPubsubTopic: Pub/Sub topic for receiving notification. If this// field is set, when the import is finished, a notification is sent to// specified Pub/Sub topic. The message data is JSON string of a Operation.// Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.NotificationPubsubTopicstring `json:"notificationPubsubTopic,omitempty"`// RequestId: Deprecated. This field is never set.RequestIdstring `json:"requestId,omitempty"`// SuccessCount: Count of entries that were processed successfully.SuccessCountint64 `json:"successCount,omitempty,string"`// UpdateTime: Operation last update time. If the operation is done, this is// also the finish time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaImportMetadata: Metadata related to the progress ofthe Import operation. This is returned by thegoogle.longrunning.Operation.metadata field.

func (GoogleCloudRetailV2betaImportMetadata)MarshalJSON

typeGoogleCloudRetailV2betaImportProductsResponse

type GoogleCloudRetailV2betaImportProductsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: Echoes the destination for the complete errors in the request// if set.ErrorsConfig *GoogleCloudRetailV2betaImportErrorsConfig `json:"errorsConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaImportProductsResponse: Response of theImportProductsRequest. If the long running operation is done, then thismessage is returned by the google.longrunning.Operations.response field ifthe operation was successful.

func (GoogleCloudRetailV2betaImportProductsResponse)MarshalJSON

typeGoogleCloudRetailV2betaImportUserEventsResponse

type GoogleCloudRetailV2betaImportUserEventsResponse struct {// ErrorSamples: A sample of errors encountered while processing the request.ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"`// ErrorsConfig: Echoes the destination for the complete errors if this field// was set in the request.ErrorsConfig *GoogleCloudRetailV2betaImportErrorsConfig `json:"errorsConfig,omitempty"`// ImportSummary: Aggregated statistics of user event import status.ImportSummary *GoogleCloudRetailV2betaUserEventImportSummary `json:"importSummary,omitempty"`// ForceSendFields is a list of field names (e.g. "ErrorSamples") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ErrorSamples") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaImportUserEventsResponse: Response of theImportUserEventsRequest. If the long running operation was successful, thenthis message is returned by the google.longrunning.Operations.response fieldif the operation was successful.

func (GoogleCloudRetailV2betaImportUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2betaModeladded inv0.98.0

type GoogleCloudRetailV2betaModel struct {// CreateTime: Output only. Timestamp the Recommendation Model was created at.CreateTimestring `json:"createTime,omitempty"`// DataState: Output only. The state of data requirements for this model:// `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the// data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR`// state even if serving state is `ACTIVE`: models were trained successfully// before, but cannot be refreshed because model no longer has sufficient data// for training.//// Possible values://   "DATA_STATE_UNSPECIFIED" - Unspecified default value, should never be// explicitly set.//   "DATA_OK" - The model has sufficient training data.//   "DATA_ERROR" - The model does not have sufficient training data. Error// messages can be queried via Stackdriver.DataStatestring `json:"dataState,omitempty"`// DisplayName: Required. The display name of the model. Should be human// readable, used to display Recommendation Models in the Retail Cloud Console// Dashboard. UTF-8 encoded string with limit of 1024 characters.DisplayNamestring `json:"displayName,omitempty"`// FilteringOption: Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`,// recommendation filtering by attributes is enabled for the model.//// Possible values://   "RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED" - Value used when unset. In// this case, server behavior defaults to RECOMMENDATIONS_FILTERING_DISABLED.//   "RECOMMENDATIONS_FILTERING_DISABLED" - Recommendation filtering is// disabled.//   "RECOMMENDATIONS_FILTERING_ENABLED" - Recommendation filtering is enabled.FilteringOptionstring `json:"filteringOption,omitempty"`// LastTuneTime: Output only. The timestamp when the latest successful tune// finished.LastTuneTimestring `json:"lastTuneTime,omitempty"`// ModelFeaturesConfig: Optional. Additional model features config.ModelFeaturesConfig *GoogleCloudRetailV2betaModelModelFeaturesConfig `json:"modelFeaturesConfig,omitempty"`// Name: Required. The fully qualified resource name of the model. Format:// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/mode// ls/{model_id}` catalog_id has char limit of 50. recommendation_model_id has// char limit of 40.Namestring `json:"name,omitempty"`// OptimizationObjective: Optional. The optimization objective e.g. `cvr`.// Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not// specified, we choose default based on model type. Default depends on type of// recommendation: `recommended-for-you` => `ctr` `others-you-may-like` =>// `ctr` `frequently-bought-together` => `revenue_per_order` This field// together with optimization_objective describe model metadata to use to// control model training and serving. See//https://cloud.google.com/retail/docs/models for more details on what the// model metadata control and which combination of parameters are valid. For// invalid combinations of parameters (e.g. type = `frequently-bought-together`// and optimization_objective = `ctr`), you receive an error 400 if you try to// create/update a recommendation with this set of knobs.OptimizationObjectivestring `json:"optimizationObjective,omitempty"`// PeriodicTuningState: Optional. The state of periodic tuning. The period we// use is 3 months - to do a one-off tune earlier use the `TuneModel` method.// Default value is `PERIODIC_TUNING_ENABLED`.//// Possible values://   "PERIODIC_TUNING_STATE_UNSPECIFIED" - Unspecified default value, should// never be explicitly set.//   "PERIODIC_TUNING_DISABLED" - The model has periodic tuning disabled.// Tuning can be reenabled by calling the `EnableModelPeriodicTuning` method or// by calling the `TuneModel` method.//   "ALL_TUNING_DISABLED" - The model cannot be tuned with periodic tuning OR// the `TuneModel` method. Hide the options in customer UI and reject any// requests through the backend self serve API.//   "PERIODIC_TUNING_ENABLED" - The model has periodic tuning enabled. Tuning// can be disabled by calling the `DisableModelPeriodicTuning` method.PeriodicTuningStatestring `json:"periodicTuningState,omitempty"`// ServingConfigLists: Output only. The list of valid serving configs// associated with the PageOptimizationConfig.ServingConfigLists []*GoogleCloudRetailV2betaModelServingConfigList `json:"servingConfigLists,omitempty"`// ServingState: Output only. The serving state of the model: `ACTIVE`,// `NOT_ACTIVE`.//// Possible values://   "SERVING_STATE_UNSPECIFIED" - Unspecified serving state.//   "INACTIVE" - The model is not serving.//   "ACTIVE" - The model is serving and can be queried.//   "TUNED" - The model is trained on tuned hyperparameters and can be// queried.ServingStatestring `json:"servingState,omitempty"`// TrainingState: Optional. The training state that the model is in (e.g.// `TRAINING` or `PAUSED`). Since part of the cost of running the service is// frequency of training - this can be used to determine when to train model in// order to control cost. If not specified: the default value for `CreateModel`// method is `TRAINING`. The default value for `UpdateModel` method is to keep// the state the same as before.//// Possible values://   "TRAINING_STATE_UNSPECIFIED" - Unspecified training state.//   "PAUSED" - The model training is paused.//   "TRAINING" - The model is training.TrainingStatestring `json:"trainingState,omitempty"`// TuningOperation: Output only. The tune operation associated with the model.// Can be used to determine if there is an ongoing tune for this// recommendation. Empty field implies no tune is goig on.TuningOperationstring `json:"tuningOperation,omitempty"`// Type: Required. The type of model e.g. `home-page`. Currently supported// values: `recommended-for-you`, `others-you-may-like`,// `frequently-bought-together`, `page-optimization`, `similar-items`,// `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This// field together with optimization_objective describe model metadata to use to// control model training and serving. See//https://cloud.google.com/retail/docs/models for more details on what the// model metadata control and which combination of parameters are valid. For// invalid combinations of parameters (e.g. type = `frequently-bought-together`// and optimization_objective = `ctr`), you receive an error 400 if you try to// create/update a recommendation with this set of knobs.Typestring `json:"type,omitempty"`// UpdateTime: Output only. Timestamp the Recommendation Model was last// updated. E.g. if a Recommendation Model was paused - this would be the time// the pause was initiated.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaModel: Metadata that describes the training andserving parameters of a Model. A Model can be associated with aServingConfig and then queried through the Predict API.

func (GoogleCloudRetailV2betaModel)MarshalJSONadded inv0.98.0

func (sGoogleCloudRetailV2betaModel) MarshalJSON() ([]byte,error)

typeGoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfigadded inv0.121.0

type GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig struct {// ContextProductsType: Optional. Specifies the context of the model when it is// used in predict requests. Can only be set for the// `frequently-bought-together` type. If it isn't specified, it defaults to// MULTIPLE_CONTEXT_PRODUCTS.//// Possible values://   "CONTEXT_PRODUCTS_TYPE_UNSPECIFIED" - Unspecified default value, should// never be explicitly set. Defaults to MULTIPLE_CONTEXT_PRODUCTS.//   "SINGLE_CONTEXT_PRODUCT" - Use only a single product as context for the// recommendation. Typically used on pages like add-to-cart or product details.//   "MULTIPLE_CONTEXT_PRODUCTS" - Use one or multiple products as context for// the recommendation. Typically used on shopping cart pages.ContextProductsTypestring `json:"contextProductsType,omitempty"`// ForceSendFields is a list of field names (e.g. "ContextProductsType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ContextProductsType") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig:Additional configs for the frequently-bought-together model type.

func (GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig)MarshalJSONadded inv0.121.0

typeGoogleCloudRetailV2betaModelModelFeaturesConfigadded inv0.121.0

type GoogleCloudRetailV2betaModelModelFeaturesConfig struct {// FrequentlyBoughtTogetherConfig: Additional configs for// frequently-bought-together models.FrequentlyBoughtTogetherConfig *GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig `json:"frequentlyBoughtTogetherConfig,omitempty"`// ForceSendFields is a list of field names (e.g.// "FrequentlyBoughtTogetherConfig") to unconditionally include in API// requests. By default, fields with empty or default values are omitted from// API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FrequentlyBoughtTogetherConfig")// to include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaModelModelFeaturesConfig: Additional model featuresconfig.

func (GoogleCloudRetailV2betaModelModelFeaturesConfig)MarshalJSONadded inv0.121.0

typeGoogleCloudRetailV2betaModelServingConfigListadded inv0.98.0

type GoogleCloudRetailV2betaModelServingConfigList struct {// ServingConfigIds: Optional. A set of valid serving configs that may be used// for `PAGE_OPTIMIZATION`.ServingConfigIds []string `json:"servingConfigIds,omitempty"`// ForceSendFields is a list of field names (e.g. "ServingConfigIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ServingConfigIds") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaModelServingConfigList: Represents an orderedcombination of valid serving configs, which can be used for`PAGE_OPTIMIZATION` recommendations.

func (GoogleCloudRetailV2betaModelServingConfigList)MarshalJSONadded inv0.98.0

typeGoogleCloudRetailV2betaOutputResultadded inv0.90.0

type GoogleCloudRetailV2betaOutputResult struct {// BigqueryResult: The BigQuery location where the result is stored.BigqueryResult []*GoogleCloudRetailV2betaBigQueryOutputResult `json:"bigqueryResult,omitempty"`// GcsResult: The Google Cloud Storage location where the result is stored.GcsResult []*GoogleCloudRetailV2betaGcsOutputResult `json:"gcsResult,omitempty"`// ForceSendFields is a list of field names (e.g. "BigqueryResult") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BigqueryResult") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaOutputResult: Output result that stores theinformation about where the exported data is stored.

func (GoogleCloudRetailV2betaOutputResult)MarshalJSONadded inv0.90.0

typeGoogleCloudRetailV2betaPurgeMetadata

type GoogleCloudRetailV2betaPurgeMetadata struct {}

GoogleCloudRetailV2betaPurgeMetadata: Metadata related to the progress ofthe Purge operation. This will be returned by thegoogle.longrunning.Operation.metadata field.

typeGoogleCloudRetailV2betaPurgeProductsMetadataadded inv0.128.0

type GoogleCloudRetailV2betaPurgeProductsMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// FailureCount: Count of entries that encountered errors while processing.FailureCountint64 `json:"failureCount,omitempty,string"`// SuccessCount: Count of entries that were deleted successfully.SuccessCountint64 `json:"successCount,omitempty,string"`// UpdateTime: Operation last update time. If the operation is done, this is// also the finish time.UpdateTimestring `json:"updateTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaPurgeProductsMetadata: Metadata related to theprogress of the PurgeProducts operation. This will be returned by thegoogle.longrunning.Operation.metadata field.

func (GoogleCloudRetailV2betaPurgeProductsMetadata)MarshalJSONadded inv0.128.0

typeGoogleCloudRetailV2betaPurgeProductsResponseadded inv0.128.0

type GoogleCloudRetailV2betaPurgeProductsResponse struct {// PurgeCount: The total count of products purged as a result of the operation.PurgeCountint64 `json:"purgeCount,omitempty,string"`// PurgeSample: A sample of the product names that will be deleted. Only// populated if `force` is set to false. A max of 100 names will be returned// and the names are chosen at random.PurgeSample []string `json:"purgeSample,omitempty"`// ForceSendFields is a list of field names (e.g. "PurgeCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PurgeCount") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaPurgeProductsResponse: Response of thePurgeProductsRequest. If the long running operation is successfully done,then this message is returned by the google.longrunning.Operations.responsefield.

func (GoogleCloudRetailV2betaPurgeProductsResponse)MarshalJSONadded inv0.128.0

typeGoogleCloudRetailV2betaPurgeUserEventsResponse

type GoogleCloudRetailV2betaPurgeUserEventsResponse struct {// PurgedEventsCount: The total count of events purged as a result of the// operation.PurgedEventsCountint64 `json:"purgedEventsCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "PurgedEventsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PurgedEventsCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaPurgeUserEventsResponse: Response of thePurgeUserEventsRequest. If the long running operation is successfully done,then this message is returned by the google.longrunning.Operations.responsefield.

func (GoogleCloudRetailV2betaPurgeUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2betaRejoinUserEventsMetadata

type GoogleCloudRetailV2betaRejoinUserEventsMetadata struct {}

GoogleCloudRetailV2betaRejoinUserEventsMetadata: Metadata for`RejoinUserEvents` method.

typeGoogleCloudRetailV2betaRejoinUserEventsResponse

type GoogleCloudRetailV2betaRejoinUserEventsResponse struct {// RejoinedUserEventsCount: Number of user events that were joined with latest// product catalog.RejoinedUserEventsCountint64 `json:"rejoinedUserEventsCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "RejoinedUserEventsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RejoinedUserEventsCount") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaRejoinUserEventsResponse: Response message for`RejoinUserEvents` method.

func (GoogleCloudRetailV2betaRejoinUserEventsResponse)MarshalJSON

typeGoogleCloudRetailV2betaRemoveFulfillmentPlacesMetadataadded inv0.52.0

type GoogleCloudRetailV2betaRemoveFulfillmentPlacesMetadata struct {}

GoogleCloudRetailV2betaRemoveFulfillmentPlacesMetadata: Metadata related tothe progress of the RemoveFulfillmentPlaces operation. Currently emptybecause there is no meaningful metadata populated from theProductService.RemoveFulfillmentPlaces method.

typeGoogleCloudRetailV2betaRemoveFulfillmentPlacesResponseadded inv0.52.0

type GoogleCloudRetailV2betaRemoveFulfillmentPlacesResponse struct {}

GoogleCloudRetailV2betaRemoveFulfillmentPlacesResponse: Response of theRemoveFulfillmentPlacesRequest. Currently empty because there is nomeaningful response populated from theProductService.RemoveFulfillmentPlaces method.

typeGoogleCloudRetailV2betaRemoveLocalInventoriesMetadataadded inv0.75.0

type GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata struct {}

GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata: Metadata related tothe progress of the RemoveLocalInventories operation. Currently emptybecause there is no meaningful metadata populated from theProductService.RemoveLocalInventories method.

typeGoogleCloudRetailV2betaRemoveLocalInventoriesResponseadded inv0.75.0

type GoogleCloudRetailV2betaRemoveLocalInventoriesResponse struct {}

GoogleCloudRetailV2betaRemoveLocalInventoriesResponse: Response of theProductService.RemoveLocalInventories API. Currently empty because there isno meaningful response populated from theProductService.RemoveLocalInventories method.

typeGoogleCloudRetailV2betaSetInventoryMetadataadded inv0.52.0

type GoogleCloudRetailV2betaSetInventoryMetadata struct {}

GoogleCloudRetailV2betaSetInventoryMetadata: Metadata related to theprogress of the SetInventory operation. Currently empty because there is nomeaningful metadata populated from the ProductService.SetInventory method.

typeGoogleCloudRetailV2betaSetInventoryResponseadded inv0.52.0

type GoogleCloudRetailV2betaSetInventoryResponse struct {}

GoogleCloudRetailV2betaSetInventoryResponse: Response of theSetInventoryRequest. Currently empty because there is no meaningful responsepopulated from the ProductService.SetInventory method.

typeGoogleCloudRetailV2betaTuneModelMetadataadded inv0.98.0

type GoogleCloudRetailV2betaTuneModelMetadata struct {// Model: The resource name of the model that this tune applies to. Format:// `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/mode// ls/{model_id}`Modelstring `json:"model,omitempty"`// ForceSendFields is a list of field names (e.g. "Model") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Model") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaTuneModelMetadata: Metadata associated with a tuneoperation.

func (GoogleCloudRetailV2betaTuneModelMetadata)MarshalJSONadded inv0.98.0

typeGoogleCloudRetailV2betaTuneModelResponseadded inv0.98.0

type GoogleCloudRetailV2betaTuneModelResponse struct {}

GoogleCloudRetailV2betaTuneModelResponse: Response associated with a tuneoperation.

typeGoogleCloudRetailV2betaUserEventImportSummary

type GoogleCloudRetailV2betaUserEventImportSummary struct {// JoinedEventsCount: Count of user events imported with complete existing// catalog information.JoinedEventsCountint64 `json:"joinedEventsCount,omitempty,string"`// UnjoinedEventsCount: Count of user events imported, but with catalog// information not found in the imported catalog.UnjoinedEventsCountint64 `json:"unjoinedEventsCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "JoinedEventsCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "JoinedEventsCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleCloudRetailV2betaUserEventImportSummary: A summary of import result.The UserEventImportSummary summarizes the import status for user events.

func (GoogleCloudRetailV2betaUserEventImportSummary)MarshalJSON

typeGoogleLongrunningListOperationsResponse

type GoogleLongrunningListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*GoogleLongrunningOperation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections. For example, when attempting to list all resources across all// supported locations.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleLongrunningListOperationsResponse: The response message forOperations.ListOperations.

func (GoogleLongrunningListOperationsResponse)MarshalJSON

typeGoogleLongrunningOperation

type GoogleLongrunningOperation struct {// Done: If the value is `false`, it means the operation is still in progress.// If `true`, the operation is completed, and either `error` or `response` is// available.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or cancellation.Error *GoogleRpcStatus `json:"error,omitempty"`// Metadata: Service-specific metadata associated with the operation. It// typically contains progress information and common metadata such as create// time. Some services might not provide such metadata. Any method that returns// a long-running operation should document the metadata type, if any.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: The server-assigned name, which is only unique within the same service// that originally returns it. If you use the default HTTP mapping, the `name`// should be a resource name ending with `operations/{unique_id}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. If the original// method returns no data on success, such as `Delete`, the response is// `google.protobuf.Empty`. If the original method is standard// `Get`/`Create`/`Update`, the response should be the resource. For other// methods, the response should have the type `XxxResponse`, where `Xxx` is the// original method name. For example, if the original method name is// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleLongrunningOperation: This resource represents a long-runningoperation that is the result of a network API call.

func (GoogleLongrunningOperation)MarshalJSON

func (sGoogleLongrunningOperation) MarshalJSON() ([]byte,error)

typeGoogleProtobufEmpty

type GoogleProtobufEmpty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}

GoogleProtobufEmpty: A generic empty message that you can re-use to avoiddefining duplicated empty messages in your APIs. A typical example is to useit as the request or the response type of an API method. For instance:service Foo { rpc Bar(google.protobuf.Empty) returns(google.protobuf.Empty); }

typeGoogleRpcStatus

type GoogleRpcStatus struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in English. Any// user-facing error message should be localized and sent in the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleRpcStatus: The `Status` type defines a logical error model that issuitable for different programming environments, including REST APIs and RPCAPIs. It is used by gRPC (https://github.com/grpc). Each `Status` messagecontains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in theAPI Design Guide (https://cloud.google.com/apis/design/errors).

func (GoogleRpcStatus)MarshalJSON

func (sGoogleRpcStatus) MarshalJSON() ([]byte,error)

typeGoogleTypeDateadded inv0.52.0

type GoogleTypeDate struct {// Day: Day of a month. Must be from 1 to 31 and valid for the year and month,// or 0 to specify a year by itself or a year and month where the day isn't// significant.Dayint64 `json:"day,omitempty"`// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year without// a month and day.Monthint64 `json:"month,omitempty"`// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a date// without a year.Yearint64 `json:"year,omitempty"`// ForceSendFields is a list of field names (e.g. "Day") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Day") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

GoogleTypeDate: Represents a whole or partial calendar date, such as abirthday. The time of day and time zone are either specified elsewhere orare insignificant. The date is relative to the Gregorian Calendar. This canrepresent one of the following: * A full date, with non-zero year, month,and day values. * A month and day, with a zero year (for example, ananniversary). * A year on its own, with a zero month and a zero day. * Ayear and month, with a zero day (for example, a credit card expirationdate). Related types: * google.type.TimeOfDay * google.type.DateTime *google.protobuf.Timestamp

func (GoogleTypeDate)MarshalJSONadded inv0.52.0

func (sGoogleTypeDate) MarshalJSON() ([]byte,error)

typeProjectsEnrollSolutionCalladded inv0.131.0

type ProjectsEnrollSolutionCall struct {// contains filtered or unexported fields}

func (*ProjectsEnrollSolutionCall)Contextadded inv0.131.0

Context sets the context to be used in this call's Do method.

func (*ProjectsEnrollSolutionCall)Doadded inv0.131.0

Do executes the "retail.projects.enrollSolution" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsEnrollSolutionCall)Fieldsadded inv0.131.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsEnrollSolutionCall)Headeradded inv0.131.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsGetAlertConfigCalladded inv0.169.0

type ProjectsGetAlertConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsGetAlertConfigCall)Contextadded inv0.169.0

Context sets the context to be used in this call's Do method.

func (*ProjectsGetAlertConfigCall)Doadded inv0.169.0

Do executes the "retail.projects.getAlertConfig" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaAlertConfig.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsGetAlertConfigCall)Fieldsadded inv0.169.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsGetAlertConfigCall)Headeradded inv0.169.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsGetAlertConfigCall)IfNoneMatchadded inv0.169.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsGetLoggingConfigCalladded inv0.147.0

type ProjectsGetLoggingConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsGetLoggingConfigCall)Contextadded inv0.147.0

Context sets the context to be used in this call's Do method.

func (*ProjectsGetLoggingConfigCall)Doadded inv0.147.0

Do executes the "retail.projects.getLoggingConfig" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaLoggingConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsGetLoggingConfigCall)Fieldsadded inv0.147.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsGetLoggingConfigCall)Headeradded inv0.147.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsGetLoggingConfigCall)IfNoneMatchadded inv0.147.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsGetRetailProjectCalladded inv0.131.0

type ProjectsGetRetailProjectCall struct {// contains filtered or unexported fields}

func (*ProjectsGetRetailProjectCall)Contextadded inv0.131.0

Context sets the context to be used in this call's Do method.

func (*ProjectsGetRetailProjectCall)Doadded inv0.131.0

Do executes the "retail.projects.getRetailProject" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaProject.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsGetRetailProjectCall)Fieldsadded inv0.131.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsGetRetailProjectCall)Headeradded inv0.131.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsGetRetailProjectCall)IfNoneMatchadded inv0.131.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsListEnrolledSolutionsCalladded inv0.131.0

type ProjectsListEnrolledSolutionsCall struct {// contains filtered or unexported fields}

func (*ProjectsListEnrolledSolutionsCall)Contextadded inv0.131.0

Context sets the context to be used in this call's Do method.

func (*ProjectsListEnrolledSolutionsCall)Doadded inv0.131.0

Do executes the "retail.projects.listEnrolledSolutions" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaListEnrolledSolutionsResponse.ServerResponse.Headeror (if a response was returned at all) in error.(*googleapi.Error).Header.Use googleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsListEnrolledSolutionsCall)Fieldsadded inv0.131.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsListEnrolledSolutionsCall)Headeradded inv0.131.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsListEnrolledSolutionsCall)IfNoneMatchadded inv0.131.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsAttributesConfigAddCatalogAttributeCalladded inv0.71.0

type ProjectsLocationsCatalogsAttributesConfigAddCatalogAttributeCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsAttributesConfigAddCatalogAttributeCall)Contextadded inv0.71.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsAttributesConfigAddCatalogAttributeCall)Doadded inv0.71.0

Do executes the "retail.projects.locations.catalogs.attributesConfig.addCatalogAttribute" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaAttributesConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsAttributesConfigAddCatalogAttributeCall)Fieldsadded inv0.71.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsAttributesConfigAddCatalogAttributeCall)Headeradded inv0.71.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsAttributesConfigBatchRemoveCatalogAttributesCalladded inv0.92.0

type ProjectsLocationsCatalogsAttributesConfigBatchRemoveCatalogAttributesCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsAttributesConfigBatchRemoveCatalogAttributesCall)Contextadded inv0.92.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsAttributesConfigBatchRemoveCatalogAttributesCall)Doadded inv0.92.0

Do executes the "retail.projects.locations.catalogs.attributesConfig.batchRemoveCatalogAttributes" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsAttributesConfigBatchRemoveCatalogAttributesCall)Fieldsadded inv0.92.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsAttributesConfigBatchRemoveCatalogAttributesCall)Headeradded inv0.92.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsAttributesConfigRemoveCatalogAttributeCalladded inv0.71.0

type ProjectsLocationsCatalogsAttributesConfigRemoveCatalogAttributeCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsAttributesConfigRemoveCatalogAttributeCall)Contextadded inv0.71.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsAttributesConfigRemoveCatalogAttributeCall)Doadded inv0.71.0

Do executes the "retail.projects.locations.catalogs.attributesConfig.removeCatalogAttribute" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaAttributesConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsAttributesConfigRemoveCatalogAttributeCall)Fieldsadded inv0.71.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsAttributesConfigRemoveCatalogAttributeCall)Headeradded inv0.71.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsAttributesConfigReplaceCatalogAttributeCalladded inv0.71.0

type ProjectsLocationsCatalogsAttributesConfigReplaceCatalogAttributeCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsAttributesConfigReplaceCatalogAttributeCall)Contextadded inv0.71.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsAttributesConfigReplaceCatalogAttributeCall)Doadded inv0.71.0

Do executes the "retail.projects.locations.catalogs.attributesConfig.replaceCatalogAttribute" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaAttributesConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsAttributesConfigReplaceCatalogAttributeCall)Fieldsadded inv0.71.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsAttributesConfigReplaceCatalogAttributeCall)Headeradded inv0.71.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsAttributesConfigServiceadded inv0.71.0

type ProjectsLocationsCatalogsAttributesConfigService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsAttributesConfigServiceadded inv0.71.0

func NewProjectsLocationsCatalogsAttributesConfigService(s *Service) *ProjectsLocationsCatalogsAttributesConfigService

func (*ProjectsLocationsCatalogsAttributesConfigService)AddCatalogAttributeadded inv0.71.0

AddCatalogAttribute: Adds the specified CatalogAttribute to theAttributesConfig. If the CatalogAttribute to add already exists, anALREADY_EXISTS error is returned.

  • attributesConfig: Full AttributesConfig resource name. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`.

func (*ProjectsLocationsCatalogsAttributesConfigService)BatchRemoveCatalogAttributesadded inv0.92.0

BatchRemoveCatalogAttributes: Removes all specified CatalogAttributes fromthe AttributesConfig.

  • attributesConfig: The attributes config resource shared by all catalogattributes being deleted. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`.

func (*ProjectsLocationsCatalogsAttributesConfigService)RemoveCatalogAttributeadded inv0.71.0

RemoveCatalogAttribute: Removes the specified CatalogAttribute from theAttributesConfig. If the CatalogAttribute to remove does not exist, aNOT_FOUND error is returned.

  • attributesConfig: Full AttributesConfig resource name. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`.

func (*ProjectsLocationsCatalogsAttributesConfigService)ReplaceCatalogAttributeadded inv0.71.0

ReplaceCatalogAttribute: Replaces the specified CatalogAttribute in theAttributesConfig by updating the catalog attribute with the sameCatalogAttribute.key. If the CatalogAttribute to replace does not exist, aNOT_FOUND error is returned.

  • attributesConfig: Full AttributesConfig resource name. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`.

typeProjectsLocationsCatalogsBranchesGetCalladded inv0.177.0

type ProjectsLocationsCatalogsBranchesGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesGetCall)Contextadded inv0.177.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesGetCall)Doadded inv0.177.0

Do executes the "retail.projects.locations.catalogs.branches.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaBranch.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesGetCall)Fieldsadded inv0.177.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesGetCall)Headeradded inv0.177.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsBranchesGetCall)IfNoneMatchadded inv0.177.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsCatalogsBranchesGetCall)Viewadded inv0.177.0

View sets the optional parameter "view": The view to apply to the returnedBranch. Defaults to [Branch.BranchView.BASIC] if unspecified. Seedocumentation of fields of Branch to find what fields are excluded fromBASIC view.

Possible values:

"BRANCH_VIEW_UNSPECIFIED" - The value when it's unspecified. This defaults

to the BASIC view.

"BRANCH_VIEW_BASIC" - Includes basic metadata about the branch, but not

statistical fields. See documentation of fields of Branch to find whatfields are excluded from BASIC view.

"BRANCH_VIEW_FULL" - Includes all fields of a Branch.

typeProjectsLocationsCatalogsBranchesListCalladded inv0.177.0

type ProjectsLocationsCatalogsBranchesListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesListCall)Contextadded inv0.177.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesListCall)Doadded inv0.177.0

Do executes the "retail.projects.locations.catalogs.branches.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaListBranchesResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesListCall)Fieldsadded inv0.177.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesListCall)Headeradded inv0.177.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsBranchesListCall)IfNoneMatchadded inv0.177.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsCatalogsBranchesListCall)Viewadded inv0.177.0

View sets the optional parameter "view": The view to apply to the returnedBranch. Defaults to [Branch.BranchView.BASIC] if unspecified. Seedocumentation of fields of Branch to find what fields are excluded fromBASIC view.

Possible values:

"BRANCH_VIEW_UNSPECIFIED" - The value when it's unspecified. This defaults

to the BASIC view.

"BRANCH_VIEW_BASIC" - Includes basic metadata about the branch, but not

statistical fields. See documentation of fields of Branch to find whatfields are excluded from BASIC view.

"BRANCH_VIEW_FULL" - Includes all fields of a Branch.

typeProjectsLocationsCatalogsBranchesOperationsGetCall

type ProjectsLocationsCatalogsBranchesOperationsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesOperationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesOperationsGetCall)Do

Do executes the "retail.projects.locations.catalogs.branches.operations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesOperationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesOperationsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsBranchesOperationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsBranchesOperationsService

type ProjectsLocationsCatalogsBranchesOperationsService struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesOperationsService)Get

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

typeProjectsLocationsCatalogsBranchesPlacesOperationsGetCalladded inv0.95.0

type ProjectsLocationsCatalogsBranchesPlacesOperationsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesPlacesOperationsGetCall)Contextadded inv0.95.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesPlacesOperationsGetCall)Doadded inv0.95.0

Do executes the "retail.projects.locations.catalogs.branches.places.operations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesPlacesOperationsGetCall)Fieldsadded inv0.95.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesPlacesOperationsGetCall)Headeradded inv0.95.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsBranchesPlacesOperationsGetCall)IfNoneMatchadded inv0.95.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsBranchesPlacesOperationsServiceadded inv0.95.0

type ProjectsLocationsCatalogsBranchesPlacesOperationsService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsBranchesPlacesOperationsServiceadded inv0.95.0

func NewProjectsLocationsCatalogsBranchesPlacesOperationsService(s *Service) *ProjectsLocationsCatalogsBranchesPlacesOperationsService

func (*ProjectsLocationsCatalogsBranchesPlacesOperationsService)Getadded inv0.95.0

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

typeProjectsLocationsCatalogsBranchesPlacesServiceadded inv0.95.0

type ProjectsLocationsCatalogsBranchesPlacesService struct {Operations *ProjectsLocationsCatalogsBranchesPlacesOperationsService// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsBranchesPlacesServiceadded inv0.95.0

func NewProjectsLocationsCatalogsBranchesPlacesService(s *Service) *ProjectsLocationsCatalogsBranchesPlacesService

typeProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCalladded inv0.52.0

type ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall)Contextadded inv0.52.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall)Doadded inv0.52.0

Do executes the "retail.projects.locations.catalogs.branches.products.addFulfillmentPlaces" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall)Fieldsadded inv0.52.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsAddFulfillmentPlacesCall)Headeradded inv0.52.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCalladded inv0.61.0

type ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall)Contextadded inv0.61.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall)Doadded inv0.61.0

Do executes the "retail.projects.locations.catalogs.branches.products.addLocalInventories" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall)Fieldsadded inv0.61.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsAddLocalInventoriesCall)Headeradded inv0.61.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsBranchesProductsCreateCall

type ProjectsLocationsCatalogsBranchesProductsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsCreateCall)Do

Do executes the "retail.projects.locations.catalogs.branches.products.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaProduct.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsBranchesProductsCreateCall)ProductId

ProductId sets the optional parameter "productId": Required. The ID to usefor the Product, which will become the final component of the Product.name.If the caller does not have permission to create the Product, regardless ofwhether or not it exists, a PERMISSION_DENIED error is returned. This fieldmust be unique among all Products with the same parent. Otherwise, anALREADY_EXISTS error is returned. This field must be a UTF-8 encoded stringwith a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT erroris returned.

typeProjectsLocationsCatalogsBranchesProductsDeleteCall

type ProjectsLocationsCatalogsBranchesProductsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsDeleteCall)Do

Do executes the "retail.projects.locations.catalogs.branches.products.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsCatalogsBranchesProductsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsDeleteCall)Forceadded inv0.120.0

Force sets the optional parameter "force": This value only applies to thecase when the target product is of type PRIMARY. When deleting a product ofVARIANT/COLLECTION type, this value will be ignored. When set to true, thesubsequent variant products will be deleted. When set to false, if theprimary product has active variant products, an error will be returned.

func (*ProjectsLocationsCatalogsBranchesProductsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsBranchesProductsExportCalladded inv0.191.0

type ProjectsLocationsCatalogsBranchesProductsExportCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsExportCall)Contextadded inv0.191.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsExportCall)Doadded inv0.191.0

Do executes the "retail.projects.locations.catalogs.branches.products.export" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsExportCall)Fieldsadded inv0.191.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsExportCall)Headeradded inv0.191.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsBranchesProductsGetCall

type ProjectsLocationsCatalogsBranchesProductsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsGetCall)Do

Do executes the "retail.projects.locations.catalogs.branches.products.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaProduct.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsBranchesProductsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsBranchesProductsImportCall

type ProjectsLocationsCatalogsBranchesProductsImportCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsImportCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsImportCall)Do

Do executes the "retail.projects.locations.catalogs.branches.products.import" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsImportCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsImportCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsBranchesProductsListCalladded inv0.52.0

type ProjectsLocationsCatalogsBranchesProductsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsListCall)Contextadded inv0.52.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsListCall)Doadded inv0.52.0

Do executes the "retail.projects.locations.catalogs.branches.products.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaListProductsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsListCall)Fieldsadded inv0.52.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsListCall)Filteradded inv0.52.0

Filter sets the optional parameter "filter": A filter to apply on the listresults. Supported features: * List all the products under the parent branchif filter is unset. * List Product.Type.VARIANT Products sharing the sameProduct.Type.PRIMARY Product. For example: `primary_product_id ="some_product_id" * List Products bundled in a Product.Type.COLLECTIONProduct. For example: `collection_product_id = "some_product_id" * ListProducts with a partibular type. For example: `type = "PRIMARY" `type ="VARIANT" `type = "COLLECTION" If the field is unrecognizable, anINVALID_ARGUMENT error is returned. If the specified Product.Type.PRIMARYProduct or Product.Type.COLLECTION Product does not exist, a NOT_FOUND erroris returned.

func (*ProjectsLocationsCatalogsBranchesProductsListCall)Headeradded inv0.52.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsBranchesProductsListCall)IfNoneMatchadded inv0.52.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsCatalogsBranchesProductsListCall)PageSizeadded inv0.52.0

PageSize sets the optional parameter "pageSize": Maximum number of Productsto return. If unspecified, defaults to 100. The maximum allowed value is1000. Values above 1000 will be coerced to 1000. If this field is negative,an INVALID_ARGUMENT error is returned.

func (*ProjectsLocationsCatalogsBranchesProductsListCall)PageTokenadded inv0.52.0

PageToken sets the optional parameter "pageToken": A page tokenListProductsResponse.next_page_token, received from a previousProductService.ListProducts call. Provide this to retrieve the subsequentpage. When paginating, all other parameters provided toProductService.ListProducts must match the call that provided the pagetoken. Otherwise, an INVALID_ARGUMENT error is returned.

func (*ProjectsLocationsCatalogsBranchesProductsListCall)Pagesadded inv0.52.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsCatalogsBranchesProductsListCall)ReadMaskadded inv0.52.0

ReadMask sets the optional parameter "readMask": The fields of Product toreturn in the responses. If not set or empty, the following fields arereturned: * Product.name * Product.id * Product.title * Product.uri *Product.images * Product.price_info * Product.brands If "*" is provided, allfields are returned. Product.name is always returned no matter what mask isset. If an unsupported or unknown field is provided, an INVALID_ARGUMENTerror is returned.

func (*ProjectsLocationsCatalogsBranchesProductsListCall)RequireTotalSizeadded inv0.52.0

RequireTotalSize sets the optional parameter "requireTotalSize": If true andpage_token is empty, ListProductsResponse.total_size is set to the totalcount of matched items irrespective of pagination. Notice that setting thisfield to true affects the performance.

typeProjectsLocationsCatalogsBranchesProductsPatchCall

type ProjectsLocationsCatalogsBranchesProductsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsPatchCall)AllowMissing

AllowMissing sets the optional parameter "allowMissing": If set to true, andthe Product is not found, a new Product will be created. In this situation,`update_mask` is ignored.

func (*ProjectsLocationsCatalogsBranchesProductsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsPatchCall)Do

Do executes the "retail.projects.locations.catalogs.branches.products.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaProduct.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsBranchesProductsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided Product to update. The immutable and output only fields areNOT supported. If not set, all supported fields (the fields that are neitherimmutable nor output only) are updated. If an unsupported or unknown fieldis provided, an INVALID_ARGUMENT error is returned. The attribute key can beupdated by setting the mask path as "attributes.${key_name}". If a key nameis present in the mask but not in the patching product from the request,this key will be deleted after the update.

typeProjectsLocationsCatalogsBranchesProductsPurgeCalladded inv0.74.0

type ProjectsLocationsCatalogsBranchesProductsPurgeCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsPurgeCall)Contextadded inv0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsPurgeCall)Doadded inv0.74.0

Do executes the "retail.projects.locations.catalogs.branches.products.purge" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsPurgeCall)Fieldsadded inv0.74.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsPurgeCall)Headeradded inv0.74.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCalladded inv0.52.0

type ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall)Contextadded inv0.52.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall)Doadded inv0.52.0

Do executes the "retail.projects.locations.catalogs.branches.products.removeFulfillmentPlaces" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall)Fieldsadded inv0.52.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsRemoveFulfillmentPlacesCall)Headeradded inv0.52.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCalladded inv0.61.0

type ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall)Contextadded inv0.61.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall)Doadded inv0.61.0

Do executes the "retail.projects.locations.catalogs.branches.products.removeLocalInventories" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall)Fieldsadded inv0.61.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsRemoveLocalInventoriesCall)Headeradded inv0.61.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsBranchesProductsService

type ProjectsLocationsCatalogsBranchesProductsService struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsService)AddFulfillmentPlacesadded inv0.52.0

AddFulfillmentPlaces: We recommend that you use theProductService.AddLocalInventories method instead of theProductService.AddFulfillmentPlaces method.ProductService.AddLocalInventories achieves the same results but providesmore fine-grained control over ingesting local inventory data. Incrementallyadds place IDs to Product.fulfillment_info.place_ids. This process isasynchronous and does not require the Product to exist before updatingfulfillment information. If the request is valid, the update will beenqueued and processed downstream. As a consequence, when a response isreturned, the added place IDs are not immediately manifested in the Productqueried by ProductService.GetProduct or ProductService.ListProducts. Thereturned Operations will be obsolete after 1 day, and GetOperation API willreturn NOT_FOUND afterwards. If conflicting updates are issued, theOperations associated with the stale updates will not be marked as doneuntil being obsolete.

  • product: Full resource name of Product, such as`projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission toaccess the Product, regardless of whether or not it exists, aPERMISSION_DENIED error is returned.

func (*ProjectsLocationsCatalogsBranchesProductsService)AddLocalInventoriesadded inv0.61.0

AddLocalInventories: Updates local inventory information for a Product at alist of places, while respecting the last update timestamps of eachinventory field. This process is asynchronous and does not require theProduct to exist before updating inventory information. If the request isvalid, the update will be enqueued and processed downstream. As aconsequence, when a response is returned, updates are not immediatelymanifested in the Product queried by ProductService.GetProduct orProductService.ListProducts. Local inventory information can only bemodified using this method. ProductService.CreateProduct andProductService.UpdateProduct has no effect on local inventories. Thereturned Operations will be obsolete after 1 day, and GetOperation API willreturn NOT_FOUND afterwards. If conflicting updates are issued, theOperations associated with the stale updates will not be marked as doneuntil being obsolete.

  • product: Full resource name of Product, such as`projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission toaccess the Product, regardless of whether or not it exists, aPERMISSION_DENIED error is returned.

func (*ProjectsLocationsCatalogsBranchesProductsService)Create

Create: Creates a Product.

  • parent: The parent catalog resource name, such as`projects/*/locations/global/catalogs/default_catalog/branches/default_branch`.

func (*ProjectsLocationsCatalogsBranchesProductsService)Delete

Delete: Deletes a Product.

  • name: Full resource name of Product, such as`projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission todelete the Product, regardless of whether or not it exists, aPERMISSION_DENIED error is returned. If the Product to delete does notexist, a NOT_FOUND error is returned. The Product to delete can neither bea Product.Type.COLLECTION Product member nor a Product.Type.PRIMARYProduct with more than one variants. Otherwise, an INVALID_ARGUMENT erroris returned. All inventory information for the named Product will bedeleted.

func (*ProjectsLocationsCatalogsBranchesProductsService)Exportadded inv0.191.0

Export: Exports multiple Products.

  • parent: Resource name of a Branch, and `default_branch` for branch_idcomponent is supported. For example`projects/1234/locations/global/catalogs/default_catalog/branches/default_branch`.

func (*ProjectsLocationsCatalogsBranchesProductsService)Get

Get: Gets a Product.

  • name: Full resource name of Product, such as`projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission toaccess the Product, regardless of whether or not it exists, aPERMISSION_DENIED error is returned. If the requested Product does notexist, a NOT_FOUND error is returned.

func (*ProjectsLocationsCatalogsBranchesProductsService)Import

Import: Bulk import of multiple Products. Request processing may besynchronous. Non-existing items are created. Note that it is possible for asubset of the Products to be successfully updated.

  • parent:`projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` If no updateMask is specified, requires products.create permission.If updateMask is specified, requires products.update permission.

func (*ProjectsLocationsCatalogsBranchesProductsService)Listadded inv0.52.0

List: Gets a list of Products.

  • parent: The parent branch resource name, such as`projects/*/locations/global/catalogs/default_catalog/branches/0`. Use`default_branch` as the branch ID, to list products under the defaultbranch. If the caller does not have permission to list Products under thisbranch, regardless of whether or not this branch exists, aPERMISSION_DENIED error is returned.

func (*ProjectsLocationsCatalogsBranchesProductsService)Patch

Patch: Updates a Product.

  • name: Immutable. Full resource name of the product, such as`projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.

func (*ProjectsLocationsCatalogsBranchesProductsService)Purgeadded inv0.74.0

Purge: Permanently deletes all selected Products under a branch. Thisprocess is asynchronous. If the request is valid, the removal will beenqueued and processed offline. Depending on the number of Products, thisoperation could take hours to complete. Before the operation completes, someProducts may still be returned by ProductService.GetProduct orProductService.ListProducts. Depending on the number of Products, thisoperation could take hours to complete. To get a sample of Products thatwould be deleted, set PurgeProductsRequest.force to false.

  • parent: The resource name of the branch under which the products arecreated. The format is`projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}`.

func (*ProjectsLocationsCatalogsBranchesProductsService)RemoveFulfillmentPlacesadded inv0.52.0

RemoveFulfillmentPlaces: We recommend that you use theProductService.RemoveLocalInventories method instead of theProductService.RemoveFulfillmentPlaces method.ProductService.RemoveLocalInventories achieves the same results but providesmore fine-grained control over ingesting local inventory data. Incrementallyremoves place IDs from a Product.fulfillment_info.place_ids. This process isasynchronous and does not require the Product to exist before updatingfulfillment information. If the request is valid, the update will beenqueued and processed downstream. As a consequence, when a response isreturned, the removed place IDs are not immediately manifested in theProduct queried by ProductService.GetProduct or ProductService.ListProducts.The returned Operations will be obsolete after 1 day, and GetOperation APIwill return NOT_FOUND afterwards. If conflicting updates are issued, theOperations associated with the stale updates will not be marked as doneuntil being obsolete.

  • product: Full resource name of Product, such as`projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission toaccess the Product, regardless of whether or not it exists, aPERMISSION_DENIED error is returned.

func (*ProjectsLocationsCatalogsBranchesProductsService)RemoveLocalInventoriesadded inv0.61.0

RemoveLocalInventories: Remove local inventory information for a Product ata list of places at a removal timestamp. This process is asynchronous. Ifthe request is valid, the removal will be enqueued and processed downstream.As a consequence, when a response is returned, removals are not immediatelymanifested in the Product queried by ProductService.GetProduct orProductService.ListProducts. Local inventory information can only be removedusing this method. ProductService.CreateProduct andProductService.UpdateProduct has no effect on local inventories. Thereturned Operations will be obsolete after 1 day, and GetOperation API willreturn NOT_FOUND afterwards. If conflicting updates are issued, theOperations associated with the stale updates will not be marked as doneuntil being obsolete.

  • product: Full resource name of Product, such as`projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission toaccess the Product, regardless of whether or not it exists, aPERMISSION_DENIED error is returned.

func (*ProjectsLocationsCatalogsBranchesProductsService)SetInventoryadded inv0.52.0

SetInventory: Updates inventory information for a Product while respectingthe last update timestamps of each inventory field. This process isasynchronous and does not require the Product to exist before updatingfulfillment information. If the request is valid, the update is enqueued andprocessed downstream. As a consequence, when a response is returned, updatesare not immediately manifested in the Product queried byProductService.GetProduct or ProductService.ListProducts. When inventory isupdated with ProductService.CreateProduct and ProductService.UpdateProduct,the specified inventory field value(s) overwrite any existing value(s) whileignoring the last update time for this field. Furthermore, the last updatetimes for the specified inventory fields are overwritten by the times of theProductService.CreateProduct or ProductService.UpdateProduct request. If noinventory fields are set in CreateProductRequest.product, then anypre-existing inventory information for this product is used. If no inventoryfields are set in SetInventoryRequest.set_mask, then any existing inventoryinformation is preserved. Pre-existing inventory information can only beupdated with ProductService.SetInventory,ProductService.AddFulfillmentPlaces, andProductService.RemoveFulfillmentPlaces. The returned Operations is obsoleteafter one day, and the GetOperation API returns `NOT_FOUND` afterwards. Ifconflicting updates are issued, the Operations associated with the staleupdates are not marked as done until they are obsolete.

  • name: Immutable. Full resource name of the product, such as`projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.

typeProjectsLocationsCatalogsBranchesProductsSetInventoryCalladded inv0.52.0

type ProjectsLocationsCatalogsBranchesProductsSetInventoryCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesProductsSetInventoryCall)Contextadded inv0.52.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsBranchesProductsSetInventoryCall)Doadded inv0.52.0

Do executes the "retail.projects.locations.catalogs.branches.products.setInventory" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsBranchesProductsSetInventoryCall)Fieldsadded inv0.52.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsBranchesProductsSetInventoryCall)Headeradded inv0.52.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsBranchesService

type ProjectsLocationsCatalogsBranchesService struct {Operations *ProjectsLocationsCatalogsBranchesOperationsServicePlaces *ProjectsLocationsCatalogsBranchesPlacesServiceProducts *ProjectsLocationsCatalogsBranchesProductsService// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsBranchesService)Getadded inv0.177.0

Get: Retrieves a Branch.

  • name: The name of the branch to retrieve. Format:`projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns thedefault branch that has been set for the catalog.

func (*ProjectsLocationsCatalogsBranchesService)Listadded inv0.177.0

List: Lists all instances of Branch under the specified parent Catalog.

- parent: The parent catalog resource name.

typeProjectsLocationsCatalogsCompleteQueryCalladded inv0.52.0

type ProjectsLocationsCatalogsCompleteQueryCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsCompleteQueryCall)Contextadded inv0.52.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsCompleteQueryCall)Datasetadded inv0.52.0

Dataset sets the optional parameter "dataset": Determines which dataset touse for fetching completion. "user-data" will use the dataset importedthrough CompletionService.ImportCompletionData. `cloud-retail` will use thedataset generated by Cloud Retail based on user events. If left empty,completions will be fetched from the `user-data` dataset. Current supportedvalues: * user-data * cloud-retail: This option requires enablingauto-learning function first. See guidelines(https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).

func (*ProjectsLocationsCatalogsCompleteQueryCall)DeviceTypeadded inv0.52.0

DeviceType sets the optional parameter "deviceType": The device type contextfor completion suggestions. We recommend that you leave this field empty. Itcan 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` * Acustomized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.

func (*ProjectsLocationsCatalogsCompleteQueryCall)Doadded inv0.52.0

Do executes the "retail.projects.locations.catalogs.completeQuery" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaCompleteQueryResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsCompleteQueryCall)EnableAttributeSuggestionsadded inv0.102.0

func (c *ProjectsLocationsCatalogsCompleteQueryCall) EnableAttributeSuggestions(enableAttributeSuggestionsbool) *ProjectsLocationsCatalogsCompleteQueryCall

EnableAttributeSuggestions sets the optional parameter"enableAttributeSuggestions": If true, attribute suggestions are enabled andprovided in the response. This field is only available for the`cloud-retail` dataset.

func (*ProjectsLocationsCatalogsCompleteQueryCall)Entityadded inv0.118.0

Entity sets the optional parameter "entity": The entity for customers whorun multiple entities, domains, sites, or regions, for example, `Google US`,`Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, itmust be an exact match with UserEvent.entity to get per-entity autocompleteresults. This field will be applied to `completion_results` only. It has noeffect on the `attribute_results`. Also, this entity should be limited to256 characters, if too long, it will be truncated to 256 characters in bothgeneration and serving time, and may lead to mis-match. To ensure it works,please set the entity with string within 256 characters.

func (*ProjectsLocationsCatalogsCompleteQueryCall)Fieldsadded inv0.52.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsCompleteQueryCall)Headeradded inv0.52.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsCompleteQueryCall)IfNoneMatchadded inv0.52.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsCatalogsCompleteQueryCall)LanguageCodesadded inv0.52.0

LanguageCodes sets the optional parameter "languageCodes": Note that thisfield applies for `user-data` dataset only. For requests with `cloud-retail`dataset, setting this field has no effect. The language filters applied tothe output suggestions. If set, it should contain the language of the query.If not set, suggestions are returned without considering languagerestrictions. This is the BCP-47 language code, such as "en-US" or"sr-Latn". For more information, see Tags for Identifying Languages(https://tools.ietf.org/html/bcp47). The maximum number of language codes is3.

func (*ProjectsLocationsCatalogsCompleteQueryCall)MaxSuggestionsadded inv0.52.0

MaxSuggestions sets the optional parameter "maxSuggestions": Completion maxsuggestions. If left unset or set to 0, then will fallback to the configuredvalue CompletionConfig.max_suggestions. The maximum allowed max suggestionsis 20. If it is set higher, it will be capped by 20.

func (*ProjectsLocationsCatalogsCompleteQueryCall)Queryadded inv0.52.0

Query sets the optional parameter "query": Required. The query used togenerate suggestions. The maximum number of allowed characters is 255.

func (*ProjectsLocationsCatalogsCompleteQueryCall)VisitorIdadded inv0.52.0

VisitorId sets the optional parameter "visitorId": Recommended field. Aunique identifier for tracking visitors. For example, this could beimplemented with an HTTP cookie, which should be able to uniquely identify avisitor on a single device. This unique identifier should not change if thevisitor logs in or out of the website. The field must be a UTF-8 encodedstring with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENTerror is returned.

typeProjectsLocationsCatalogsCompletionDataImportCalladded inv0.52.0

type ProjectsLocationsCatalogsCompletionDataImportCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsCompletionDataImportCall)Contextadded inv0.52.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsCompletionDataImportCall)Doadded inv0.52.0

Do executes the "retail.projects.locations.catalogs.completionData.import" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsCompletionDataImportCall)Fieldsadded inv0.52.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsCompletionDataImportCall)Headeradded inv0.52.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsCompletionDataServiceadded inv0.52.0

type ProjectsLocationsCatalogsCompletionDataService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsCompletionDataServiceadded inv0.52.0

func NewProjectsLocationsCatalogsCompletionDataService(s *Service) *ProjectsLocationsCatalogsCompletionDataService

func (*ProjectsLocationsCatalogsCompletionDataService)Importadded inv0.52.0

Import: Bulk import of processed completion dataset. Request processing isasynchronous. Partial updating is not supported. The operation issuccessfully finished only after the imported suggestions are indexedsuccessfully and ready for serving. The process takes hours. This feature isonly available for users who have Retail Search enabled. Enable RetailSearch on Cloud Console before using this feature.

  • parent: The catalog which the suggestions dataset belongs to. Format:`projects/1234/locations/global/catalogs/default_catalog`.

typeProjectsLocationsCatalogsControlsCreateCalladded inv0.66.0

type ProjectsLocationsCatalogsControlsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsControlsCreateCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsControlsCreateCall)ControlIdadded inv0.66.0

ControlId sets the optional parameter "controlId": Required. The ID to usefor the Control, which will become the final component of the Control'sresource name. This value should be 4-63 characters, and valid charactersare /a-z-_/.

func (*ProjectsLocationsCatalogsControlsCreateCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.controls.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaControl.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsControlsCreateCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsControlsCreateCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsControlsDeleteCalladded inv0.66.0

type ProjectsLocationsCatalogsControlsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsControlsDeleteCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsControlsDeleteCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.controls.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsCatalogsControlsDeleteCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsControlsDeleteCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsControlsGetCalladded inv0.66.0

type ProjectsLocationsCatalogsControlsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsControlsGetCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsControlsGetCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.controls.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaControl.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsControlsGetCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsControlsGetCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsControlsGetCall)IfNoneMatchadded inv0.66.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsControlsListCalladded inv0.66.0

type ProjectsLocationsCatalogsControlsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsControlsListCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsControlsListCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.controls.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaListControlsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsControlsListCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsControlsListCall)Filteradded inv0.66.0

Filter sets the optional parameter "filter": A filter to apply on the listresults. Supported features: * List all the products under the parent branchif filter is unset. * List controls that are used in a single ServingConfig:'serving_config = "boosted_home_page_cvr"'

func (*ProjectsLocationsCatalogsControlsListCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsControlsListCall)IfNoneMatchadded inv0.66.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsCatalogsControlsListCall)PageSizeadded inv0.66.0

PageSize sets the optional parameter "pageSize": Maximum number of resultsto return. If unspecified, defaults to 50. Max allowed value is 1000.

func (*ProjectsLocationsCatalogsControlsListCall)PageTokenadded inv0.66.0

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListControls` call. Provide this to retrieve the subsequentpage.

func (*ProjectsLocationsCatalogsControlsListCall)Pagesadded inv0.66.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsCatalogsControlsPatchCalladded inv0.66.0

type ProjectsLocationsCatalogsControlsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsControlsPatchCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsControlsPatchCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.controls.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaControl.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsControlsPatchCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsControlsPatchCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsControlsPatchCall)UpdateMaskadded inv0.66.0

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided Control to update. The following are NOT supported: *Control.name If not set or empty, all supported fields are updated.

typeProjectsLocationsCatalogsControlsServiceadded inv0.66.0

type ProjectsLocationsCatalogsControlsService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsControlsServiceadded inv0.66.0

func NewProjectsLocationsCatalogsControlsService(s *Service) *ProjectsLocationsCatalogsControlsService

func (*ProjectsLocationsCatalogsControlsService)Createadded inv0.66.0

Create: Creates a Control. If the Control to create already exists, anALREADY_EXISTS error is returned.

  • parent: Full resource name of parent catalog. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`.

func (*ProjectsLocationsCatalogsControlsService)Deleteadded inv0.66.0

Delete: Deletes a Control. If the Control to delete does not exist, aNOT_FOUND error is returned.

  • name: The resource name of the Control to delete. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`.

func (*ProjectsLocationsCatalogsControlsService)Getadded inv0.66.0

Get: Gets a Control.

  • name: The resource name of the Control to get. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`.

func (*ProjectsLocationsCatalogsControlsService)Listadded inv0.66.0

List: Lists all Controls by their parent Catalog.

  • parent: The catalog resource name. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`.

func (*ProjectsLocationsCatalogsControlsService)Patchadded inv0.66.0

Patch: Updates a Control. Control cannot be set to a different oneof field,if so an INVALID_ARGUMENT is returned. If the Control to update does notexist, a NOT_FOUND error is returned.

  • name: Immutable. Fully qualified name`projects/*/locations/global/catalogs/*/controls/*`.

typeProjectsLocationsCatalogsExportAnalyticsMetricsCalladded inv0.154.0

type ProjectsLocationsCatalogsExportAnalyticsMetricsCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsExportAnalyticsMetricsCall)Contextadded inv0.154.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsExportAnalyticsMetricsCall)Doadded inv0.154.0

Do executes the "retail.projects.locations.catalogs.exportAnalyticsMetrics" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsExportAnalyticsMetricsCall)Fieldsadded inv0.154.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsExportAnalyticsMetricsCall)Headeradded inv0.154.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsGenerativeQuestionBatchUpdateCalladded inv0.199.0

type ProjectsLocationsCatalogsGenerativeQuestionBatchUpdateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsGenerativeQuestionBatchUpdateCall)Contextadded inv0.199.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsGenerativeQuestionBatchUpdateCall)Doadded inv0.199.0

Do executes the "retail.projects.locations.catalogs.generativeQuestion.batchUpdate" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsGenerativeQuestionBatchUpdateCall)Fieldsadded inv0.199.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsGenerativeQuestionBatchUpdateCall)Headeradded inv0.199.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsGenerativeQuestionServiceadded inv0.199.0

type ProjectsLocationsCatalogsGenerativeQuestionService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsGenerativeQuestionServiceadded inv0.199.0

func NewProjectsLocationsCatalogsGenerativeQuestionService(s *Service) *ProjectsLocationsCatalogsGenerativeQuestionService

func (*ProjectsLocationsCatalogsGenerativeQuestionService)BatchUpdateadded inv0.199.0

BatchUpdate: Allows management of multiple questions.

  • parent: Optional. Resource name of the parent catalog. Format:projects/{project}/locations/{location}/catalogs/{catalog}.

typeProjectsLocationsCatalogsGenerativeQuestionsListCalladded inv0.199.0

type ProjectsLocationsCatalogsGenerativeQuestionsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsGenerativeQuestionsListCall)Contextadded inv0.199.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsGenerativeQuestionsListCall)Doadded inv0.199.0

Do executes the "retail.projects.locations.catalogs.generativeQuestions.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsGenerativeQuestionsListCall)Fieldsadded inv0.199.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsGenerativeQuestionsListCall)Headeradded inv0.199.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsGenerativeQuestionsListCall)IfNoneMatchadded inv0.199.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsGenerativeQuestionsServiceadded inv0.199.0

type ProjectsLocationsCatalogsGenerativeQuestionsService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsGenerativeQuestionsServiceadded inv0.199.0

func NewProjectsLocationsCatalogsGenerativeQuestionsService(s *Service) *ProjectsLocationsCatalogsGenerativeQuestionsService

func (*ProjectsLocationsCatalogsGenerativeQuestionsService)Listadded inv0.199.0

List: Returns all questions for a given catalog.

  • parent: Resource name of the parent catalog. Format:projects/{project}/locations/{location}/catalogs/{catalog}.

typeProjectsLocationsCatalogsGetAttributesConfigCalladded inv0.71.0

type ProjectsLocationsCatalogsGetAttributesConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsGetAttributesConfigCall)Contextadded inv0.71.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsGetAttributesConfigCall)Doadded inv0.71.0

Do executes the "retail.projects.locations.catalogs.getAttributesConfig" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaAttributesConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsGetAttributesConfigCall)Fieldsadded inv0.71.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsGetAttributesConfigCall)Headeradded inv0.71.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsGetAttributesConfigCall)IfNoneMatchadded inv0.71.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsGetCompletionConfigCalladded inv0.74.0

type ProjectsLocationsCatalogsGetCompletionConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsGetCompletionConfigCall)Contextadded inv0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsGetCompletionConfigCall)Doadded inv0.74.0

Do executes the "retail.projects.locations.catalogs.getCompletionConfig" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaCompletionConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsGetCompletionConfigCall)Fieldsadded inv0.74.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsGetCompletionConfigCall)Headeradded inv0.74.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsGetCompletionConfigCall)IfNoneMatchadded inv0.74.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsGetConversationalSearchCustomizationConfigCalladded inv0.239.0

type ProjectsLocationsCatalogsGetConversationalSearchCustomizationConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsGetConversationalSearchCustomizationConfigCall)Contextadded inv0.239.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsGetConversationalSearchCustomizationConfigCall)Doadded inv0.239.0

Do executes the "retail.projects.locations.catalogs.getConversationalSearchCustomizationConfig" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsGetConversationalSearchCustomizationConfigCall)Fieldsadded inv0.239.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsGetConversationalSearchCustomizationConfigCall)Headeradded inv0.239.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsGetConversationalSearchCustomizationConfigCall)IfNoneMatchadded inv0.239.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsGetDefaultBranchCalladded inv0.52.0

type ProjectsLocationsCatalogsGetDefaultBranchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsGetDefaultBranchCall)Contextadded inv0.52.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsGetDefaultBranchCall)Doadded inv0.52.0

Do executes the "retail.projects.locations.catalogs.getDefaultBranch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaGetDefaultBranchResponse.ServerResponse.Header or(if a response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsGetDefaultBranchCall)Fieldsadded inv0.52.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsGetDefaultBranchCall)Headeradded inv0.52.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsGetDefaultBranchCall)IfNoneMatchadded inv0.52.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsGetGenerativeQuestionFeatureCalladded inv0.199.0

type ProjectsLocationsCatalogsGetGenerativeQuestionFeatureCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsGetGenerativeQuestionFeatureCall)Contextadded inv0.199.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsGetGenerativeQuestionFeatureCall)Doadded inv0.199.0

Do executes the "retail.projects.locations.catalogs.getGenerativeQuestionFeature" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsGetGenerativeQuestionFeatureCall)Fieldsadded inv0.199.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsGetGenerativeQuestionFeatureCall)Headeradded inv0.199.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsGetGenerativeQuestionFeatureCall)IfNoneMatchadded inv0.199.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsListCall

type ProjectsLocationsCatalogsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsListCall)Do

Do executes the "retail.projects.locations.catalogs.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaListCatalogsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsCatalogsListCall)PageSize

PageSize sets the optional parameter "pageSize": Maximum number of Catalogsto return. If unspecified, defaults to 50. The maximum allowed value is1000. Values above 1000 will be coerced to 1000. If this field is negative,an INVALID_ARGUMENT is returned.

func (*ProjectsLocationsCatalogsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page tokenListCatalogsResponse.next_page_token, received from a previousCatalogService.ListCatalogs call. Provide this to retrieve the subsequentpage. When paginating, all other parameters provided toCatalogService.ListCatalogs must match the call that provided the pagetoken. Otherwise, an INVALID_ARGUMENT error is returned.

func (*ProjectsLocationsCatalogsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsCatalogsMerchantCenterAccountLinksCreateCalladded inv0.121.0

type ProjectsLocationsCatalogsMerchantCenterAccountLinksCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksCreateCall)Contextadded inv0.121.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksCreateCall)Doadded inv0.121.0

Do executes the "retail.projects.locations.catalogs.merchantCenterAccountLinks.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksCreateCall)Fieldsadded inv0.121.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksCreateCall)Headeradded inv0.121.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsMerchantCenterAccountLinksDeleteCalladded inv0.115.0

type ProjectsLocationsCatalogsMerchantCenterAccountLinksDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksDeleteCall)Contextadded inv0.115.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksDeleteCall)Doadded inv0.115.0

Do executes the "retail.projects.locations.catalogs.merchantCenterAccountLinks.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksDeleteCall)Fieldsadded inv0.115.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksDeleteCall)Headeradded inv0.115.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsMerchantCenterAccountLinksListCalladded inv0.115.0

type ProjectsLocationsCatalogsMerchantCenterAccountLinksListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksListCall)Contextadded inv0.115.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksListCall)Doadded inv0.115.0

Do executes the "retail.projects.locations.catalogs.merchantCenterAccountLinks.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksListCall)Fieldsadded inv0.115.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksListCall)Headeradded inv0.115.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksListCall)IfNoneMatchadded inv0.115.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsMerchantCenterAccountLinksServiceadded inv0.115.0

type ProjectsLocationsCatalogsMerchantCenterAccountLinksService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsMerchantCenterAccountLinksServiceadded inv0.115.0

func NewProjectsLocationsCatalogsMerchantCenterAccountLinksService(s *Service) *ProjectsLocationsCatalogsMerchantCenterAccountLinksService

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksService)Createadded inv0.121.0

Create: Creates a MerchantCenterAccountLink.

  • parent: The branch resource where this MerchantCenterAccountLink will becreated. Format:`projects/{PROJECT_NUMBER}/locations/global/catalogs/{CATALOG_ID}`.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksService)Deleteadded inv0.115.0

Delete: Deletes a MerchantCenterAccountLink. If theMerchantCenterAccountLink to delete does not exist, a NOT_FOUND error isreturned.

  • name: Full resource name. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/merchantCenterAccountLinks/{merchant_center_account_link_id}`.

func (*ProjectsLocationsCatalogsMerchantCenterAccountLinksService)Listadded inv0.115.0

List: Lists all MerchantCenterAccountLinks under the specified parentCatalog.

  • parent: The parent Catalog of the resource. It must match this format:`projects/{PROJECT_NUMBER}/locations/global/catalogs/{CATALOG_ID}`.

typeProjectsLocationsCatalogsModelsCreateCalladded inv0.89.0

type ProjectsLocationsCatalogsModelsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsModelsCreateCall)Contextadded inv0.89.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsModelsCreateCall)Doadded inv0.89.0

Do executes the "retail.projects.locations.catalogs.models.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsModelsCreateCall)DryRunadded inv0.89.0

DryRun sets the optional parameter "dryRun": Whether to run a dry run tovalidate the request (without actually creating the model).

func (*ProjectsLocationsCatalogsModelsCreateCall)Fieldsadded inv0.89.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsModelsCreateCall)Headeradded inv0.89.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsModelsDeleteCalladded inv0.89.0

type ProjectsLocationsCatalogsModelsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsModelsDeleteCall)Contextadded inv0.89.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsModelsDeleteCall)Doadded inv0.89.0

Do executes the "retail.projects.locations.catalogs.models.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsCatalogsModelsDeleteCall)Fieldsadded inv0.89.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsModelsDeleteCall)Headeradded inv0.89.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsModelsGetCalladded inv0.110.0

type ProjectsLocationsCatalogsModelsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsModelsGetCall)Contextadded inv0.110.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsModelsGetCall)Doadded inv0.110.0

Do executes the "retail.projects.locations.catalogs.models.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaModel.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsModelsGetCall)Fieldsadded inv0.110.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsModelsGetCall)Headeradded inv0.110.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsModelsGetCall)IfNoneMatchadded inv0.110.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsModelsListCalladded inv0.89.0

type ProjectsLocationsCatalogsModelsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsModelsListCall)Contextadded inv0.89.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsModelsListCall)Doadded inv0.89.0

Do executes the "retail.projects.locations.catalogs.models.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaListModelsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsModelsListCall)Fieldsadded inv0.89.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsModelsListCall)Headeradded inv0.89.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsModelsListCall)IfNoneMatchadded inv0.89.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsCatalogsModelsListCall)PageSizeadded inv0.89.0

PageSize sets the optional parameter "pageSize": Maximum number of resultsto return. If unspecified, defaults to 50. Max allowed value is 1000.

func (*ProjectsLocationsCatalogsModelsListCall)PageTokenadded inv0.89.0

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListModels` call. Provide this to retrieve the subsequentpage.

func (*ProjectsLocationsCatalogsModelsListCall)Pagesadded inv0.89.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsCatalogsModelsPatchCalladded inv0.89.0

type ProjectsLocationsCatalogsModelsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsModelsPatchCall)Contextadded inv0.89.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsModelsPatchCall)Doadded inv0.89.0

Do executes the "retail.projects.locations.catalogs.models.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaModel.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsModelsPatchCall)Fieldsadded inv0.89.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsModelsPatchCall)Headeradded inv0.89.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsModelsPatchCall)UpdateMaskadded inv0.89.0

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided 'model' to update. If not set, by default updates allfields.

typeProjectsLocationsCatalogsModelsPauseCalladded inv0.89.0

type ProjectsLocationsCatalogsModelsPauseCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsModelsPauseCall)Contextadded inv0.89.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsModelsPauseCall)Doadded inv0.89.0

Do executes the "retail.projects.locations.catalogs.models.pause" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaModel.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsModelsPauseCall)Fieldsadded inv0.89.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsModelsPauseCall)Headeradded inv0.89.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsModelsResumeCalladded inv0.89.0

type ProjectsLocationsCatalogsModelsResumeCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsModelsResumeCall)Contextadded inv0.89.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsModelsResumeCall)Doadded inv0.89.0

Do executes the "retail.projects.locations.catalogs.models.resume" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaModel.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsModelsResumeCall)Fieldsadded inv0.89.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsModelsResumeCall)Headeradded inv0.89.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsModelsServiceadded inv0.89.0

type ProjectsLocationsCatalogsModelsService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsModelsServiceadded inv0.89.0

func NewProjectsLocationsCatalogsModelsService(s *Service) *ProjectsLocationsCatalogsModelsService

func (*ProjectsLocationsCatalogsModelsService)Createadded inv0.89.0

Create: Creates a new model.

  • parent: The parent resource under which to create the model. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`.

func (*ProjectsLocationsCatalogsModelsService)Deleteadded inv0.89.0

Delete: Deletes an existing model.

  • name: The resource name of the Model to delete. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`.

func (*ProjectsLocationsCatalogsModelsService)Getadded inv0.110.0

Get: Gets a model.

  • name: The resource name of the Model to get. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}`.

func (*ProjectsLocationsCatalogsModelsService)Listadded inv0.89.0

List: Lists all the models linked to this event store.

  • parent: The parent for which to list models. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`.

func (*ProjectsLocationsCatalogsModelsService)Patchadded inv0.89.0

Patch: Update of model metadata. Only fields that currently can be updatedare: `filtering_option` and `periodic_tuning_state`. If other values areprovided, this API method ignores them.

  • name: The fully qualified resource name of the model. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_idhas char limit of 40.

func (*ProjectsLocationsCatalogsModelsService)Pauseadded inv0.89.0

Pause: Pauses the training of an existing model.

  • name: The name of the model to pause. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`.

func (*ProjectsLocationsCatalogsModelsService)Resumeadded inv0.89.0

Resume: Resumes the training of an existing model.

  • name: The name of the model to resume. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`.

func (*ProjectsLocationsCatalogsModelsService)Tuneadded inv0.89.0

Tune: Tunes an existing model.

  • name: The resource name of the model to tune. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`.

typeProjectsLocationsCatalogsModelsTuneCalladded inv0.89.0

type ProjectsLocationsCatalogsModelsTuneCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsModelsTuneCall)Contextadded inv0.89.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsModelsTuneCall)Doadded inv0.89.0

Do executes the "retail.projects.locations.catalogs.models.tune" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsModelsTuneCall)Fieldsadded inv0.89.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsModelsTuneCall)Headeradded inv0.89.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsOperationsGetCall

type ProjectsLocationsCatalogsOperationsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsOperationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsOperationsGetCall)Do

Do executes the "retail.projects.locations.catalogs.operations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsOperationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsOperationsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsOperationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsOperationsListCall

type ProjectsLocationsCatalogsOperationsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsOperationsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsOperationsListCall)Do

Do executes the "retail.projects.locations.catalogs.operations.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsOperationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsOperationsListCall)Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsCatalogsOperationsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsOperationsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsCatalogsOperationsListCall)PageSize

PageSize sets the optional parameter "pageSize": The standard list pagesize.

func (*ProjectsLocationsCatalogsOperationsListCall)PageToken

PageToken sets the optional parameter "pageToken": The standard list pagetoken.

func (*ProjectsLocationsCatalogsOperationsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsCatalogsOperationsListCall)ReturnPartialSuccessadded inv0.253.0

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in theListOperationsResponse.unreachable field. This can only be `true` whenreading across collections. For example, when `parent` is set to"projects/example/locations/-". This field is not supported by default andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeProjectsLocationsCatalogsOperationsService

type ProjectsLocationsCatalogsOperationsService struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsOperationsService)Get

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

func (*ProjectsLocationsCatalogsOperationsService)List

List: Lists operations that match the specified filter in the request. Ifthe server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

typeProjectsLocationsCatalogsPatchCall

type ProjectsLocationsCatalogsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsPatchCall)Do

Do executes the "retail.projects.locations.catalogs.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaCatalog.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided Catalog to update. If an unsupported or unknown field isprovided, an INVALID_ARGUMENT error is returned.

typeProjectsLocationsCatalogsPlacementsConversationalSearchCalladded inv0.227.0

type ProjectsLocationsCatalogsPlacementsConversationalSearchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsPlacementsConversationalSearchCall)Contextadded inv0.227.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsPlacementsConversationalSearchCall)Doadded inv0.227.0

Do executes the "retail.projects.locations.catalogs.placements.conversationalSearch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaConversationalSearchResponse.ServerResponse.Headeror (if a response was returned at all) in error.(*googleapi.Error).Header.Use googleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsPlacementsConversationalSearchCall)Fieldsadded inv0.227.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsPlacementsConversationalSearchCall)Headeradded inv0.227.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsPlacementsPredictCall

type ProjectsLocationsCatalogsPlacementsPredictCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsPlacementsPredictCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsPlacementsPredictCall)Do

Do executes the "retail.projects.locations.catalogs.placements.predict" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaPredictResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsPlacementsPredictCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsPlacementsPredictCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsPlacementsSearchCalladded inv0.52.0

type ProjectsLocationsCatalogsPlacementsSearchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsPlacementsSearchCall)Contextadded inv0.52.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsPlacementsSearchCall)Doadded inv0.52.0

Do executes the "retail.projects.locations.catalogs.placements.search" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaSearchResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsPlacementsSearchCall)Fieldsadded inv0.52.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsPlacementsSearchCall)Headeradded inv0.52.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsPlacementsSearchCall)Pagesadded inv0.52.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsCatalogsPlacementsService

type ProjectsLocationsCatalogsPlacementsService struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsPlacementsService)ConversationalSearchadded inv0.227.0

ConversationalSearch: Performs a conversational search. This feature is onlyavailable for users who have Conversational Search enabled.

  • placement: The resource name of the search engine placement, such as`projects/*/locations/global/catalogs/default_catalog/placements/default_search` or`projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config nameand the set of models that will be used to make the search.

func (*ProjectsLocationsCatalogsPlacementsService)Predict

Predict: Makes a recommendation prediction.

  • placement: Full resource name of the format:`{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or`{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is alegacy resource. The ID of the Recommendations AI serving config orplacement. Before you can request predictions from your model, you mustcreate at least one serving config or placement for it. For moreinformation, see [Manage serving configs](https://cloud.google.com/retail/docs/manage-configs). The full list ofavailable serving configs can be seen athttps://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs.

func (*ProjectsLocationsCatalogsPlacementsService)Searchadded inv0.52.0

Search: Performs a search. This feature is only available for users who haveRetail Search enabled. Enable Retail Search on Cloud Console before usingthis feature.

  • placement: The resource name of the Retail Search serving config, such as`projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as`projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving config name and the setof models that are used to make the search.

typeProjectsLocationsCatalogsService

type ProjectsLocationsCatalogsService struct {AttributesConfig *ProjectsLocationsCatalogsAttributesConfigServiceBranches *ProjectsLocationsCatalogsBranchesServiceCompletionData *ProjectsLocationsCatalogsCompletionDataServiceControls *ProjectsLocationsCatalogsControlsServiceGenerativeQuestion *ProjectsLocationsCatalogsGenerativeQuestionServiceGenerativeQuestions *ProjectsLocationsCatalogsGenerativeQuestionsServiceMerchantCenterAccountLinks *ProjectsLocationsCatalogsMerchantCenterAccountLinksServiceModels *ProjectsLocationsCatalogsModelsServiceOperations *ProjectsLocationsCatalogsOperationsServicePlacements *ProjectsLocationsCatalogsPlacementsServiceServingConfigs *ProjectsLocationsCatalogsServingConfigsServiceUserEvents *ProjectsLocationsCatalogsUserEventsService// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsService

func NewProjectsLocationsCatalogsService(s *Service) *ProjectsLocationsCatalogsService

func (*ProjectsLocationsCatalogsService)CompleteQueryadded inv0.52.0

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

  • catalog: Catalog for which the completion is performed. Full resource nameof catalog, such as`projects/*/locations/global/catalogs/default_catalog`.

func (*ProjectsLocationsCatalogsService)ExportAnalyticsMetricsadded inv0.154.0

func (r *ProjectsLocationsCatalogsService) ExportAnalyticsMetrics(catalogstring, googlecloudretailv2alphaexportanalyticsmetricsrequest *GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest) *ProjectsLocationsCatalogsExportAnalyticsMetricsCall

ExportAnalyticsMetrics: Exports analytics metrics. `Operation.response` isof type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type`ExportMetadata`.

  • catalog: Full resource name of the parent catalog. Expected format:`projects/*/locations/*/catalogs/*`.

func (*ProjectsLocationsCatalogsService)GetAttributesConfigadded inv0.71.0

GetAttributesConfig: Gets an AttributesConfig.

  • name: Full AttributesConfig resource name. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`.

func (*ProjectsLocationsCatalogsService)GetCompletionConfigadded inv0.74.0

GetCompletionConfig: Gets a CompletionConfig.

  • name: Full CompletionConfig resource name. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`.

func (*ProjectsLocationsCatalogsService)GetConversationalSearchCustomizationConfigadded inv0.239.0

GetConversationalSearchCustomizationConfig: Returns the conversationalsearch customization config for a given catalog.

  • name: Resource name of the parent catalog. Format:projects/{project}/locations/{location}/catalogs/{catalog}.

func (*ProjectsLocationsCatalogsService)GetDefaultBranchadded inv0.52.0

GetDefaultBranch: Get which branch is currently default branch set byCatalogService.SetDefaultBranch method under a specified parent catalog.

  • catalog: The parent catalog resource name, such as`projects/*/locations/global/catalogs/default_catalog`.

func (*ProjectsLocationsCatalogsService)GetGenerativeQuestionFeatureadded inv0.199.0

GetGenerativeQuestionFeature: Manages overal generative question featurestate -- enables toggling feature on and off.

  • catalog: Resource name of the parent catalog. Format:projects/{project}/locations/{location}/catalogs/{catalog}.

func (*ProjectsLocationsCatalogsService)List

List: Lists all the Catalogs associated with the project.

  • parent: The account resource name with an associated location. If thecaller does not have permission to list Catalogs under this location,regardless of whether or not this location exists, a PERMISSION_DENIEDerror is returned.

func (*ProjectsLocationsCatalogsService)Patch

Patch: Updates the Catalogs.

- name: Immutable. The fully qualified resource name of the catalog.

func (*ProjectsLocationsCatalogsService)SetDefaultBranchadded inv0.52.0

func (r *ProjectsLocationsCatalogsService) SetDefaultBranch(catalogstring, googlecloudretailv2alphasetdefaultbranchrequest *GoogleCloudRetailV2alphaSetDefaultBranchRequest) *ProjectsLocationsCatalogsSetDefaultBranchCall

SetDefaultBranch: Set a specified branch id as default branch. API methodssuch as SearchService.Search, ProductService.GetProduct,ProductService.ListProducts will treat requests using "default_branch" tothe actual branch id set as default. For example, if`projects/*/locations/*/catalogs/*/branches/1` is set as default, settingSearchRequest.branch to`projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent tosetting SearchRequest.branch to`projects/*/locations/*/catalogs/*/branches/1`. Using multiple branches canbe useful when developers would like to have a staging branch to test andverify for future usage. When it becomes ready, developers switch on thestaging branch using this API while keeping using`projects/*/locations/*/catalogs/*/branches/default_branch` asSearchRequest.branch to route the traffic to this staging branch. CAUTION:If you have live predict/search traffic, switching the default branch couldpotentially cause outages if the ID space of the new branch is verydifferent from the old one. More specifically: * PredictionService will onlyreturn product IDs from branch {newBranch}. * SearchService will only returnproduct IDs from branch {newBranch} (if branch is not explicitly set). *UserEventService will only join events with products from branch{newBranch}.

  • catalog: Full resource name of the catalog, such as`projects/*/locations/global/catalogs/default_catalog`.

func (*ProjectsLocationsCatalogsService)UpdateAttributesConfigadded inv0.71.0

UpdateAttributesConfig: Updates the AttributesConfig. The catalog attributesin the request will be updated in the catalog, or inserted if they do notexist. Existing catalog attributes not included in the request will remainunchanged. Attributes that are assigned to products, but do not exist at thecatalog level, are always included in the response. The product attribute isassigned default values for missing catalog attribute fields, e.g.,searchable and dynamic facetable options.

  • name: Immutable. The fully qualified resource name of the attributeconfig. Format: `projects/*/locations/*/catalogs/*/attributesConfig`.

func (*ProjectsLocationsCatalogsService)UpdateCompletionConfigadded inv0.74.0

UpdateCompletionConfig: Updates the CompletionConfigs.

  • name: Immutable. Fully qualified name`projects/*/locations/*/catalogs/*/completionConfig`.

func (*ProjectsLocationsCatalogsService)UpdateConversationalSearchCustomizationConfigadded inv0.239.0

func (r *ProjectsLocationsCatalogsService) UpdateConversationalSearchCustomizationConfig(catalogstring, googlecloudretailv2alphaconversationalsearchcustomizationconfig *GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig) *ProjectsLocationsCatalogsUpdateConversationalSearchCustomizationConfigCall

UpdateConversationalSearchCustomizationConfig: Updates the conversationalsearch customization config for a given catalog.

  • catalog: Resource name of the catalog. Format:projects/{project}/locations/{location}/catalogs/{catalog}.

func (*ProjectsLocationsCatalogsService)UpdateGenerativeQuestionadded inv0.199.0

func (r *ProjectsLocationsCatalogsService) UpdateGenerativeQuestion(catalogstring, googlecloudretailv2alphagenerativequestionconfig *GoogleCloudRetailV2alphaGenerativeQuestionConfig) *ProjectsLocationsCatalogsUpdateGenerativeQuestionCall

UpdateGenerativeQuestion: Allows management of individual questions.

  • catalog: Resource name of the catalog. Format:projects/{project}/locations/{location}/catalogs/{catalog}.

func (*ProjectsLocationsCatalogsService)UpdateGenerativeQuestionFeatureadded inv0.199.0

func (r *ProjectsLocationsCatalogsService) UpdateGenerativeQuestionFeature(catalogstring, googlecloudretailv2alphagenerativequestionsfeatureconfig *GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig) *ProjectsLocationsCatalogsUpdateGenerativeQuestionFeatureCall

UpdateGenerativeQuestionFeature: Manages overal generative question featurestate -- enables toggling feature on and off.

  • catalog: Resource name of the affected catalog. Format:projects/{project}/locations/{location}/catalogs/{catalog}.

typeProjectsLocationsCatalogsServingConfigsAddControlCalladded inv0.66.0

type ProjectsLocationsCatalogsServingConfigsAddControlCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsServingConfigsAddControlCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsServingConfigsAddControlCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.servingConfigs.addControl" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaServingConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsServingConfigsAddControlCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsServingConfigsAddControlCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsServingConfigsConversationalSearchCalladded inv0.227.0

type ProjectsLocationsCatalogsServingConfigsConversationalSearchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsServingConfigsConversationalSearchCall)Contextadded inv0.227.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsServingConfigsConversationalSearchCall)Doadded inv0.227.0

Do executes the "retail.projects.locations.catalogs.servingConfigs.conversationalSearch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaConversationalSearchResponse.ServerResponse.Headeror (if a response was returned at all) in error.(*googleapi.Error).Header.Use googleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsServingConfigsConversationalSearchCall)Fieldsadded inv0.227.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsServingConfigsConversationalSearchCall)Headeradded inv0.227.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsServingConfigsCreateCalladded inv0.66.0

type ProjectsLocationsCatalogsServingConfigsCreateCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsServingConfigsCreateCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsServingConfigsCreateCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.servingConfigs.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaServingConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsServingConfigsCreateCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsServingConfigsCreateCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsServingConfigsCreateCall)ServingConfigIdadded inv0.66.0

ServingConfigId sets the optional parameter "servingConfigId": Required. TheID to use for the ServingConfig, which will become the final component ofthe ServingConfig's resource name. This value should be 4-63 characters, andvalid characters are /a-z-_/.

typeProjectsLocationsCatalogsServingConfigsDeleteCalladded inv0.66.0

type ProjectsLocationsCatalogsServingConfigsDeleteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsServingConfigsDeleteCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsServingConfigsDeleteCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.servingConfigs.delete" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsCatalogsServingConfigsDeleteCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsServingConfigsDeleteCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsServingConfigsGetCalladded inv0.66.0

type ProjectsLocationsCatalogsServingConfigsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsServingConfigsGetCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsServingConfigsGetCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.servingConfigs.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaServingConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsServingConfigsGetCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsServingConfigsGetCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsServingConfigsGetCall)IfNoneMatchadded inv0.66.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsCatalogsServingConfigsListCalladded inv0.66.0

type ProjectsLocationsCatalogsServingConfigsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsServingConfigsListCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsServingConfigsListCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.servingConfigs.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaListServingConfigsResponse.ServerResponse.Header or(if a response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsServingConfigsListCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsServingConfigsListCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsServingConfigsListCall)IfNoneMatchadded inv0.66.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsCatalogsServingConfigsListCall)PageSizeadded inv0.66.0

PageSize sets the optional parameter "pageSize": Maximum number of resultsto return. If unspecified, defaults to 100. If a value greater than 100 isprovided, at most 100 results are returned.

func (*ProjectsLocationsCatalogsServingConfigsListCall)PageTokenadded inv0.66.0

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListServingConfigs` call. Provide this to retrieve thesubsequent page.

func (*ProjectsLocationsCatalogsServingConfigsListCall)Pagesadded inv0.66.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsCatalogsServingConfigsPatchCalladded inv0.66.0

type ProjectsLocationsCatalogsServingConfigsPatchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsServingConfigsPatchCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsServingConfigsPatchCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.servingConfigs.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaServingConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsServingConfigsPatchCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsServingConfigsPatchCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsServingConfigsPatchCall)UpdateMaskadded inv0.66.0

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided ServingConfig to update. The following are NOT supported: *ServingConfig.name If not set, all supported fields are updated.

typeProjectsLocationsCatalogsServingConfigsPredictCalladded inv0.74.0

type ProjectsLocationsCatalogsServingConfigsPredictCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsServingConfigsPredictCall)Contextadded inv0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsServingConfigsPredictCall)Doadded inv0.74.0

Do executes the "retail.projects.locations.catalogs.servingConfigs.predict" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaPredictResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsServingConfigsPredictCall)Fieldsadded inv0.74.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsServingConfigsPredictCall)Headeradded inv0.74.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsServingConfigsRemoveControlCalladded inv0.66.0

type ProjectsLocationsCatalogsServingConfigsRemoveControlCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsServingConfigsRemoveControlCall)Contextadded inv0.66.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsServingConfigsRemoveControlCall)Doadded inv0.66.0

Do executes the "retail.projects.locations.catalogs.servingConfigs.removeControl" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaServingConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsServingConfigsRemoveControlCall)Fieldsadded inv0.66.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsServingConfigsRemoveControlCall)Headeradded inv0.66.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsServingConfigsSearchCalladded inv0.74.0

type ProjectsLocationsCatalogsServingConfigsSearchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsServingConfigsSearchCall)Contextadded inv0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsServingConfigsSearchCall)Doadded inv0.74.0

Do executes the "retail.projects.locations.catalogs.servingConfigs.search" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaSearchResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsServingConfigsSearchCall)Fieldsadded inv0.74.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsServingConfigsSearchCall)Headeradded inv0.74.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsServingConfigsSearchCall)Pagesadded inv0.74.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeProjectsLocationsCatalogsServingConfigsServiceadded inv0.66.0

type ProjectsLocationsCatalogsServingConfigsService struct {// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsServingConfigsServiceadded inv0.66.0

func NewProjectsLocationsCatalogsServingConfigsService(s *Service) *ProjectsLocationsCatalogsServingConfigsService

func (*ProjectsLocationsCatalogsServingConfigsService)AddControladded inv0.66.0

AddControl: Enables a Control on the specified ServingConfig. The control isadded in the last position of the list of controls it belongs to (e.g. ifit's a facet spec control it will be applied in the last position ofservingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the controlhas already been applied. Returns a FAILED_PRECONDITION error if theaddition could exceed maximum number of control allowed for that type ofcontrol.

  • servingConfig: The source ServingConfig resource name . Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`.

func (*ProjectsLocationsCatalogsServingConfigsService)ConversationalSearchadded inv0.227.0

ConversationalSearch: Performs a conversational search. This feature is onlyavailable for users who have Conversational Search enabled.

  • placement: The resource name of the search engine placement, such as`projects/*/locations/global/catalogs/default_catalog/placements/default_search` or`projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config nameand the set of models that will be used to make the search.

func (*ProjectsLocationsCatalogsServingConfigsService)Createadded inv0.66.0

Create: Creates a ServingConfig. A maximum of 100 ServingConfigs are allowedin a Catalog, otherwise a FAILED_PRECONDITION error is returned.

  • parent: Full resource name of parent. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`.

func (*ProjectsLocationsCatalogsServingConfigsService)Deleteadded inv0.66.0

Delete: Deletes a ServingConfig. Returns a NotFound error if theServingConfig does not exist.

  • name: The resource name of the ServingConfig to delete. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`.

func (*ProjectsLocationsCatalogsServingConfigsService)Getadded inv0.66.0

Get: Gets a ServingConfig. Returns a NotFound error if the ServingConfigdoes not exist.

  • name: The resource name of the ServingConfig to get. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`.

func (*ProjectsLocationsCatalogsServingConfigsService)Listadded inv0.66.0

List: Lists all ServingConfigs linked to this catalog.

  • parent: The catalog resource name. Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`.

func (*ProjectsLocationsCatalogsServingConfigsService)Patchadded inv0.66.0

Patch: Updates a ServingConfig.

  • name: Immutable. Fully qualified name`projects/*/locations/global/catalogs/*/servingConfig/*`.

func (*ProjectsLocationsCatalogsServingConfigsService)Predictadded inv0.74.0

Predict: Makes a recommendation prediction.

  • placement: Full resource name of the format:`{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or`{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is alegacy resource. The ID of the Recommendations AI serving config orplacement. Before you can request predictions from your model, you mustcreate at least one serving config or placement for it. For moreinformation, see [Manage serving configs](https://cloud.google.com/retail/docs/manage-configs). The full list ofavailable serving configs can be seen athttps://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs.

func (*ProjectsLocationsCatalogsServingConfigsService)RemoveControladded inv0.66.0

RemoveControl: Disables a Control on the specified ServingConfig. Thecontrol is removed from the ServingConfig. Returns a NOT_FOUND error if theControl is not enabled for the ServingConfig.

  • servingConfig: The source ServingConfig resource name . Format:`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`.

func (*ProjectsLocationsCatalogsServingConfigsService)Searchadded inv0.74.0

Search: Performs a search. This feature is only available for users who haveRetail Search enabled. Enable Retail Search on Cloud Console before usingthis feature.

  • placement: The resource name of the Retail Search serving config, such as`projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as`projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving config name and the setof models that are used to make the search.

typeProjectsLocationsCatalogsSetDefaultBranchCalladded inv0.52.0

type ProjectsLocationsCatalogsSetDefaultBranchCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsSetDefaultBranchCall)Contextadded inv0.52.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsSetDefaultBranchCall)Doadded inv0.52.0

Do executes the "retail.projects.locations.catalogs.setDefaultBranch" call.Any non-2xx status code is an error. Response headers are in either*GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsCatalogsSetDefaultBranchCall)Fieldsadded inv0.52.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsSetDefaultBranchCall)Headeradded inv0.52.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsUpdateAttributesConfigCalladded inv0.71.0

type ProjectsLocationsCatalogsUpdateAttributesConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUpdateAttributesConfigCall)Contextadded inv0.71.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUpdateAttributesConfigCall)Doadded inv0.71.0

Do executes the "retail.projects.locations.catalogs.updateAttributesConfig" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaAttributesConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsUpdateAttributesConfigCall)Fieldsadded inv0.71.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUpdateAttributesConfigCall)Headeradded inv0.71.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsUpdateAttributesConfigCall)UpdateMaskadded inv0.71.0

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided AttributesConfig to update. The following is the onlysupported field: * AttributesConfig.catalog_attributes If not set, allsupported fields are updated.

typeProjectsLocationsCatalogsUpdateCompletionConfigCalladded inv0.74.0

type ProjectsLocationsCatalogsUpdateCompletionConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUpdateCompletionConfigCall)Contextadded inv0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUpdateCompletionConfigCall)Doadded inv0.74.0

Do executes the "retail.projects.locations.catalogs.updateCompletionConfig" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaCompletionConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsUpdateCompletionConfigCall)Fieldsadded inv0.74.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUpdateCompletionConfigCall)Headeradded inv0.74.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsUpdateCompletionConfigCall)UpdateMaskadded inv0.74.0

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided CompletionConfig to update. The following are the onlysupported fields: * CompletionConfig.matching_order *CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length *CompletionConfig.auto_learning If not set, all supported fields are updated.

typeProjectsLocationsCatalogsUpdateConversationalSearchCustomizationConfigCalladded inv0.239.0

type ProjectsLocationsCatalogsUpdateConversationalSearchCustomizationConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUpdateConversationalSearchCustomizationConfigCall)Contextadded inv0.239.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUpdateConversationalSearchCustomizationConfigCall)Doadded inv0.239.0

Do executes the "retail.projects.locations.catalogs.updateConversationalSearchCustomizationConfig" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsUpdateConversationalSearchCustomizationConfigCall)Fieldsadded inv0.239.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUpdateConversationalSearchCustomizationConfigCall)Headeradded inv0.239.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsUpdateConversationalSearchCustomizationConfigCall)UpdateMaskadded inv0.239.0

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided ConversationalSearchCustomizationConfig to update. If notset or empty, all supported fields are updated.

typeProjectsLocationsCatalogsUpdateGenerativeQuestionCalladded inv0.199.0

type ProjectsLocationsCatalogsUpdateGenerativeQuestionCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUpdateGenerativeQuestionCall)Contextadded inv0.199.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUpdateGenerativeQuestionCall)Doadded inv0.199.0

Do executes the "retail.projects.locations.catalogs.updateGenerativeQuestion" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaGenerativeQuestionConfig.ServerResponse.Header or(if a response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsUpdateGenerativeQuestionCall)Fieldsadded inv0.199.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUpdateGenerativeQuestionCall)Headeradded inv0.199.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsUpdateGenerativeQuestionCall)UpdateMaskadded inv0.199.0

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided GenerativeQuestionConfig to update. The following are NOTsupported: * GenerativeQuestionConfig.frequency If not set or empty, allsupported fields are updated.

typeProjectsLocationsCatalogsUpdateGenerativeQuestionFeatureCalladded inv0.199.0

type ProjectsLocationsCatalogsUpdateGenerativeQuestionFeatureCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUpdateGenerativeQuestionFeatureCall)Contextadded inv0.199.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUpdateGenerativeQuestionFeatureCall)Doadded inv0.199.0

Do executes the "retail.projects.locations.catalogs.updateGenerativeQuestionFeature" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsUpdateGenerativeQuestionFeatureCall)Fieldsadded inv0.199.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUpdateGenerativeQuestionFeatureCall)Headeradded inv0.199.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsUpdateGenerativeQuestionFeatureCall)UpdateMaskadded inv0.199.0

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided GenerativeQuestionsFeatureConfig to update. If not set orempty, all supported fields are updated.

typeProjectsLocationsCatalogsUserEventsCollectCall

type ProjectsLocationsCatalogsUserEventsCollectCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUserEventsCollectCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUserEventsCollectCall)Do

Do executes the "retail.projects.locations.catalogs.userEvents.collect" call.Any non-2xx status code is an error. Response headers are in either*GoogleApiHttpBody.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsCatalogsUserEventsCollectCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUserEventsCollectCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsUserEventsExportCalladded inv0.190.0

type ProjectsLocationsCatalogsUserEventsExportCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUserEventsExportCall)Contextadded inv0.190.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUserEventsExportCall)Doadded inv0.190.0

Do executes the "retail.projects.locations.catalogs.userEvents.export" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsUserEventsExportCall)Fieldsadded inv0.190.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUserEventsExportCall)Headeradded inv0.190.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsUserEventsImportCall

type ProjectsLocationsCatalogsUserEventsImportCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUserEventsImportCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUserEventsImportCall)Do

Do executes the "retail.projects.locations.catalogs.userEvents.import" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsUserEventsImportCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUserEventsImportCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsUserEventsPurgeCall

type ProjectsLocationsCatalogsUserEventsPurgeCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUserEventsPurgeCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUserEventsPurgeCall)Do

Do executes the "retail.projects.locations.catalogs.userEvents.purge" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsUserEventsPurgeCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUserEventsPurgeCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsUserEventsRejoinCall

type ProjectsLocationsCatalogsUserEventsRejoinCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUserEventsRejoinCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUserEventsRejoinCall)Do

Do executes the "retail.projects.locations.catalogs.userEvents.rejoin" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsUserEventsRejoinCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUserEventsRejoinCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsLocationsCatalogsUserEventsService

type ProjectsLocationsCatalogsUserEventsService struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUserEventsService)Collect

Collect: Writes a single user event from the browser. For larger user eventpayload over 16 KB, the POST method should be used instead, otherwise a 400Bad Request error is returned. This method is used only by the Retail APIJavaScript pixel and Google Tag Manager. Users should not call this methoddirectly.

  • parent: The parent catalog name, such as`projects/1234/locations/global/catalogs/default_catalog`.

func (*ProjectsLocationsCatalogsUserEventsService)Exportadded inv0.190.0

Export: Exports user events. `Operation.response` is of type`ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.

  • parent: Resource name of a Catalog. For example`projects/1234/locations/global/catalogs/default_catalog`.

func (*ProjectsLocationsCatalogsUserEventsService)Import

Import: Bulk import of User events. Request processing might be synchronous.Events that already exist are skipped. Use this method for backfillinghistorical user events. `Operation.response` is of type `ImportResponse`.Note that it is possible for a subset of the items to be successfullyinserted. `Operation.metadata` is of type `ImportMetadata`.

- parent: `projects/1234/locations/global/catalogs/default_catalog`.

func (*ProjectsLocationsCatalogsUserEventsService)Purge

Purge: Deletes permanently all user events specified by the filter provided.Depending on the number of events specified by the filter, this operationcould take hours or days to complete. To test a filter, use the list commandfirst.

  • parent: The resource name of the catalog under which the events arecreated. The format is`projects/${projectId}/locations/global/catalogs/${catalogId}`.

func (*ProjectsLocationsCatalogsUserEventsService)Rejoin

Rejoin: Starts a user-event rejoin operation with latest product catalog.Events are not annotated with detailed product information for products thatare missing from the catalog when the user event is ingested. These eventsare stored as unjoined events with limited usage on training and serving.You can use this method to start a join operation on specified events withthe latest version of product catalog. You can also use this method tocorrect events joined with the wrong product catalog. A rejoin operation cantake hours or days to complete.

  • parent: The parent catalog resource name, such as`projects/1234/locations/global/catalogs/default_catalog`.

func (*ProjectsLocationsCatalogsUserEventsService)Write

Write: Writes a single user event.

  • parent: The parent catalog resource name, such as`projects/1234/locations/global/catalogs/default_catalog`.

typeProjectsLocationsCatalogsUserEventsWriteCall

type ProjectsLocationsCatalogsUserEventsWriteCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsCatalogsUserEventsWriteCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsCatalogsUserEventsWriteCall)Do

Do executes the "retail.projects.locations.catalogs.userEvents.write" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaUserEvent.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsCatalogsUserEventsWriteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsCatalogsUserEventsWriteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsCatalogsUserEventsWriteCall)WriteAsyncadded inv0.106.0

WriteAsync sets the optional parameter "writeAsync": If set to true, theuser event will be written asynchronously after validation, and the API willrespond without waiting for the write. Therefore, silent failures can occureven if the API returns success. In case of silent failures, error messagescan be found in Stackdriver logs.

typeProjectsLocationsOperationsGetCall

type ProjectsLocationsOperationsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsOperationsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsGetCall)Do

Do executes the "retail.projects.locations.operations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsOperationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsOperationsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsLocationsOperationsListCall

type ProjectsLocationsOperationsListCall struct {// contains filtered or unexported fields}

func (*ProjectsLocationsOperationsListCall)Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsOperationsListCall)Do

Do executes the "retail.projects.locations.operations.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsOperationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsOperationsListCall)Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsOperationsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsOperationsListCall)PageSize

PageSize sets the optional parameter "pageSize": The standard list pagesize.

func (*ProjectsLocationsOperationsListCall)PageToken

PageToken sets the optional parameter "pageToken": The standard list pagetoken.

func (*ProjectsLocationsOperationsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsOperationsListCall)ReturnPartialSuccessadded inv0.253.0

func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *ProjectsLocationsOperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in theListOperationsResponse.unreachable field. This can only be `true` whenreading across collections. For example, when `parent` is set to"projects/example/locations/-". This field is not supported by default andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeProjectsLocationsOperationsService

type ProjectsLocationsOperationsService struct {// contains filtered or unexported fields}

func (*ProjectsLocationsOperationsService)Get

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService)List

List: Lists operations that match the specified filter in the request. Ifthe server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

typeProjectsLocationsService

type ProjectsLocationsService struct {Catalogs *ProjectsLocationsCatalogsServiceOperations *ProjectsLocationsOperationsService// contains filtered or unexported fields}

funcNewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

typeProjectsOperationsGetCalladded inv0.69.0

type ProjectsOperationsGetCall struct {// contains filtered or unexported fields}

func (*ProjectsOperationsGetCall)Contextadded inv0.69.0

Context sets the context to be used in this call's Do method.

func (*ProjectsOperationsGetCall)Doadded inv0.69.0

Do executes the "retail.projects.operations.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsOperationsGetCall)Fieldsadded inv0.69.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsOperationsGetCall)Headeradded inv0.69.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsOperationsGetCall)IfNoneMatchadded inv0.69.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeProjectsOperationsListCalladded inv0.69.0

type ProjectsOperationsListCall struct {// contains filtered or unexported fields}

func (*ProjectsOperationsListCall)Contextadded inv0.69.0

Context sets the context to be used in this call's Do method.

func (*ProjectsOperationsListCall)Doadded inv0.69.0

Do executes the "retail.projects.operations.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningListOperationsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsOperationsListCall)Fieldsadded inv0.69.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsOperationsListCall)Filteradded inv0.69.0

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsOperationsListCall)Headeradded inv0.69.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsOperationsListCall)IfNoneMatchadded inv0.69.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsOperationsListCall)PageSizeadded inv0.69.0

PageSize sets the optional parameter "pageSize": The standard list pagesize.

func (*ProjectsOperationsListCall)PageTokenadded inv0.69.0

PageToken sets the optional parameter "pageToken": The standard list pagetoken.

func (*ProjectsOperationsListCall)Pagesadded inv0.69.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*ProjectsOperationsListCall)ReturnPartialSuccessadded inv0.253.0

func (c *ProjectsOperationsListCall) ReturnPartialSuccess(returnPartialSuccessbool) *ProjectsOperationsListCall

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in theListOperationsResponse.unreachable field. This can only be `true` whenreading across collections. For example, when `parent` is set to"projects/example/locations/-". This field is not supported by default andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeProjectsOperationsServiceadded inv0.69.0

type ProjectsOperationsService struct {// contains filtered or unexported fields}

funcNewProjectsOperationsServiceadded inv0.69.0

func NewProjectsOperationsService(s *Service) *ProjectsOperationsService

func (*ProjectsOperationsService)Getadded inv0.69.0

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

func (*ProjectsOperationsService)Listadded inv0.69.0

List: Lists operations that match the specified filter in the request. Ifthe server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

typeProjectsRetailProjectAcceptTermsCalladded inv0.131.0

type ProjectsRetailProjectAcceptTermsCall struct {// contains filtered or unexported fields}

func (*ProjectsRetailProjectAcceptTermsCall)Contextadded inv0.131.0

Context sets the context to be used in this call's Do method.

func (*ProjectsRetailProjectAcceptTermsCall)Doadded inv0.131.0

Do executes the "retail.projects.retailProject.acceptTerms" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaProject.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsRetailProjectAcceptTermsCall)Fieldsadded inv0.131.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsRetailProjectAcceptTermsCall)Headeradded inv0.131.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeProjectsRetailProjectServiceadded inv0.131.0

type ProjectsRetailProjectService struct {// contains filtered or unexported fields}

funcNewProjectsRetailProjectServiceadded inv0.131.0

func NewProjectsRetailProjectService(s *Service) *ProjectsRetailProjectService

func (*ProjectsRetailProjectService)AcceptTermsadded inv0.131.0

func (r *ProjectsRetailProjectService) AcceptTerms(projectstring, googlecloudretailv2alphaaccepttermsrequest *GoogleCloudRetailV2alphaAcceptTermsRequest) *ProjectsRetailProjectAcceptTermsCall

AcceptTerms: Accepts service terms for this project. By making requests tothis API, you agree to the terms of service linked below.https://cloud.google.com/retail/data-use-terms

  • project: Full resource name of the project. Format:`projects/{project_number_or_id}/retailProject`.

typeProjectsService

type ProjectsService struct {Locations *ProjectsLocationsServiceOperations *ProjectsOperationsServiceRetailProject *ProjectsRetailProjectService// contains filtered or unexported fields}

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService)EnrollSolutionadded inv0.131.0

func (r *ProjectsService) EnrollSolution(projectstring, googlecloudretailv2alphaenrollsolutionrequest *GoogleCloudRetailV2alphaEnrollSolutionRequest) *ProjectsEnrollSolutionCall

EnrollSolution: The method enrolls a solution of type Retail Search into aproject. The Recommendations AI solution type is enrolled by default whenyour project enables Retail API, so you don't need to call theenrollSolution method for recommendations.

  • project: Full resource name of parent. Format:`projects/{project_number_or_id}`.

func (*ProjectsService)GetAlertConfigadded inv0.169.0

func (r *ProjectsService) GetAlertConfig(namestring) *ProjectsGetAlertConfigCall

GetAlertConfig: Get the AlertConfig of the requested project.

  • name: Full AlertConfig resource name. Format:projects/{project_number}/alertConfig.

func (*ProjectsService)GetLoggingConfigadded inv0.147.0

func (r *ProjectsService) GetLoggingConfig(namestring) *ProjectsGetLoggingConfigCall

GetLoggingConfig: Gets the LoggingConfig of the requested project.

  • name: Full LoggingConfig resource name. Format:projects/{project_number}/loggingConfig.

func (*ProjectsService)GetRetailProjectadded inv0.131.0

func (r *ProjectsService) GetRetailProject(namestring) *ProjectsGetRetailProjectCall

GetRetailProject: Gets the project. Throws `NOT_FOUND` if the project wasn'tinitialized for the Retail API service.

  • name: Full resource name of the project. Format:`projects/{project_number_or_id}/retailProject`.

func (*ProjectsService)ListEnrolledSolutionsadded inv0.131.0

func (r *ProjectsService) ListEnrolledSolutions(parentstring) *ProjectsListEnrolledSolutionsCall

ListEnrolledSolutions: Lists all the retail API solutions the project hasenrolled.

  • parent: Full resource name of parent. Format:`projects/{project_number_or_id}`.

func (*ProjectsService)UpdateAlertConfigadded inv0.169.0

func (r *ProjectsService) UpdateAlertConfig(namestring, googlecloudretailv2alphaalertconfig *GoogleCloudRetailV2alphaAlertConfig) *ProjectsUpdateAlertConfigCall

UpdateAlertConfig: Update the alert config of the requested project.

  • name: Immutable. The name of the AlertConfig singleton resource. Format:projects/*/alertConfig.

func (*ProjectsService)UpdateLoggingConfigadded inv0.147.0

func (r *ProjectsService) UpdateLoggingConfig(namestring, googlecloudretailv2alphaloggingconfig *GoogleCloudRetailV2alphaLoggingConfig) *ProjectsUpdateLoggingConfigCall

UpdateLoggingConfig: Updates the LoggingConfig of the requested project.

  • name: Immutable. The name of the LoggingConfig singleton resource. Format:projects/*/loggingConfig.

typeProjectsUpdateAlertConfigCalladded inv0.169.0

type ProjectsUpdateAlertConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsUpdateAlertConfigCall)Contextadded inv0.169.0

Context sets the context to be used in this call's Do method.

func (*ProjectsUpdateAlertConfigCall)Doadded inv0.169.0

Do executes the "retail.projects.updateAlertConfig" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaAlertConfig.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsUpdateAlertConfigCall)Fieldsadded inv0.169.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsUpdateAlertConfigCall)Headeradded inv0.169.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsUpdateAlertConfigCall)UpdateMaskadded inv0.169.0

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided AlertConfig to update. If not set, all supported fields areupdated.

typeProjectsUpdateLoggingConfigCalladded inv0.147.0

type ProjectsUpdateLoggingConfigCall struct {// contains filtered or unexported fields}

func (*ProjectsUpdateLoggingConfigCall)Contextadded inv0.147.0

Context sets the context to be used in this call's Do method.

func (*ProjectsUpdateLoggingConfigCall)Doadded inv0.147.0

Do executes the "retail.projects.updateLoggingConfig" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRetailV2alphaLoggingConfig.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsUpdateLoggingConfigCall)Fieldsadded inv0.147.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsUpdateLoggingConfigCall)Headeradded inv0.147.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsUpdateLoggingConfigCall)UpdateMaskadded inv0.147.0

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided LoggingConfig to update. The following are the onlysupported fields: * LoggingConfig.default_log_generation_rule *LoggingConfig.service_log_generation_rules If not set, all supported fieldsare updated.

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewService

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp