Movatterモバイル変換


[0]ホーム

URL:


recommendationengine

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 recommendationengine provides access to the Recommendations AI (Beta).

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

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/recommendationengine/v1beta1"...ctx := context.Background()recommendationengineService, err := recommendationengine.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:

recommendationengineService, err := recommendationengine.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, ...)recommendationengineService, err := recommendationengine.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)

typeGoogleCloudRecommendationengineV1alphaRejoinCatalogMetadata

type GoogleCloudRecommendationengineV1alphaRejoinCatalogMetadata struct {}

GoogleCloudRecommendationengineV1alphaRejoinCatalogMetadata: Metadata forTriggerCatalogRejoin method.

typeGoogleCloudRecommendationengineV1alphaRejoinCatalogResponse

type GoogleCloudRecommendationengineV1alphaRejoinCatalogResponse struct {// RejoinedUserEventsCount: Number of user events that were joined with latest// catalog items.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:"-"`}

GoogleCloudRecommendationengineV1alphaRejoinCatalogResponse: Responsemessage for TriggerCatalogRejoin method.

func (GoogleCloudRecommendationengineV1alphaRejoinCatalogResponse)MarshalJSON

typeGoogleCloudRecommendationengineV1alphaTuningMetadata

type GoogleCloudRecommendationengineV1alphaTuningMetadata struct {// RecommendationModel: The resource name of the recommendation model that this// tune applies to. Format:// projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/event// Stores/{event_store_id}/recommendationModels/{recommendation_model_id}RecommendationModelstring `json:"recommendationModel,omitempty"`// ForceSendFields is a list of field names (e.g. "RecommendationModel") 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. "RecommendationModel") 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:"-"`}

GoogleCloudRecommendationengineV1alphaTuningMetadata: Metadata associatedwith a tune operation.

func (GoogleCloudRecommendationengineV1alphaTuningMetadata)MarshalJSON

typeGoogleCloudRecommendationengineV1alphaTuningResponse

type GoogleCloudRecommendationengineV1alphaTuningResponse struct {}

GoogleCloudRecommendationengineV1alphaTuningResponse: Response associatedwith a tune operation.

typeGoogleCloudRecommendationengineV1beta1BigQuerySource

type GoogleCloudRecommendationengineV1beta1BigQuerySource struct {// DataSchema: Optional. The schema to use when parsing the data from the// source. Supported values for catalog imports: 1:// "catalog_recommendations_ai" using//https://cloud.google.com/recommendations-ai/docs/upload-catalog#json// (Default for catalogItems.import) 2: "catalog_merchant_center" using//https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported// values for user event imports: 1: "user_events_recommendations_ai" using//https://cloud.google.com/recommendations-ai/docs/manage-user-events#import// (Default for userEvents.import) 2. "user_events_ga360" using//https://support.google.com/analytics/answer/3437719?hl=enDataSchemastring `json:"dataSchema,omitempty"`// DatasetId: Required. The BigQuery data set to copy the data from.DatasetIdstring `json:"datasetId,omitempty"`// GcsStagingDir: Optional. Intermediate Cloud Storage directory used for the// import. Can be specified if one wants to have the BigQuery export to a// specific Cloud Storage directory.GcsStagingDirstring `json:"gcsStagingDir,omitempty"`// ProjectId: Optional. The project id (can be project # or id) that the// BigQuery source is in. 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.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:"-"`}

GoogleCloudRecommendationengineV1beta1BigQuerySource: BigQuery source importdata from.

func (GoogleCloudRecommendationengineV1beta1BigQuerySource)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1Catalog

type GoogleCloudRecommendationengineV1beta1Catalog struct {// CatalogItemLevelConfig: Required. The catalog item level configuration.CatalogItemLevelConfig *GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig `json:"catalogItemLevelConfig,omitempty"`// DefaultEventStoreId: Required. The ID of the default event store.DefaultEventStoreIdstring `json:"defaultEventStoreId,omitempty"`// DisplayName: Required. The catalog display name.DisplayNamestring `json:"displayName,omitempty"`// Name: The fully qualified resource name of the catalog.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. "CatalogItemLevelConfig") 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. "CatalogItemLevelConfig") 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:"-"`}

GoogleCloudRecommendationengineV1beta1Catalog: The catalog configuration.Next ID: 5.

func (GoogleCloudRecommendationengineV1beta1Catalog)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1CatalogInlineSource

type GoogleCloudRecommendationengineV1beta1CatalogInlineSource struct {// CatalogItems: Optional. A list of catalog items to update/create.// Recommended max of 10k items.CatalogItems []*GoogleCloudRecommendationengineV1beta1CatalogItem `json:"catalogItems,omitempty"`// ForceSendFields is a list of field names (e.g. "CatalogItems") 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. "CatalogItems") 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:"-"`}

GoogleCloudRecommendationengineV1beta1CatalogInlineSource: The inline sourcefor the input config for ImportCatalogItems method.

func (GoogleCloudRecommendationengineV1beta1CatalogInlineSource)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1CatalogItem

type GoogleCloudRecommendationengineV1beta1CatalogItem struct {// CategoryHierarchies: Required. Catalog item categories. This field is// repeated for supporting one catalog item belonging to several parallel// category hierarchies. For example, if a shoes product belongs to both// ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic// Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [// { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports// & Fitness", "Athletic Clothing", "Shoes"] } ]CategoryHierarchies []*GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy `json:"categoryHierarchies,omitempty"`// Description: Optional. Catalog item description. UTF-8 encoded string with a// length limit of 5 KiB.Descriptionstring `json:"description,omitempty"`// Id: Required. Catalog item identifier. UTF-8 encoded string with a length// limit of 128 bytes. This id must be unique among all catalog items within// the same catalog. It should also be used when logging user events in order// for the user events to be joined with the Catalog.Idstring `json:"id,omitempty"`// ItemAttributes: Optional. Highly encouraged. Extra catalog item attributes// to be included in the recommendation model. For example, for retail// 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 item attributes here.ItemAttributes *GoogleCloudRecommendationengineV1beta1FeatureMap `json:"itemAttributes,omitempty"`// ItemGroupId: Optional. Variant group identifier for prediction results.// UTF-8 encoded string with a length limit of 128 bytes. This field must be// enabled before it can be used. Learn more// (/recommendations-ai/docs/catalog#item-group-id).ItemGroupIdstring `json:"itemGroupId,omitempty"`// LanguageCode: Optional. Deprecated. The model automatically detects the text// language. Your catalog can include text in different languages, but// duplicating catalog items to provide text in multiple languages can result// in degraded model performance.LanguageCodestring `json:"languageCode,omitempty"`// ProductMetadata: Optional. Metadata specific to retail products.ProductMetadata *GoogleCloudRecommendationengineV1beta1ProductCatalogItem `json:"productMetadata,omitempty"`// Tags: Optional. Filtering tags associated with the catalog item. Each tag// should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can// be used for filtering recommendation results by passing the tag as part of// the predict request filter.Tags []string `json:"tags,omitempty"`// Title: Required. Catalog item title. UTF-8 encoded string with a length// limit of 1 KiB.Titlestring `json:"title,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CategoryHierarchies") 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. "CategoryHierarchies") 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:"-"`}

GoogleCloudRecommendationengineV1beta1CatalogItem: CatalogItem captures allmetadata information of items to be recommended.

func (GoogleCloudRecommendationengineV1beta1CatalogItem)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy

type GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy struct {// Categories: Required. Catalog item categories. Each category should be a// UTF-8 encoded string with a length limit of 2 KiB. Note that the order in// the list denotes the specificity (from least to most specific).Categories []string `json:"categories,omitempty"`// ForceSendFields is a list of field names (e.g. "Categories") 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. "Categories") 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:"-"`}

GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy: Categoryrepresents catalog item category hierarchy.

func (GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig

type GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig struct {// EventItemLevel: Optional. Level of the catalog at which events are uploaded.// Seehttps://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels// for more details.//// Possible values://   "CATALOG_ITEM_LEVEL_UNSPECIFIED" - Unknown value - should never be used.//   "VARIANT" - Catalog items are at variant level.//   "MASTER" - Catalog items are at master level.EventItemLevelstring `json:"eventItemLevel,omitempty"`// PredictItemLevel: Optional. Level of the catalog at which predictions are// made. See//https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for// more details.//// Possible values://   "CATALOG_ITEM_LEVEL_UNSPECIFIED" - Unknown value - should never be used.//   "VARIANT" - Catalog items are at variant level.//   "MASTER" - Catalog items are at master level.PredictItemLevelstring `json:"predictItemLevel,omitempty"`// ForceSendFields is a list of field names (e.g. "EventItemLevel") 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. "EventItemLevel") 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:"-"`}

GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig: Configures thecatalog level that users send events to, and the level at which predictionsare made.

func (GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest

type GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest struct {// PredictionApiKeyRegistration: Required. The prediction API key registration.PredictionApiKeyRegistration *GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration `json:"predictionApiKeyRegistration,omitempty"`// ForceSendFields is a list of field names (e.g.// "PredictionApiKeyRegistration") 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. "PredictionApiKeyRegistration") 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:"-"`}

GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest: Request message for the `CreatePredictionApiKeyRegistration` method.

func (GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1EventDetail

type GoogleCloudRecommendationengineV1beta1EventDetail struct {// EventAttributes: Optional. Extra user event features to include in the// recommendation model. For product recommendation, an example of extra user// information is traffic_channel, i.e. how user arrives at the site. Users can// arrive at the site by coming to the site directly, or coming through Google// search, and etc.EventAttributes *GoogleCloudRecommendationengineV1beta1FeatureMap `json:"eventAttributes,omitempty"`// ExperimentIds: Optional. 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// Recommendation Engine system, using different recommendation models).ExperimentIds []string `json:"experimentIds,omitempty"`// PageViewId: Optional. 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. This// `pageViewId` will be automatically generated if using the JavaScript pixel.PageViewIdstring `json:"pageViewId,omitempty"`// RecommendationToken: Optional. Recommendation token included in the// recommendation prediction response. This field enables accurate attribution// of recommendation model performance. This token enables us to accurately// attribute page view or purchase back to the event and the particular predict// response containing this clicked/purchased item. If user clicks on product K// in the recommendation results, pass the// `PredictResponse.recommendationToken` property as a url parameter to product// K's page. When recording events on product K's page, log the// PredictResponse.recommendation_token to this field. Optional, but highly// encouraged for user events that are the result of a recommendation// prediction query.RecommendationTokenstring `json:"recommendationToken,omitempty"`// ReferrerUri: Optional. The referrer url of the current page. When using the// JavaScript pixel, this value is filled in automatically.ReferrerUristring `json:"referrerUri,omitempty"`// Uri: Optional. Complete url (window.location.href) of the user's current// page. When using the JavaScript pixel, this value is filled in// automatically. Maximum length 5KB.Uristring `json:"uri,omitempty"`// ForceSendFields is a list of field names (e.g. "EventAttributes") 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. "EventAttributes") 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:"-"`}

GoogleCloudRecommendationengineV1beta1EventDetail: User event details sharedby all recommendation types.

func (GoogleCloudRecommendationengineV1beta1EventDetail)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1FeatureMap

type GoogleCloudRecommendationengineV1beta1FeatureMap struct {// CategoricalFeatures: Categorical features that can take on one of a limited// number of possible values. Some examples would be the brand/maker of a// product, or country of a customer. Feature names and values must be UTF-8// encoded strings. For example: `{ "colors": {"value": ["yellow", "green"]},// "sizes": {"value":["S", "M"]}`CategoricalFeatures map[string]GoogleCloudRecommendationengineV1beta1FeatureMapStringList `json:"categoricalFeatures,omitempty"`// NumericalFeatures: Numerical features. Some examples would be the// height/weight of a product, or age of a customer. Feature names must be// UTF-8 encoded strings. For example: `{ "lengths_cm": {"value":[2.3, 15.4]},// "heights_cm": {"value":[8.1, 6.4]} }`NumericalFeatures map[string]GoogleCloudRecommendationengineV1beta1FeatureMapFloatList `json:"numericalFeatures,omitempty"`// ForceSendFields is a list of field names (e.g. "CategoricalFeatures") 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. "CategoricalFeatures") 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:"-"`}

GoogleCloudRecommendationengineV1beta1FeatureMap: FeatureMap representsextra features that customers want to include in the recommendation modelfor catalogs/user events as categorical/numerical features.

func (GoogleCloudRecommendationengineV1beta1FeatureMap)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1FeatureMapFloatList

type GoogleCloudRecommendationengineV1beta1FeatureMapFloatList struct {// Value: Float feature value.Value []float64 `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Value") 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. "Value") 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:"-"`}

GoogleCloudRecommendationengineV1beta1FeatureMapFloatList: A list of floatfeatures.

func (GoogleCloudRecommendationengineV1beta1FeatureMapFloatList)MarshalJSON

func (*GoogleCloudRecommendationengineV1beta1FeatureMapFloatList)UnmarshalJSONadded inv0.122.0

typeGoogleCloudRecommendationengineV1beta1FeatureMapStringList

type GoogleCloudRecommendationengineV1beta1FeatureMapStringList struct {// Value: String feature value with a length limit of 128 bytes.Value []string `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Value") 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. "Value") 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:"-"`}

GoogleCloudRecommendationengineV1beta1FeatureMapStringList: A list of stringfeatures.

func (GoogleCloudRecommendationengineV1beta1FeatureMapStringList)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1GcsSource

type GoogleCloudRecommendationengineV1beta1GcsSource struct {// 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 catalog// information (/recommendations-ai/docs/upload-catalog) for the expected file// format and setup instructions.InputUris []string `json:"inputUris,omitempty"`// JsonSchema: Optional. The schema to use when parsing the data from the// source. Supported values for catalog imports: 1:// "catalog_recommendations_ai" using//https://cloud.google.com/recommendations-ai/docs/upload-catalog#json// (Default for catalogItems.import) 2: "catalog_merchant_center" using//https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported// values for user events imports: 1: "user_events_recommendations_ai" using//https://cloud.google.com/recommendations-ai/docs/manage-user-events#import// (Default for userEvents.import) 2. "user_events_ga360" using//https://support.google.com/analytics/answer/3437719?hl=enJsonSchemastring `json:"jsonSchema,omitempty"`// ForceSendFields is a list of field names (e.g. "InputUris") 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. "InputUris") 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:"-"`}

GoogleCloudRecommendationengineV1beta1GcsSource: Google Cloud Storagelocation for input content. format.

func (GoogleCloudRecommendationengineV1beta1GcsSource)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1Image

type GoogleCloudRecommendationengineV1beta1Image struct {// Height: Optional. Height of the image in number of pixels.Heightint64 `json:"height,omitempty"`// Uri: Required. URL of the image with a length limit of 5 KiB.Uristring `json:"uri,omitempty"`// Width: Optional. Width of the image in number of pixels.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:"-"`}

GoogleCloudRecommendationengineV1beta1Image: Catalog item thumbnail/detailimage.

func (GoogleCloudRecommendationengineV1beta1Image)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest

type GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest struct {// ErrorsConfig: Optional. The desired location of errors incurred during the// Import.ErrorsConfig *GoogleCloudRecommendationengineV1beta1ImportErrorsConfig `json:"errorsConfig,omitempty"`// InputConfig: Required. The desired input location of the data.InputConfig *GoogleCloudRecommendationengineV1beta1InputConfig `json:"inputConfig,omitempty"`// RequestId: Optional. Unique identifier provided by client, within the// ancestor dataset scope. Ensures idempotency and used for request// deduplication. Server-generated if unspecified. Up to 128 characters long.// This is returned as google.longrunning.Operation.name in the response.RequestIdstring `json:"requestId,omitempty"`// UpdateMask: Optional. Indicates which fields in the provided imported// 'items' to update. If not set, will by default update all fields.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:"-"`}

GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest: Requestmessage for Import methods.

func (GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ImportCatalogItemsResponse

type GoogleCloudRecommendationengineV1beta1ImportCatalogItemsResponse 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 *GoogleCloudRecommendationengineV1beta1ImportErrorsConfig `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:"-"`}

GoogleCloudRecommendationengineV1beta1ImportCatalogItemsResponse: Responseof the ImportCatalogItemsRequest. If the long running operation is done,then this message is returned by the google.longrunning.Operations.responsefield if the operation was successful.

func (GoogleCloudRecommendationengineV1beta1ImportCatalogItemsResponse)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ImportErrorsConfig

type GoogleCloudRecommendationengineV1beta1ImportErrorsConfig struct {// GcsPrefix: Google Cloud Storage path for import errors. This must be an// empty, existing Cloud Storage bucket. Import 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:"-"`}

GoogleCloudRecommendationengineV1beta1ImportErrorsConfig: Configuration ofdestination for Import related errors.

func (GoogleCloudRecommendationengineV1beta1ImportErrorsConfig)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ImportMetadata

type GoogleCloudRecommendationengineV1beta1ImportMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// FailureCount: Count of entries that encountered errors while processing.FailureCountint64 `json:"failureCount,omitempty,string"`// OperationName: Name of the operation.OperationNamestring `json:"operationName,omitempty"`// RequestId: Id of the request / operation. This is parroting back the// requestId that was passed in the request.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:"-"`}

GoogleCloudRecommendationengineV1beta1ImportMetadata: Metadata related tothe progress of the Import operation. This will be returned by thegoogle.longrunning.Operation.metadata field.

func (GoogleCloudRecommendationengineV1beta1ImportMetadata)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ImportUserEventsRequest

type GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest struct {// ErrorsConfig: Optional. The desired location of errors incurred during the// Import.ErrorsConfig *GoogleCloudRecommendationengineV1beta1ImportErrorsConfig `json:"errorsConfig,omitempty"`// InputConfig: Required. The desired input location of the data.InputConfig *GoogleCloudRecommendationengineV1beta1InputConfig `json:"inputConfig,omitempty"`// RequestId: Optional. Unique identifier provided by client, within the// ancestor dataset scope. Ensures idempotency for expensive long running// operations. Server-generated if unspecified. Up to 128 characters long. This// is returned as google.longrunning.Operation.name in the response. Note that// this field must not be set if the desired input config is// catalog_inline_source.RequestIdstring `json:"requestId,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:"-"`}

GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest: Requestmessage for the ImportUserEvents request.

func (GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ImportUserEventsResponse

type GoogleCloudRecommendationengineV1beta1ImportUserEventsResponse 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 *GoogleCloudRecommendationengineV1beta1ImportErrorsConfig `json:"errorsConfig,omitempty"`// ImportSummary: Aggregated statistics of user event import status.ImportSummary *GoogleCloudRecommendationengineV1beta1UserEventImportSummary `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:"-"`}

GoogleCloudRecommendationengineV1beta1ImportUserEventsResponse: Response ofthe ImportUserEventsRequest. If the long running operation was successful,then this message is returned by the google.longrunning.Operations.responsefield if the operation was successful.

func (GoogleCloudRecommendationengineV1beta1ImportUserEventsResponse)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1InputConfig

type GoogleCloudRecommendationengineV1beta1InputConfig struct {// BigQuerySource: BigQuery input source.BigQuerySource *GoogleCloudRecommendationengineV1beta1BigQuerySource `json:"bigQuerySource,omitempty"`// CatalogInlineSource: The Inline source for the input content for Catalog// items.CatalogInlineSource *GoogleCloudRecommendationengineV1beta1CatalogInlineSource `json:"catalogInlineSource,omitempty"`// GcsSource: Google Cloud Storage location for the input content.GcsSource *GoogleCloudRecommendationengineV1beta1GcsSource `json:"gcsSource,omitempty"`// UserEventInlineSource: The Inline source for the input content for// UserEvents.UserEventInlineSource *GoogleCloudRecommendationengineV1beta1UserEventInlineSource `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:"-"`}

GoogleCloudRecommendationengineV1beta1InputConfig: The input config source.

func (GoogleCloudRecommendationengineV1beta1InputConfig)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse

type GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse struct {// CatalogItems: The catalog items.CatalogItems []*GoogleCloudRecommendationengineV1beta1CatalogItem `json:"catalogItems,omitempty"`// NextPageToken: If empty, the list is complete. If nonempty, the token to// pass to the next request's ListCatalogItemRequest.page_token.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. "CatalogItems") 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. "CatalogItems") 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:"-"`}

GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse: Responsemessage for ListCatalogItems method.

func (GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ListCatalogsResponse

type GoogleCloudRecommendationengineV1beta1ListCatalogsResponse struct {// Catalogs: Output only. All the customer's catalogs.Catalogs []*GoogleCloudRecommendationengineV1beta1Catalog `json:"catalogs,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. "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:"-"`}

GoogleCloudRecommendationengineV1beta1ListCatalogsResponse: Response forListCatalogs method.

func (GoogleCloudRecommendationengineV1beta1ListCatalogsResponse)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse

type GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse struct {// NextPageToken: If empty, the list is complete. If nonempty, pass the token// to the next request's `ListPredictionApiKeysRegistrationsRequest.pageToken`.NextPageTokenstring `json:"nextPageToken,omitempty"`// PredictionApiKeyRegistrations: The list of registered API keys.PredictionApiKeyRegistrations []*GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration `json:"predictionApiKeyRegistrations,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:"-"`}

GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse: Response message for the `ListPredictionApiKeyRegistrations`.

func (GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ListUserEventsResponse

type GoogleCloudRecommendationengineV1beta1ListUserEventsResponse struct {// NextPageToken: If empty, the list is complete. If nonempty, the token to// pass to the next request's ListUserEvents.page_token.NextPageTokenstring `json:"nextPageToken,omitempty"`// UserEvents: The user events.UserEvents []*GoogleCloudRecommendationengineV1beta1UserEvent `json:"userEvents,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:"-"`}

GoogleCloudRecommendationengineV1beta1ListUserEventsResponse: Responsemessage for ListUserEvents method.

func (GoogleCloudRecommendationengineV1beta1ListUserEventsResponse)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1PredictRequest

type GoogleCloudRecommendationengineV1beta1PredictRequest struct {// DryRun: Optional. Use dryRun mode for this prediction query. If set to true,// a fake model will be used that returns arbitrary catalog items. Note that// the dryRun mode should only be used for testing the API, or if the model is// not ready.DryRunbool `json:"dryRun,omitempty"`// Filter: Optional. Filter for restricting prediction results. Accepts values// for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts// predictions to items 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 KiB. *// filterOutOfStockItems. Restricts predictions to items 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, nothing will be returned. If you want generic// (unfiltered) popular items to be returned instead, set `strictFiltering` to// false in `PredictRequest.params`.Filterstring `json:"filter,omitempty"`// Labels: Optional. The labels for the predict request. * Label keys can// contain lowercase letters, digits and hyphens, must start with a letter, and// must end with a letter or digit. * Non-zero label values can contain// lowercase letters, digits and hyphens, must start with a letter, and must// end with a letter or digit. * No more than 64 labels can be associated with// a given request. Seehttps://goo.gl/xmQnxf for more information on and// examples of labels.Labels map[string]string `json:"labels,omitempty"`// PageSize: Optional. Maximum number of results to return per page. Set this// property to the number of prediction results required. If zero, the service// will choose a reasonable default.PageSizeint64 `json:"pageSize,omitempty"`// PageToken: Optional. The previous PredictResponse.next_page_token.PageTokenstring `json:"pageToken,omitempty"`// Params: Optional. Additional domain specific parameters for the predictions.// Allowed values: * `returnCatalogItem`: Boolean. If set to true, the// associated catalogItem object will be returned in the// `PredictResponse.PredictionResult.itemMetadata` object in the method// response. * `returnItemScore`: Boolean. If set to true, the prediction// 'score' corresponding to each returned item will be set in the `metadata`// field in the prediction response. The given 'score' indicates the// probability of an item 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 items 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 adjust// 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 adjust prediction// results based on product category.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 UserInfo.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 UserInfo.visitor_id to// a random unique ID and leave UserInfo.user_id unset.UserEvent *GoogleCloudRecommendationengineV1beta1UserEvent `json:"userEvent,omitempty"`// ForceSendFields is a list of field names (e.g. "DryRun") 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. "DryRun") 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:"-"`}

GoogleCloudRecommendationengineV1beta1PredictRequest: Request message forPredict method. Full resource name of the format:`{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}` The id of the recommendation engine placement.This id is used to identify the set of models that will be used to make theprediction. We currently support three placements with the following IDs bydefault: // * `shopping_cart`: Predicts items frequently bought togetherwith one or more catalog items in the same shopping session. Commonlydisplayed after `add-to-cart` event, on product detail pages, or on theshopping cart page. * `home_page`: Predicts the next product that a userwill most likely engage with or purchase based on the shopping or viewinghistory of the specified `userId` or `visitorId`. For example -Recommendations for you. * `product_detail`: Predicts the next product thata user will most likely engage with or purchase. The prediction is based onthe shopping or viewing history of the specified `userId` or `visitorId` andits relevance to a specified `CatalogItem`. Typically used on product detailpages. For example - More items like this. * `recently_viewed_default`:Returns up to 75 items recently viewed by the specified `userId` or`visitorId`, most recent ones first. Returns nothing if neither of them hasviewed any items yet. For example - Recently viewed. The full list ofavailable placements can be seen athttps://console.cloud.google.com/recommendation/catalogs/default_catalog/placements

func (GoogleCloudRecommendationengineV1beta1PredictRequest)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1PredictResponse

type GoogleCloudRecommendationengineV1beta1PredictResponse struct {// DryRun: True if the dryRun property was set in the request.DryRunbool `json:"dryRun,omitempty"`// ItemsMissingInCatalog: IDs of items in the request that were missing from// the catalog.ItemsMissingInCatalog []string `json:"itemsMissingInCatalog,omitempty"`// Metadata: Additional domain specific prediction response metadata.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// NextPageToken: If empty, the list is complete. If nonempty, the token to// pass to the next request's PredictRequest.page_token.NextPageTokenstring `json:"nextPageToken,omitempty"`// RecommendationToken: A unique recommendation token. This should be included// in the user event logs resulting from this recommendation, which enables// accurate attribution of recommendation model performance.RecommendationTokenstring `json:"recommendationToken,omitempty"`// Results: A list of recommended items. The order represents the ranking (from// the most relevant item to the least).Results []*GoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult `json:"results,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DryRun") 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. "DryRun") 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:"-"`}

GoogleCloudRecommendationengineV1beta1PredictResponse: Response message forpredict method.

func (GoogleCloudRecommendationengineV1beta1PredictResponse)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult

type GoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult struct {// Id: ID of the recommended catalog itemIdstring `json:"id,omitempty"`// ItemMetadata: Additional item metadata / annotations. Possible values: *// `catalogItem`: JSON representation of the catalogItem. Will be set if// `returnCatalogItem` is set to true in `PredictRequest.params`. * `score`:// Prediction score in double value. Will be set if `returnItemScore` is set to// true in `PredictRequest.params`.ItemMetadatagoogleapi.RawMessage `json:"itemMetadata,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:"-"`}

GoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult:PredictionResult represents the recommendation prediction results.

func (GoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration

type GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration struct {// ApiKey: The API key.ApiKeystring `json:"apiKey,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ApiKey") 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. "ApiKey") 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:"-"`}

GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration:Registered Api Key.

func (GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ProductCatalogItem

type GoogleCloudRecommendationengineV1beta1ProductCatalogItem struct {// AvailableQuantity: Optional. The available quantity of the item.AvailableQuantityint64 `json:"availableQuantity,omitempty,string"`// CanonicalProductUri: Optional. Canonical URL directly linking to the item// detail page with a length limit of 5 KiB..CanonicalProductUristring `json:"canonicalProductUri,omitempty"`// Costs: Optional. A map to pass the costs associated with the product. For// example: {"manufacturing": 45.5} The profit of selling this item is computed// like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) *// If 'priceRange' is provided, profit = minPrice - sum(costs)Costs map[string]float64 `json:"costs,omitempty"`// CurrencyCode: Optional. Only required if the price is set. Currency code for// price/costs. Use three-character ISO-4217 code.CurrencyCodestring `json:"currencyCode,omitempty"`// ExactPrice: Optional. The exact product price.ExactPrice *GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice `json:"exactPrice,omitempty"`// Images: Optional. Product images for the catalog item.Images []*GoogleCloudRecommendationengineV1beta1Image `json:"images,omitempty"`// PriceRange: Optional. The product price range.PriceRange *GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange `json:"priceRange,omitempty"`// StockState: Optional. Online stock state of the catalog item. Default is// `IN_STOCK`.//// Possible values://   "STOCK_STATE_UNSPECIFIED" - Default item stock status. Should never be// used.//   "IN_STOCK" - Item in stock.//   "OUT_OF_STOCK" - Item out of stock.//   "PREORDER" - Item that is in pre-order state.//   "BACKORDER" - Item that is back-ordered (i.e. temporarily out of stock).StockStatestring `json:"stockState,omitempty"`// ForceSendFields is a list of field names (e.g. "AvailableQuantity") 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. "AvailableQuantity") 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:"-"`}

GoogleCloudRecommendationengineV1beta1ProductCatalogItem: ProductCatalogItemcaptures item metadata specific to retail products.

func (GoogleCloudRecommendationengineV1beta1ProductCatalogItem)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice

type GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice struct {// DisplayPrice: Optional. Display price of the product.DisplayPricefloat64 `json:"displayPrice,omitempty"`// OriginalPrice: Optional. Price of the product without any discount. If zero,// by default set to be the 'displayPrice'.OriginalPricefloat64 `json:"originalPrice,omitempty"`// ForceSendFields is a list of field names (e.g. "DisplayPrice") 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. "DisplayPrice") 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:"-"`}

GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice: Exactproduct price.

func (GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice)MarshalJSON

func (*GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice)UnmarshalJSON

typeGoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange

type GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange struct {// Max: Required. The maximum product price.Maxfloat64 `json:"max,omitempty"`// Min: Required. The minimum product price.Minfloat64 `json:"min,omitempty"`// ForceSendFields is a list of field names (e.g. "Max") 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. "Max") 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:"-"`}

GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange: Productprice range when there are a range of prices for different variations of thesame product.

func (GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange)MarshalJSON

func (*GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange)UnmarshalJSON

typeGoogleCloudRecommendationengineV1beta1ProductDetail

type GoogleCloudRecommendationengineV1beta1ProductDetail struct {// AvailableQuantity: Optional. Quantity of the products in stock when a user// event happens. Optional. If provided, this overrides the available quantity// in Catalog for this event. and can only be set if `stock_status` is set to// `IN_STOCK`. Note that if an item is out of stock, you must set the// `stock_state` field to be `OUT_OF_STOCK`. Leaving this field unspecified /// as zero is not sufficient to mark the item out of stock.AvailableQuantityint64 `json:"availableQuantity,omitempty"`// CurrencyCode: Optional. Currency code for price/costs. Use three-character// ISO-4217 code. Required only if originalPrice or displayPrice is set.CurrencyCodestring `json:"currencyCode,omitempty"`// DisplayPrice: Optional. Display price of the product (e.g. discounted// price). If provided, this will override the display price in Catalog for// this product.DisplayPricefloat64 `json:"displayPrice,omitempty"`// Id: Required. Catalog item ID. UTF-8 encoded string with a length limit of// 128 characters.Idstring `json:"id,omitempty"`// ItemAttributes: Optional. Extra features associated with a product in the// user event.ItemAttributes *GoogleCloudRecommendationengineV1beta1FeatureMap `json:"itemAttributes,omitempty"`// OriginalPrice: Optional. Original price of the product. If provided, this// will override the original price in Catalog for this product.OriginalPricefloat64 `json:"originalPrice,omitempty"`// Quantity: Optional. 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 `add-to-cart` event. Required for `add-to-cart`, `add-to-list`,// `remove-from-cart`, `checkout-start`, `purchase-complete`, `refund` event// types.Quantityint64 `json:"quantity,omitempty"`// StockState: Optional. Item stock state. If provided, this overrides the// stock state in Catalog for items in this event.//// Possible values://   "STOCK_STATE_UNSPECIFIED" - Default item stock status. Should never be// used.//   "IN_STOCK" - Item in stock.//   "OUT_OF_STOCK" - Item out of stock.//   "PREORDER" - Item that is in pre-order state.//   "BACKORDER" - Item that is back-ordered (i.e. temporarily out of stock).StockStatestring `json:"stockState,omitempty"`// ForceSendFields is a list of field names (e.g. "AvailableQuantity") 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. "AvailableQuantity") 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:"-"`}

GoogleCloudRecommendationengineV1beta1ProductDetail: Detailed productinformation associated with a user event.

func (GoogleCloudRecommendationengineV1beta1ProductDetail)MarshalJSON

func (*GoogleCloudRecommendationengineV1beta1ProductDetail)UnmarshalJSON

typeGoogleCloudRecommendationengineV1beta1ProductEventDetail

type GoogleCloudRecommendationengineV1beta1ProductEventDetail struct {// CartId: Optional. 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`, `remove-from-cart`,// `checkout-start`, `purchase-complete`, or `shopping-cart-page-view` events.CartIdstring `json:"cartId,omitempty"`// ListId: Required for `add-to-list` and `remove-from-list` events. The id or// name of the list that the item is being added to or removed from. Other// event types should not set this field.ListIdstring `json:"listId,omitempty"`// PageCategories: 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. The categories associated with a category// page. Category pages include special pages such as sales or promotions. For// instance, a special sale page may have the category hierarchy: categories :// ["Sales", "2017 Black Friday Deals"].PageCategories []*GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy `json:"pageCategories,omitempty"`// ProductDetails: The main product details related to the event. This field is// required for the following event types: * `add-to-cart` * `add-to-list` *// `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` *// `remove-from-cart` * `remove-from-list` This field is optional for the// following event types: * `page-visit` * `shopping-cart-page-view` - note// that 'product_details' should be set for this unless the shopping cart is// empty. * `search` (highly encouraged) 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 broswing 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 broswing the whole page yet.// This field is not allowed for the following event types: *// `category-page-view` * `home-page-view`ProductDetails []*GoogleCloudRecommendationengineV1beta1ProductDetail `json:"productDetails,omitempty"`// PurchaseTransaction: Optional. A transaction represents the entire purchase// transaction. Required for `purchase-complete` events. Optional for// `checkout-start` events. Other event types should not set this field.PurchaseTransaction *GoogleCloudRecommendationengineV1beta1PurchaseTransaction `json:"purchaseTransaction,omitempty"`// SearchQuery: At least one of search_query or page_categories is required for// `search` events. Other event types should not set this field. The user's// search query as UTF-8 encoded text with a length limit of 5 KiB.SearchQuerystring `json:"searchQuery,omitempty"`// ForceSendFields is a list of field names (e.g. "CartId") 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. "CartId") 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:"-"`}

GoogleCloudRecommendationengineV1beta1ProductEventDetail: ProductEventDetailcaptures user event information specific to retail products.

func (GoogleCloudRecommendationengineV1beta1ProductEventDetail)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1PurchaseTransaction

type GoogleCloudRecommendationengineV1beta1PurchaseTransaction struct {// Costs: Optional. All the costs associated with the product. These can be// manufacturing costs, shipping expenses not borne by the end user, or any// other costs. Total product cost such that profit = revenue - (sum(taxes) +// sum(costs)) If product_cost is not set, then profit = revenue - tax -// shipping - sum(CatalogItem.costs). If CatalogItem.cost is not specified for// one of the items, CatalogItem.cost based profit *cannot* be calculated for// this Transaction.Costs map[string]float64 `json:"costs,omitempty"`// CurrencyCode: Required. Currency code. Use three-character ISO-4217 code.// This field is not required if the event type is `refund`.CurrencyCodestring `json:"currencyCode,omitempty"`// Id: Optional. The transaction ID with a length limit of 128 bytes.Idstring `json:"id,omitempty"`// Revenue: Required. Total 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. This// field is not required if the event type is `refund`.Revenuefloat64 `json:"revenue,omitempty"`// Taxes: Optional. All the taxes associated with the transaction.Taxes map[string]float64 `json:"taxes,omitempty"`// ForceSendFields is a list of field names (e.g. "Costs") 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. "Costs") 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:"-"`}

GoogleCloudRecommendationengineV1beta1PurchaseTransaction: A transactionrepresents the entire purchase transaction.

func (GoogleCloudRecommendationengineV1beta1PurchaseTransaction)MarshalJSON

func (*GoogleCloudRecommendationengineV1beta1PurchaseTransaction)UnmarshalJSON

typeGoogleCloudRecommendationengineV1beta1PurgeUserEventsMetadata

type GoogleCloudRecommendationengineV1beta1PurgeUserEventsMetadata struct {// CreateTime: Operation create time.CreateTimestring `json:"createTime,omitempty"`// OperationName: The ID of the request / operation.OperationNamestring `json:"operationName,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:"-"`}

GoogleCloudRecommendationengineV1beta1PurgeUserEventsMetadata: Metadatarelated to the progress of the PurgeUserEvents operation. This will bereturned by the google.longrunning.Operation.metadata field.

func (GoogleCloudRecommendationengineV1beta1PurgeUserEventsMetadata)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest

type GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest struct {// Filter: Required. The filter string to specify the events to be deleted.// Empty string filter is not allowed. The eligible fields for filtering are: *// `eventType`: UserEvent.eventType field of type string. * `eventTime`: in ISO// 8601 "zulu" format. * `visitorId`: field of type string. Specifying this// will delete all events associated with a visitor. * `userId`: field of type// 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: Optional. The default value is false. Override this flag to true to// actually perform the purge. If the field is not set to true, a sampling of// events to be deleted will be returned.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:"-"`}

GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest: Requestmessage for PurgeUserEvents method.

func (GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1PurgeUserEventsResponse

type GoogleCloudRecommendationengineV1beta1PurgeUserEventsResponse struct {// PurgedEventsCount: The total count of events purged as a result of the// operation.PurgedEventsCountint64 `json:"purgedEventsCount,omitempty,string"`// UserEventsSample: A sampling of events deleted (or will be deleted)// depending on the `force` property in the request. Max of 500 items will be// returned.UserEventsSample []*GoogleCloudRecommendationengineV1beta1UserEvent `json:"userEventsSample,omitempty"`// 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:"-"`}

GoogleCloudRecommendationengineV1beta1PurgeUserEventsResponse: Response ofthe PurgeUserEventsRequest. If the long running operation is successfullydone, then this message is returned by thegoogle.longrunning.Operations.response field.

func (GoogleCloudRecommendationengineV1beta1PurgeUserEventsResponse)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1RejoinUserEventsMetadataadded inv0.35.0

type GoogleCloudRecommendationengineV1beta1RejoinUserEventsMetadata struct {}

GoogleCloudRecommendationengineV1beta1RejoinUserEventsMetadata: Metadata forRejoinUserEvents method.

typeGoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest

type GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest struct {// UserEventRejoinScope: Required. The type of the catalog rejoin to define the// scope and range of the user events to be rejoined with catalog items.//// Possible values://   "USER_EVENT_REJOIN_SCOPE_UNSPECIFIED" - Rejoin catalogs with all events// including both joined events and unjoined events.//   "JOINED_EVENTS" - Only rejoin catalogs with joined events.//   "UNJOINED_EVENTS" - Only rejoin catalogs with unjoined events.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:"-"`}

GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest: Requestmessage for CatalogRejoin method.

func (GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1RejoinUserEventsResponseadded inv0.35.0

type GoogleCloudRecommendationengineV1beta1RejoinUserEventsResponse struct {// RejoinedUserEventsCount: Number of user events that were joined with latest// catalog items.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:"-"`}

GoogleCloudRecommendationengineV1beta1RejoinUserEventsResponse: Responsemessage for RejoinUserEvents method.

func (GoogleCloudRecommendationengineV1beta1RejoinUserEventsResponse)MarshalJSONadded inv0.35.0

typeGoogleCloudRecommendationengineV1beta1UserEvent

type GoogleCloudRecommendationengineV1beta1UserEvent struct {// EventDetail: Optional. User event detailed information common across// different recommendation types.EventDetail *GoogleCloudRecommendationengineV1beta1EventDetail `json:"eventDetail,omitempty"`// EventSource: Optional. This field should *not* be set when using JavaScript// pixel or the Recommendations AI Tag. Defaults to `EVENT_SOURCE_UNSPECIFIED`.//// Possible values://   "EVENT_SOURCE_UNSPECIFIED" - Unspecified event source.//   "AUTOML" - The event is ingested via a javascript pixel or Recommendations// AI Tag through automl datalayer or JS Macros.//   "ECOMMERCE" - The event is ingested via Recommendations AI Tag through// Enhanced Ecommerce datalayer.//   "BATCH_UPLOAD" - The event is ingested via Import user events API.EventSourcestring `json:"eventSource,omitempty"`// EventTime: Optional. Only required for ImportUserEvents method. Timestamp of// user event created.EventTimestring `json:"eventTime,omitempty"`// EventType: Required. User event type. Allowed values are: * `add-to-cart`// Products being added to cart. * `add-to-list` Items being added to a list// (shopping list, favorites etc). * `category-page-view` Special pages such as// sale or promotion pages viewed. * `checkout-start` User starting a checkout// process. * `detail-page-view` Products detail page viewed. *// `home-page-view` Homepage viewed. * `page-visit` Generic page visits not// included in the event types above. * `purchase-complete` User finishing a// purchase. * `refund` Purchased items being refunded or returned. *// `remove-from-cart` Products being removed from cart. * `remove-from-list`// Items being removed from a list. * `search` Product search. *// `shopping-cart-page-view` User viewing a shopping cart. * `impression` List// of items displayed. Used by Google Tag Manager.EventTypestring `json:"eventType,omitempty"`// ProductEventDetail: Optional. Retail product specific user event metadata.// This field is required for the following event types: * `add-to-cart` *// `add-to-list` * `category-page-view` * `checkout-start` * `detail-page-view`// * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` *// `search` This field is optional for the following event types: *// `page-visit` * `shopping-cart-page-view` - note that 'product_event_detail'// should be set for this unless the shopping cart is empty. This field is not// allowed for the following event types: * `home-page-view`ProductEventDetail *GoogleCloudRecommendationengineV1beta1ProductEventDetail `json:"productEventDetail,omitempty"`// UserInfo: Required. User information.UserInfo *GoogleCloudRecommendationengineV1beta1UserInfo `json:"userInfo,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "EventDetail") 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. "EventDetail") 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:"-"`}

GoogleCloudRecommendationengineV1beta1UserEvent: UserEvent captures allmetadata information recommendation engine needs to know about how end usersinteract with customers' website.

func (GoogleCloudRecommendationengineV1beta1UserEvent)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1UserEventImportSummary

type GoogleCloudRecommendationengineV1beta1UserEventImportSummary 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:"-"`}

GoogleCloudRecommendationengineV1beta1UserEventImportSummary: A summary ofimport result. The UserEventImportSummary summarizes the import status foruser events.

func (GoogleCloudRecommendationengineV1beta1UserEventImportSummary)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1UserEventInlineSource

type GoogleCloudRecommendationengineV1beta1UserEventInlineSource struct {// UserEvents: Optional. A list of user events to import. Recommended max of// 10k items.UserEvents []*GoogleCloudRecommendationengineV1beta1UserEvent `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:"-"`}

GoogleCloudRecommendationengineV1beta1UserEventInlineSource: The inlinesource for the input config for ImportUserEvents method.

func (GoogleCloudRecommendationengineV1beta1UserEventInlineSource)MarshalJSON

typeGoogleCloudRecommendationengineV1beta1UserInfo

type GoogleCloudRecommendationengineV1beta1UserInfo struct {// DirectUserRequest: Optional. Indicates if the request is made directly from// the end user in which case the user_agent and ip_address fields can be// populated from the HTTP request. This should *not* be set when using the// javascript pixel. 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).DirectUserRequestbool `json:"directUserRequest,omitempty"`// IpAddress: Optional. IP address of the user. This could be either IPv4 (e.g.// 104.133.9.80) or IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This// should *not* be set when using the javascript pixel or if// `direct_user_request` is set. Used to extract location information for// personalization.IpAddressstring `json:"ipAddress,omitempty"`// UserAgent: Optional. User agent as included in the HTTP header. UTF-8// encoded string with a length limit of 1 KiB. This should *not* be set when// using the JavaScript pixel or if `directUserRequest` is set.UserAgentstring `json:"userAgent,omitempty"`// UserId: Optional. Unique identifier for logged-in user with a length limit// of 128 bytes. Required only for logged-in users. Don't set for anonymous// users. 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.UserIdstring `json:"userId,omitempty"`// VisitorId: Required. A unique identifier for tracking visitors with a length// limit of 128 bytes. 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. Maximum length 128 bytes. Cannot be empty. 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.VisitorIdstring `json:"visitorId,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:"-"`}

GoogleCloudRecommendationengineV1beta1UserInfo: Information of end users.

func (GoogleCloudRecommendationengineV1beta1UserInfo)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)

typeProjectsLocationsCatalogsCatalogItemsCreateCall

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

func (*ProjectsLocationsCatalogsCatalogItemsCreateCall)Context

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

func (*ProjectsLocationsCatalogsCatalogItemsCreateCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.catalogItems.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1CatalogItem.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 (*ProjectsLocationsCatalogsCatalogItemsCreateCall)Fields

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

func (*ProjectsLocationsCatalogsCatalogItemsCreateCall)Header

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

typeProjectsLocationsCatalogsCatalogItemsDeleteCall

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

func (*ProjectsLocationsCatalogsCatalogItemsDeleteCall)Context

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

func (*ProjectsLocationsCatalogsCatalogItemsDeleteCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.catalogItems.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 (*ProjectsLocationsCatalogsCatalogItemsDeleteCall)Fields

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

func (*ProjectsLocationsCatalogsCatalogItemsDeleteCall)Header

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

typeProjectsLocationsCatalogsCatalogItemsGetCall

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

func (*ProjectsLocationsCatalogsCatalogItemsGetCall)Context

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

func (*ProjectsLocationsCatalogsCatalogItemsGetCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.catalogItems.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1CatalogItem.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 (*ProjectsLocationsCatalogsCatalogItemsGetCall)Fields

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

func (*ProjectsLocationsCatalogsCatalogItemsGetCall)Header

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

func (*ProjectsLocationsCatalogsCatalogItemsGetCall)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.

typeProjectsLocationsCatalogsCatalogItemsImportCall

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

func (*ProjectsLocationsCatalogsCatalogItemsImportCall)Context

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

func (*ProjectsLocationsCatalogsCatalogItemsImportCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.catalogItems.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 (*ProjectsLocationsCatalogsCatalogItemsImportCall)Fields

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

func (*ProjectsLocationsCatalogsCatalogItemsImportCall)Header

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

typeProjectsLocationsCatalogsCatalogItemsListCall

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

func (*ProjectsLocationsCatalogsCatalogItemsListCall)Context

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

func (*ProjectsLocationsCatalogsCatalogItemsListCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.catalogItems.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse.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 (*ProjectsLocationsCatalogsCatalogItemsListCall)Fields

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

func (*ProjectsLocationsCatalogsCatalogItemsListCall)Filter

Filter sets the optional parameter "filter": Use of this field is notsupported by version v1beta1.

func (*ProjectsLocationsCatalogsCatalogItemsListCall)Header

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

func (*ProjectsLocationsCatalogsCatalogItemsListCall)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 (*ProjectsLocationsCatalogsCatalogItemsListCall)PageSize

PageSize sets the optional parameter "pageSize": Maximum number of resultsto return per page. If zero, the service will choose a reasonable default.

func (*ProjectsLocationsCatalogsCatalogItemsListCall)PageToken

PageToken sets the optional parameter "pageToken": The previousListCatalogItemsResponse.next_page_token.

func (*ProjectsLocationsCatalogsCatalogItemsListCall)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.

typeProjectsLocationsCatalogsCatalogItemsPatchCall

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

func (*ProjectsLocationsCatalogsCatalogItemsPatchCall)Context

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

func (*ProjectsLocationsCatalogsCatalogItemsPatchCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.catalogItems.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1CatalogItem.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 (*ProjectsLocationsCatalogsCatalogItemsPatchCall)Fields

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

func (*ProjectsLocationsCatalogsCatalogItemsPatchCall)Header

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

func (*ProjectsLocationsCatalogsCatalogItemsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": Indicates which fieldsin the provided 'item' to update. If not set, will by default update allfields.

typeProjectsLocationsCatalogsCatalogItemsService

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

func (*ProjectsLocationsCatalogsCatalogItemsService)Create

Create: Creates a catalog item.

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

func (*ProjectsLocationsCatalogsCatalogItemsService)Delete

Delete: Deletes a catalog item.

  • name: Full resource name of catalog item, such as`projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.

func (*ProjectsLocationsCatalogsCatalogItemsService)Get

Get: Gets a specific catalog item.

  • name: Full resource name of catalog item, such as`projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.

func (*ProjectsLocationsCatalogsCatalogItemsService)Import

Import: Bulk import of multiple catalog items. Request processing may besynchronous. No partial updating supported. Non-existing items will becreated. Operation.response is of type ImportResponse. Note that it ispossible for a subset of the items to be successfully updated.

  • parent: `projects/1234/locations/global/catalogs/default_catalog` If noupdateMask is specified, requires catalogItems.create permission. IfupdateMask is specified, requires catalogItems.update permission.

func (*ProjectsLocationsCatalogsCatalogItemsService)List

List: Gets a list of catalog items.

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

func (*ProjectsLocationsCatalogsCatalogItemsService)Patch

Patch: Updates a catalog item. Partial updating is supported. Non-existingitems will be created.

  • name: Full resource name of catalog item, such as`projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.

typeProjectsLocationsCatalogsEventStoresOperationsGetCall

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

func (*ProjectsLocationsCatalogsEventStoresOperationsGetCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresOperationsGetCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.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 (*ProjectsLocationsCatalogsEventStoresOperationsGetCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresOperationsGetCall)Header

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

func (*ProjectsLocationsCatalogsEventStoresOperationsGetCall)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.

typeProjectsLocationsCatalogsEventStoresOperationsListCall

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

func (*ProjectsLocationsCatalogsEventStoresOperationsListCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresOperationsListCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.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 (*ProjectsLocationsCatalogsEventStoresOperationsListCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresOperationsListCall)Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsCatalogsEventStoresOperationsListCall)Header

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

func (*ProjectsLocationsCatalogsEventStoresOperationsListCall)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 (*ProjectsLocationsCatalogsEventStoresOperationsListCall)PageSize

PageSize sets the optional parameter "pageSize": The standard list pagesize.

func (*ProjectsLocationsCatalogsEventStoresOperationsListCall)PageToken

PageToken sets the optional parameter "pageToken": The standard list pagetoken.

func (*ProjectsLocationsCatalogsEventStoresOperationsListCall)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 (*ProjectsLocationsCatalogsEventStoresOperationsListCall)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.

typeProjectsLocationsCatalogsEventStoresOperationsService

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

func (*ProjectsLocationsCatalogsEventStoresOperationsService)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 (*ProjectsLocationsCatalogsEventStoresOperationsService)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.

typeProjectsLocationsCatalogsEventStoresPlacementsPredictCall

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

func (*ProjectsLocationsCatalogsEventStoresPlacementsPredictCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresPlacementsPredictCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.placements.predict" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1PredictResponse.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 (*ProjectsLocationsCatalogsEventStoresPlacementsPredictCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresPlacementsPredictCall)Header

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

func (*ProjectsLocationsCatalogsEventStoresPlacementsPredictCall)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.

typeProjectsLocationsCatalogsEventStoresPlacementsService

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

func (*ProjectsLocationsCatalogsEventStoresPlacementsService)Predict

Predict: Makes a recommendation prediction. If using API Key basedauthentication, the API Key must be registered using thePredictionApiKeyRegistry service. Learn more(https://cloud.google.com/recommendations-ai/docs/setting-up#register-key).

- name: .

typeProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsCreateCall

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsCreateCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsCreateCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration.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 (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsCreateCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsCreateCall)Header

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

typeProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsDeleteCall

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsDeleteCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsDeleteCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.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 (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsDeleteCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsDeleteCall)Header

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

typeProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsListCall

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsListCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsListCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse.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 (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsListCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsListCall)Header

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsListCall)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 (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsListCall)PageSize

PageSize sets the optional parameter "pageSize": Maximum number of resultsto return per page. If unset, the service will choose a reasonable default.

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsListCall)PageToken

PageToken sets the optional parameter "pageToken": The previous`ListPredictionApiKeyRegistration.nextPageToken`.

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsListCall)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.

typeProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsService

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

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsService)Create

Create: Register an API key for use with predict method.

  • parent: The parent resource path.`projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`.

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsService)Delete

Delete: Unregister an apiKey from using for predict method.

  • name: The API key to unregister including full resource path.`projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/`.

func (*ProjectsLocationsCatalogsEventStoresPredictionApiKeyRegistrationsService)List

List: List the registered apiKeys for use with predict method.

  • parent: The parent placement resource name such as`projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.

typeProjectsLocationsCatalogsEventStoresUserEventsCollectCall

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsCollectCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsCollectCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.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 (*ProjectsLocationsCatalogsEventStoresUserEventsCollectCall)Ets

Ets sets the optional parameter "ets": The event timestamp in milliseconds.This prevents browser caching of otherwise identical get requests. The nameis abbreviated to reduce the payload bytes.

func (*ProjectsLocationsCatalogsEventStoresUserEventsCollectCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsCollectCall)Header

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsCollectCall)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 (*ProjectsLocationsCatalogsEventStoresUserEventsCollectCall)Uri

Uri sets the optional parameter "uri": The url including cgi-parameters butexcluding the hash fragment. The URL must be truncated to 1.5K bytes toconservatively be under the 2K bytes. This is often more useful than thereferer url, because many browsers only send the domain for 3rd partyrequests.

func (*ProjectsLocationsCatalogsEventStoresUserEventsCollectCall)UserEvent

UserEvent sets the optional parameter "userEvent": Required. URL encodedUserEvent proto.

typeProjectsLocationsCatalogsEventStoresUserEventsImportCall

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsImportCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsImportCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.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 (*ProjectsLocationsCatalogsEventStoresUserEventsImportCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsImportCall)Header

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

typeProjectsLocationsCatalogsEventStoresUserEventsListCall

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsListCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsListCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.userEvents.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1ListUserEventsResponse.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 (*ProjectsLocationsCatalogsEventStoresUserEventsListCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsListCall)Filter

Filter sets the optional parameter "filter": Filtering expression to specifyrestrictions over returned events. This is a sequence of terms, where eachterm applies some kind of a restriction to the returned user events. Usethis expression to restrict results to a specific time range, or filterevents by eventType. eg: eventTime > "2012-04-23T18:25:43.511Z"eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z"eventType=search We expect only 3 types of fields: * eventTime: this can bespecified a maximum of 2 times, once with a less than operator and once witha greater than operator. The eventTime restrict should result in onecontiguous valid eventTime range. * eventType: only 1 eventType restrictioncan be specified. * eventsMissingCatalogItems: specififying this willrestrict results to events for which catalog items were not found in thecatalog. The default behavior is to return only those events for whichcatalog items were found. Some examples of valid filters expressions: *Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime <"2012-04-23T18:30:43.511Z" * Example 2: eventTime >"2012-04-23T18:25:43.511Z" eventType = detail-page-view * Example 3:eventsMissingCatalogItems eventType = search eventTime <"2018-04-23T18:30:43.511Z" * Example 4: eventTime >"2012-04-23T18:25:43.511Z" * Example 5: eventType = search * Example 6:eventsMissingCatalogItems

func (*ProjectsLocationsCatalogsEventStoresUserEventsListCall)Header

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsListCall)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 (*ProjectsLocationsCatalogsEventStoresUserEventsListCall)PageSize

PageSize sets the optional parameter "pageSize": Maximum number of resultsto return per page. If zero, the service will choose a reasonable default.

func (*ProjectsLocationsCatalogsEventStoresUserEventsListCall)PageToken

PageToken sets the optional parameter "pageToken": The previousListUserEventsResponse.next_page_token.

func (*ProjectsLocationsCatalogsEventStoresUserEventsListCall)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.

typeProjectsLocationsCatalogsEventStoresUserEventsPurgeCall

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsPurgeCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsPurgeCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.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 (*ProjectsLocationsCatalogsEventStoresUserEventsPurgeCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsPurgeCall)Header

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

typeProjectsLocationsCatalogsEventStoresUserEventsRejoinCall

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsRejoinCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsRejoinCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.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 (*ProjectsLocationsCatalogsEventStoresUserEventsRejoinCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsRejoinCall)Header

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

typeProjectsLocationsCatalogsEventStoresUserEventsService

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsService)Collect

Collect: Writes a single user event from the browser. This uses a GETrequest to due to browser restriction of POST-ing to a 3rd party domain.This method is used only by the Recommendations AI JavaScript pixel. Usersshould not call this method directly.

  • parent: The parent eventStore name, such as`projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.

func (*ProjectsLocationsCatalogsEventStoresUserEventsService)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. Notethat it is possible for a subset of the items to be successfully inserted.Operation.metadata is of type ImportMetadata.

  • parent:`projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.

func (*ProjectsLocationsCatalogsEventStoresUserEventsService)List

List: Gets a list of user events within a time range, with potentialfiltering. The method does not list unjoined user events. Unjoined userevent definition: when a user event is ingested from Recommendations AI UserEvent APIs, the catalog item included in the user event is connected withthe current catalog. If a catalog item of the ingested event is not in thecurrent catalog, it could lead to degraded model quality. This is called anunjoined event.

  • parent: The parent eventStore resource name, such as`projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.

func (*ProjectsLocationsCatalogsEventStoresUserEventsService)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 event_store under which the events arecreated. The format is`projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`.

func (*ProjectsLocationsCatalogsEventStoresUserEventsService)Rejoin

Rejoin: Triggers a user event rejoin operation with latest catalog data.Events will not be annotated with detailed catalog information if catalogitem is missing at the time the user event is ingested, and these events arestored as unjoined events with a limited usage on training and serving. ThisAPI can be used to trigger a 'join' operation on specified events withlatest version of catalog items. It can also be used to correct eventsjoined with wrong catalog items.

  • parent: Full resource name of user event, such as`projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.

func (*ProjectsLocationsCatalogsEventStoresUserEventsService)Write

Write: Writes a single user event.

  • parent: The parent eventStore resource name, such as"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".

typeProjectsLocationsCatalogsEventStoresUserEventsWriteCall

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsWriteCall)Context

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsWriteCall)Do

Do executes the "recommendationengine.projects.locations.catalogs.eventStores.userEvents.write" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1UserEvent.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 (*ProjectsLocationsCatalogsEventStoresUserEventsWriteCall)Fields

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

func (*ProjectsLocationsCatalogsEventStoresUserEventsWriteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the 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 "recommendationengine.projects.locations.catalogs.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1ListCatalogsResponse.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 (*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 resultsto return. If unspecified, defaults to 50. Max allowed value is 1000.

func (*ProjectsLocationsCatalogsListCall)PageToken

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

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.

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 "recommendationengine.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 "recommendationengine.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 "recommendationengine.projects.locations.catalogs.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleCloudRecommendationengineV1beta1Catalog.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 (*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 not set, will only update thecatalog_item_level_config field. Currently only fields that can be updatedare catalog_item_level_config.

typeProjectsLocationsCatalogsService

type ProjectsLocationsCatalogsService struct {CatalogItems *ProjectsLocationsCatalogsCatalogItemsServiceEventStores *ProjectsLocationsCatalogsEventStoresServiceOperations *ProjectsLocationsCatalogsOperationsService// contains filtered or unexported fields}

funcNewProjectsLocationsCatalogsService

func NewProjectsLocationsCatalogsService(s *Service) *ProjectsLocationsCatalogsService

func (*ProjectsLocationsCatalogsService)List

List: Lists all the catalog configurations associated with the project.

- parent: The account resource name with an associated location.

func (*ProjectsLocationsCatalogsService)Patch

Patch: Updates the catalog configuration.

- name: The fully qualified resource name of the catalog.

typeProjectsLocationsService

type ProjectsLocationsService struct {Catalogs *ProjectsLocationsCatalogsService// contains filtered or unexported fields}

funcNewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

typeProjectsService

type ProjectsService struct {Locations *ProjectsLocationsService// contains filtered or unexported fields}

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

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