Package cloud.google.com/go/recommendationengine/apiv1beta1/recommendationenginepb (v0.7.0)

Version latest

• 0.6.0 (latest)
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Variables

ProductCatalogItem_StockState_name, ProductCatalogItem_StockState_value

var (
	ProductCatalogItem_StockState_name = map[int32]string{
		0: "STOCK_STATE_UNSPECIFIED",

		1: "OUT_OF_STOCK",
		2: "PREORDER",
		3: "BACKORDER",
	}
	ProductCatalogItem_StockState_value = map[string]int32{
		"STOCK_STATE_UNSPECIFIED": 0,
		"IN_STOCK":                0,
		"OUT_OF_STOCK":            1,
		"PREORDER":                2,
		"BACKORDER":               3,
	}
)

Enum value maps for ProductCatalogItem_StockState.

UserEvent_EventSource_name, UserEvent_EventSource_value

var (
	UserEvent_EventSource_name = map[int32]string{
		0: "EVENT_SOURCE_UNSPECIFIED",
		1: "AUTOML",
		2: "ECOMMERCE",
		3: "BATCH_UPLOAD",
	}
	UserEvent_EventSource_value = map[string]int32{
		"EVENT_SOURCE_UNSPECIFIED": 0,
		"AUTOML":                   1,
		"ECOMMERCE":                2,
		"BATCH_UPLOAD":             3,
	}
)

Enum value maps for UserEvent_EventSource.

File_google_cloud_recommendationengine_v1beta1_catalog_proto

var File_google_cloud_recommendationengine_v1beta1_catalog_proto protoreflect.FileDescriptor

File_google_cloud_recommendationengine_v1beta1_catalog_service_proto

var File_google_cloud_recommendationengine_v1beta1_catalog_service_proto protoreflect.FileDescriptor

File_google_cloud_recommendationengine_v1beta1_common_proto

var File_google_cloud_recommendationengine_v1beta1_common_proto protoreflect.FileDescriptor

File_google_cloud_recommendationengine_v1beta1_import_proto

var File_google_cloud_recommendationengine_v1beta1_import_proto protoreflect.FileDescriptor

File_google_cloud_recommendationengine_v1beta1_prediction_apikey_registry_service_proto

var File_google_cloud_recommendationengine_v1beta1_prediction_apikey_registry_service_proto protoreflect.FileDescriptor

File_google_cloud_recommendationengine_v1beta1_prediction_service_proto

var File_google_cloud_recommendationengine_v1beta1_prediction_service_proto protoreflect.FileDescriptor

File_google_cloud_recommendationengine_v1beta1_recommendationengine_resources_proto

var File_google_cloud_recommendationengine_v1beta1_recommendationengine_resources_proto protoreflect.FileDescriptor

File_google_cloud_recommendationengine_v1beta1_user_event_proto

var File_google_cloud_recommendationengine_v1beta1_user_event_proto protoreflect.FileDescriptor

File_google_cloud_recommendationengine_v1beta1_user_event_service_proto

var File_google_cloud_recommendationengine_v1beta1_user_event_service_proto protoreflect.FileDescriptor

Functions

func RegisterCatalogServiceServer

func RegisterCatalogServiceServer(s *grpc.Server, srv CatalogServiceServer)

func RegisterPredictionApiKeyRegistryServer

func RegisterPredictionApiKeyRegistryServer(s *grpc.Server, srv PredictionApiKeyRegistryServer)

func RegisterPredictionServiceServer

func RegisterPredictionServiceServer(s *grpc.Server, srv PredictionServiceServer)

func RegisterUserEventServiceServer

func RegisterUserEventServiceServer(s *grpc.Server, srv UserEventServiceServer)

CatalogInlineSource

type CatalogInlineSource struct {

	// Optional. A list of catalog items to update/create. Recommended max of 10k
	// items.
	CatalogItems []*CatalogItem `protobuf:"bytes,1,rep,name=catalog_items,json=catalogItems,proto3" json:"catalog_items,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for ImportCatalogItems method.

func (*CatalogInlineSource) Descriptor

func (*CatalogInlineSource) Descriptor() ([]byte, []int)

Deprecated: Use CatalogInlineSource.ProtoReflect.Descriptor instead.

func (*CatalogInlineSource) GetCatalogItems

func (x *CatalogInlineSource) GetCatalogItems() []*CatalogItem

func (*CatalogInlineSource) ProtoMessage

func (*CatalogInlineSource) ProtoMessage()

func (*CatalogInlineSource) ProtoReflect

func (x *CatalogInlineSource) ProtoReflect() protoreflect.Message

func (*CatalogInlineSource) Reset

func (x *CatalogInlineSource) Reset()

func (*CatalogInlineSource) String

func (x *CatalogInlineSource) String() string

CatalogItem

type CatalogItem struct {

	// 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.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// 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 []*CatalogItem_CategoryHierarchy `protobuf:"bytes,2,rep,name=category_hierarchies,json=categoryHierarchies,proto3" json:"category_hierarchies,omitempty"`
	// Required. Catalog item title. UTF-8 encoded string with a length limit of 1
	// KiB.
	Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"`
	// Optional. Catalog item description. UTF-8 encoded string with a length
	// limit of 5 KiB.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// 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 *FeatureMap `protobuf:"bytes,5,opt,name=item_attributes,json=itemAttributes,proto3" json:"item_attributes,omitempty"`
	// Optional. Language of the title/description/item_attributes. Use language
	// tags defined by BCP 47. https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Our
	// supported language codes include 'en', 'es', 'fr', 'de', 'ar', 'fa', 'zh',
	// 'ja', 'ko', 'sv', 'ro', 'nl'. For other languages, contact
	// your Google account manager.
	LanguageCode string `protobuf:"bytes,6,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
	// 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 `protobuf:"bytes,8,rep,name=tags,proto3" json:"tags,omitempty"`
	// 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).
	ItemGroupId string `protobuf:"bytes,9,opt,name=item_group_id,json=itemGroupId,proto3" json:"item_group_id,omitempty"`
	// Extra catalog item metadata for different recommendation types.
	//
	// Types that are assignable to RecommendationType:
	//
	//	*CatalogItem_ProductMetadata
	RecommendationType isCatalogItem_RecommendationType `protobuf_oneof:"recommendation_type"`
	// contains filtered or unexported fields
}

CatalogItem captures all metadata information of items to be recommended.

func (*CatalogItem) Descriptor

func (*CatalogItem) Descriptor() ([]byte, []int)

Deprecated: Use CatalogItem.ProtoReflect.Descriptor instead.

func (*CatalogItem) GetCategoryHierarchies

func (x *CatalogItem) GetCategoryHierarchies() []*CatalogItem_CategoryHierarchy

func (*CatalogItem) GetDescription

func (x *CatalogItem) GetDescription() string

func (*CatalogItem) GetId

func (x *CatalogItem) GetId() string

func (*CatalogItem) GetItemAttributes

func (x *CatalogItem) GetItemAttributes() *FeatureMap

func (*CatalogItem) GetItemGroupId

func (x *CatalogItem) GetItemGroupId() string

func (*CatalogItem) GetLanguageCode

func (x *CatalogItem) GetLanguageCode() string

func (*CatalogItem) GetProductMetadata

func (x *CatalogItem) GetProductMetadata() *ProductCatalogItem

func (*CatalogItem) GetRecommendationType

func (m *CatalogItem) GetRecommendationType() isCatalogItem_RecommendationType

func (*CatalogItem) GetTags

func (x *CatalogItem) GetTags() []string

func (*CatalogItem) GetTitle

func (x *CatalogItem) GetTitle() string

func (*CatalogItem) ProtoMessage

func (*CatalogItem) ProtoMessage()

func (*CatalogItem) ProtoReflect

func (x *CatalogItem) ProtoReflect() protoreflect.Message

func (*CatalogItem) Reset

func (x *CatalogItem) Reset()

func (*CatalogItem) String

func (x *CatalogItem) String() string

CatalogItem_CategoryHierarchy

type CatalogItem_CategoryHierarchy struct {

	// 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 `protobuf:"bytes,1,rep,name=categories,proto3" json:"categories,omitempty"`
	// contains filtered or unexported fields
}

Category represents catalog item category hierarchy.

func (*CatalogItem_CategoryHierarchy) Descriptor

func (*CatalogItem_CategoryHierarchy) Descriptor() ([]byte, []int)

Deprecated: Use CatalogItem_CategoryHierarchy.ProtoReflect.Descriptor instead.

func (*CatalogItem_CategoryHierarchy) GetCategories

func (x *CatalogItem_CategoryHierarchy) GetCategories() []string

func (*CatalogItem_CategoryHierarchy) ProtoMessage

func (*CatalogItem_CategoryHierarchy) ProtoMessage()

func (*CatalogItem_CategoryHierarchy) ProtoReflect

func (x *CatalogItem_CategoryHierarchy) ProtoReflect() protoreflect.Message

func (*CatalogItem_CategoryHierarchy) Reset

func (x *CatalogItem_CategoryHierarchy) Reset()

func (*CatalogItem_CategoryHierarchy) String

func (x *CatalogItem_CategoryHierarchy) String() string

CatalogItem_ProductMetadata

type CatalogItem_ProductMetadata struct {
	// Optional. Metadata specific to retail products.
	ProductMetadata *ProductCatalogItem `protobuf:"bytes,10,opt,name=product_metadata,json=productMetadata,proto3,oneof"`
}

CatalogServiceClient

type CatalogServiceClient interface {
	// Creates a catalog item.
	CreateCatalogItem(ctx context.Context, in *CreateCatalogItemRequest, opts ...grpc.CallOption) (*CatalogItem, error)
	// Gets a specific catalog item.
	GetCatalogItem(ctx context.Context, in *GetCatalogItemRequest, opts ...grpc.CallOption) (*CatalogItem, error)
	// Gets a list of catalog items.
	ListCatalogItems(ctx context.Context, in *ListCatalogItemsRequest, opts ...grpc.CallOption) (*ListCatalogItemsResponse, error)
	// Updates a catalog item. Partial updating is supported. Non-existing
	// items will be created.
	UpdateCatalogItem(ctx context.Context, in *UpdateCatalogItemRequest, opts ...grpc.CallOption) (*CatalogItem, error)
	// Deletes a catalog item.
	DeleteCatalogItem(ctx context.Context, in *DeleteCatalogItemRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Bulk import of multiple catalog items. Request processing may be
	// synchronous. No partial updating supported. Non-existing items will be
	// created.
	//
	// Operation.response is of type ImportResponse. Note that it is
	// possible for a subset of the items to be successfully updated.
	ImportCatalogItems(ctx context.Context, in *ImportCatalogItemsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}

CatalogServiceClient is the client API for CatalogService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewCatalogServiceClient

func NewCatalogServiceClient(cc grpc.ClientConnInterface) CatalogServiceClient

CatalogServiceServer

type CatalogServiceServer interface {
	// Creates a catalog item.
	CreateCatalogItem(context.Context, *CreateCatalogItemRequest) (*CatalogItem, error)
	// Gets a specific catalog item.
	GetCatalogItem(context.Context, *GetCatalogItemRequest) (*CatalogItem, error)
	// Gets a list of catalog items.
	ListCatalogItems(context.Context, *ListCatalogItemsRequest) (*ListCatalogItemsResponse, error)
	// Updates a catalog item. Partial updating is supported. Non-existing
	// items will be created.
	UpdateCatalogItem(context.Context, *UpdateCatalogItemRequest) (*CatalogItem, error)
	// Deletes a catalog item.
	DeleteCatalogItem(context.Context, *DeleteCatalogItemRequest) (*emptypb.Empty, error)
	// Bulk import of multiple catalog items. Request processing may be
	// synchronous. No partial updating supported. Non-existing items will be
	// created.
	//
	// Operation.response is of type ImportResponse. Note that it is
	// possible for a subset of the items to be successfully updated.
	ImportCatalogItems(context.Context, *ImportCatalogItemsRequest) (*longrunning.Operation, error)
}

CatalogServiceServer is the server API for CatalogService service.

CollectUserEventRequest

type CollectUserEventRequest struct {

	// Required. The parent eventStore name, such as
	// `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. URL encoded UserEvent proto.
	UserEvent string `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
	// Optional. The url including cgi-parameters but excluding the hash fragment.
	// The URL must be truncated to 1.5K bytes to conservatively be under the 2K
	// bytes. This is often more useful than the referer url, because many
	// browsers only send the domain for 3rd party requests.
	Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
	// Optional. The event timestamp in milliseconds. This prevents browser
	// caching of otherwise identical get requests. The name is abbreviated to
	// reduce the payload bytes.
	Ets int64 `protobuf:"varint,4,opt,name=ets,proto3" json:"ets,omitempty"`
	// contains filtered or unexported fields
}

Request message for CollectUserEvent method.

func (*CollectUserEventRequest) Descriptor

func (*CollectUserEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use CollectUserEventRequest.ProtoReflect.Descriptor instead.

func (*CollectUserEventRequest) GetEts

func (x *CollectUserEventRequest) GetEts() int64

func (*CollectUserEventRequest) GetParent

func (x *CollectUserEventRequest) GetParent() string

func (*CollectUserEventRequest) GetUri

func (x *CollectUserEventRequest) GetUri() string

func (*CollectUserEventRequest) GetUserEvent

func (x *CollectUserEventRequest) GetUserEvent() string

func (*CollectUserEventRequest) ProtoMessage

func (*CollectUserEventRequest) ProtoMessage()

func (*CollectUserEventRequest) ProtoReflect

func (x *CollectUserEventRequest) ProtoReflect() protoreflect.Message

func (*CollectUserEventRequest) Reset

func (x *CollectUserEventRequest) Reset()

func (*CollectUserEventRequest) String

func (x *CollectUserEventRequest) String() string

CreateCatalogItemRequest

type CreateCatalogItemRequest struct {

	// Required. The parent catalog resource name, such as
	// `projects/*/locations/global/catalogs/default_catalog`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The catalog item to create.
	CatalogItem *CatalogItem `protobuf:"bytes,2,opt,name=catalog_item,json=catalogItem,proto3" json:"catalog_item,omitempty"`
	// contains filtered or unexported fields
}

Request message for CreateCatalogItem method.

func (*CreateCatalogItemRequest) Descriptor

func (*CreateCatalogItemRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateCatalogItemRequest.ProtoReflect.Descriptor instead.

func (*CreateCatalogItemRequest) GetCatalogItem

func (x *CreateCatalogItemRequest) GetCatalogItem() *CatalogItem

func (*CreateCatalogItemRequest) GetParent

func (x *CreateCatalogItemRequest) GetParent() string

func (*CreateCatalogItemRequest) ProtoMessage

func (*CreateCatalogItemRequest) ProtoMessage()

func (*CreateCatalogItemRequest) ProtoReflect

func (x *CreateCatalogItemRequest) ProtoReflect() protoreflect.Message

func (*CreateCatalogItemRequest) Reset

func (x *CreateCatalogItemRequest) Reset()

func (*CreateCatalogItemRequest) String

func (x *CreateCatalogItemRequest) String() string

CreatePredictionApiKeyRegistrationRequest

type CreatePredictionApiKeyRegistrationRequest struct {
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`

	PredictionApiKeyRegistration *PredictionApiKeyRegistration "" /* 149 byte string literal not displayed */

}

Request message for the CreatePredictionApiKeyRegistration method.

func (*CreatePredictionApiKeyRegistrationRequest) Descriptor

func (*CreatePredictionApiKeyRegistrationRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreatePredictionApiKeyRegistrationRequest.ProtoReflect.Descriptor instead.

func (*CreatePredictionApiKeyRegistrationRequest) GetParent

func (x *CreatePredictionApiKeyRegistrationRequest) GetParent() string

func (*CreatePredictionApiKeyRegistrationRequest) GetPredictionApiKeyRegistration

func (x *CreatePredictionApiKeyRegistrationRequest) GetPredictionApiKeyRegistration() *PredictionApiKeyRegistration

func (*CreatePredictionApiKeyRegistrationRequest) ProtoMessage

func (*CreatePredictionApiKeyRegistrationRequest) ProtoMessage()

func (*CreatePredictionApiKeyRegistrationRequest) ProtoReflect

func (x *CreatePredictionApiKeyRegistrationRequest) ProtoReflect() protoreflect.Message

func (*CreatePredictionApiKeyRegistrationRequest) Reset

func (x *CreatePredictionApiKeyRegistrationRequest) Reset()

func (*CreatePredictionApiKeyRegistrationRequest) String

func (x *CreatePredictionApiKeyRegistrationRequest) String() string

DeleteCatalogItemRequest

type DeleteCatalogItemRequest struct {

	// Required. Full resource name of catalog item, such as
	// `projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for DeleteCatalogItem method.

func (*DeleteCatalogItemRequest) Descriptor

func (*DeleteCatalogItemRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteCatalogItemRequest.ProtoReflect.Descriptor instead.

func (*DeleteCatalogItemRequest) GetName

func (x *DeleteCatalogItemRequest) GetName() string

func (*DeleteCatalogItemRequest) ProtoMessage

func (*DeleteCatalogItemRequest) ProtoMessage()

func (*DeleteCatalogItemRequest) ProtoReflect

func (x *DeleteCatalogItemRequest) ProtoReflect() protoreflect.Message

func (*DeleteCatalogItemRequest) Reset

func (x *DeleteCatalogItemRequest) Reset()

func (*DeleteCatalogItemRequest) String

func (x *DeleteCatalogItemRequest) String() string

DeletePredictionApiKeyRegistrationRequest

type DeletePredictionApiKeyRegistrationRequest struct {

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

Request message for DeletePredictionApiKeyRegistration method.

func (*DeletePredictionApiKeyRegistrationRequest) Descriptor

func (*DeletePredictionApiKeyRegistrationRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeletePredictionApiKeyRegistrationRequest.ProtoReflect.Descriptor instead.

func (*DeletePredictionApiKeyRegistrationRequest) GetName

func (x *DeletePredictionApiKeyRegistrationRequest) GetName() string

func (*DeletePredictionApiKeyRegistrationRequest) ProtoMessage

func (*DeletePredictionApiKeyRegistrationRequest) ProtoMessage()

func (*DeletePredictionApiKeyRegistrationRequest) ProtoReflect

func (x *DeletePredictionApiKeyRegistrationRequest) ProtoReflect() protoreflect.Message

func (*DeletePredictionApiKeyRegistrationRequest) Reset

func (x *DeletePredictionApiKeyRegistrationRequest) Reset()

func (*DeletePredictionApiKeyRegistrationRequest) String

func (x *DeletePredictionApiKeyRegistrationRequest) String() string

EventDetail

type EventDetail struct {

	// 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.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Optional. The referrer url of the current page. When using
	// the JavaScript pixel, this value is filled in automatically.
	ReferrerUri string `protobuf:"bytes,6,opt,name=referrer_uri,json=referrerUri,proto3" json:"referrer_uri,omitempty"`
	// 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.
	PageViewId string `protobuf:"bytes,2,opt,name=page_view_id,json=pageViewId,proto3" json:"page_view_id,omitempty"`
	// 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 `protobuf:"bytes,3,rep,name=experiment_ids,json=experimentIds,proto3" json:"experiment_ids,omitempty"`
	// 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.
	RecommendationToken string `protobuf:"bytes,4,opt,name=recommendation_token,json=recommendationToken,proto3" json:"recommendation_token,omitempty"`
	// 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 *FeatureMap `protobuf:"bytes,5,opt,name=event_attributes,json=eventAttributes,proto3" json:"event_attributes,omitempty"`
	// contains filtered or unexported fields
}

User event details shared by all recommendation types.

func (*EventDetail) Descriptor

func (*EventDetail) Descriptor() ([]byte, []int)

Deprecated: Use EventDetail.ProtoReflect.Descriptor instead.

func (*EventDetail) GetEventAttributes

func (x *EventDetail) GetEventAttributes() *FeatureMap

func (*EventDetail) GetExperimentIds

func (x *EventDetail) GetExperimentIds() []string

func (*EventDetail) GetPageViewId

func (x *EventDetail) GetPageViewId() string

func (*EventDetail) GetRecommendationToken

func (x *EventDetail) GetRecommendationToken() string

func (*EventDetail) GetReferrerUri

func (x *EventDetail) GetReferrerUri() string

func (*EventDetail) GetUri

func (x *EventDetail) GetUri() string

func (*EventDetail) ProtoMessage

func (*EventDetail) ProtoMessage()

func (*EventDetail) ProtoReflect

func (x *EventDetail) ProtoReflect() protoreflect.Message

func (*EventDetail) Reset

func (x *EventDetail) Reset()

func (*EventDetail) String

func (x *EventDetail) String() string

FeatureMap

type FeatureMap struct {
	CategoricalFeatures map[string]*FeatureMap_StringList "" /* 206 byte string literal not displayed */

	NumericalFeatures map[string]*FeatureMap_FloatList "" /* 200 byte string literal not displayed */

}

FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.

func (*FeatureMap) Descriptor

func (*FeatureMap) Descriptor() ([]byte, []int)

Deprecated: Use FeatureMap.ProtoReflect.Descriptor instead.

func (*FeatureMap) GetCategoricalFeatures

func (x *FeatureMap) GetCategoricalFeatures() map[string]*FeatureMap_StringList

func (*FeatureMap) GetNumericalFeatures

func (x *FeatureMap) GetNumericalFeatures() map[string]*FeatureMap_FloatList

func (*FeatureMap) ProtoMessage

func (*FeatureMap) ProtoMessage()

func (*FeatureMap) ProtoReflect

func (x *FeatureMap) ProtoReflect() protoreflect.Message

func (*FeatureMap) Reset

func (x *FeatureMap) Reset()

func (*FeatureMap) String

func (x *FeatureMap) String() string

FeatureMap_FloatList

type FeatureMap_FloatList struct {

	// Float feature value.
	Value []float32 `protobuf:"fixed32,1,rep,packed,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A list of float features.

func (*FeatureMap_FloatList) Descriptor

func (*FeatureMap_FloatList) Descriptor() ([]byte, []int)

Deprecated: Use FeatureMap_FloatList.ProtoReflect.Descriptor instead.

func (*FeatureMap_FloatList) GetValue

func (x *FeatureMap_FloatList) GetValue() []float32

func (*FeatureMap_FloatList) ProtoMessage

func (*FeatureMap_FloatList) ProtoMessage()

func (*FeatureMap_FloatList) ProtoReflect

func (x *FeatureMap_FloatList) ProtoReflect() protoreflect.Message

func (*FeatureMap_FloatList) Reset

func (x *FeatureMap_FloatList) Reset()

func (*FeatureMap_FloatList) String

func (x *FeatureMap_FloatList) String() string

FeatureMap_StringList

type FeatureMap_StringList struct {

	// String feature value with a length limit of 128 bytes.
	Value []string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A list of string features.

func (*FeatureMap_StringList) Descriptor

func (*FeatureMap_StringList) Descriptor() ([]byte, []int)

Deprecated: Use FeatureMap_StringList.ProtoReflect.Descriptor instead.

func (*FeatureMap_StringList) GetValue

func (x *FeatureMap_StringList) GetValue() []string

func (*FeatureMap_StringList) ProtoMessage

func (*FeatureMap_StringList) ProtoMessage()

func (*FeatureMap_StringList) ProtoReflect

func (x *FeatureMap_StringList) ProtoReflect() protoreflect.Message

func (*FeatureMap_StringList) Reset

func (x *FeatureMap_StringList) Reset()

func (*FeatureMap_StringList) String

func (x *FeatureMap_StringList) String() string

GcsSource

type GcsSource struct {

	// 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 `protobuf:"bytes,1,rep,name=input_uris,json=inputUris,proto3" json:"input_uris,omitempty"`
	// contains filtered or unexported fields
}

Google Cloud Storage location for input content. format.

func (*GcsSource) Descriptor

func (*GcsSource) Descriptor() ([]byte, []int)

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetInputUris

func (x *GcsSource) GetInputUris() []string

func (*GcsSource) ProtoMessage

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect

func (x *GcsSource) ProtoReflect() protoreflect.Message

func (*GcsSource) Reset

func (x *GcsSource) Reset()

func (*GcsSource) String

func (x *GcsSource) String() string

GetCatalogItemRequest

type GetCatalogItemRequest struct {

	// Required. Full resource name of catalog item, such as
	// `projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetCatalogItem method.

func (*GetCatalogItemRequest) Descriptor

func (*GetCatalogItemRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetCatalogItemRequest.ProtoReflect.Descriptor instead.

func (*GetCatalogItemRequest) GetName

func (x *GetCatalogItemRequest) GetName() string

func (*GetCatalogItemRequest) ProtoMessage

func (*GetCatalogItemRequest) ProtoMessage()

func (*GetCatalogItemRequest) ProtoReflect

func (x *GetCatalogItemRequest) ProtoReflect() protoreflect.Message

func (*GetCatalogItemRequest) Reset

func (x *GetCatalogItemRequest) Reset()

func (*GetCatalogItemRequest) String

func (x *GetCatalogItemRequest) String() string

Image

type Image struct {

	// Required. URL of the image with a length limit of 5 KiB.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Optional. Height of the image in number of pixels.
	Height int32 `protobuf:"varint,2,opt,name=height,proto3" json:"height,omitempty"`
	// Optional. Width of the image in number of pixels.
	Width int32 `protobuf:"varint,3,opt,name=width,proto3" json:"width,omitempty"`
	// contains filtered or unexported fields
}

Catalog item thumbnail/detail image.

func (*Image) Descriptor

func (*Image) Descriptor() ([]byte, []int)

Deprecated: Use Image.ProtoReflect.Descriptor instead.

func (*Image) GetHeight

func (x *Image) GetHeight() int32

func (*Image) GetUri

func (x *Image) GetUri() string

func (*Image) GetWidth

func (x *Image) GetWidth() int32

func (*Image) ProtoMessage

func (*Image) ProtoMessage()

func (*Image) ProtoReflect

func (x *Image) ProtoReflect() protoreflect.Message

func (*Image) Reset

func (x *Image) Reset()

func (*Image) String

func (x *Image) String() string

ImportCatalogItemsRequest

type ImportCatalogItemsRequest struct {

	// Required. `projects/1234/locations/global/catalogs/default_catalog`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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.
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Required. The desired input location of the data.
	InputConfig *InputConfig `protobuf:"bytes,3,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// Optional. The desired location of errors incurred during the Import.
	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,4,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for Import methods.

func (*ImportCatalogItemsRequest) Descriptor

func (*ImportCatalogItemsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportCatalogItemsRequest.ProtoReflect.Descriptor instead.

func (*ImportCatalogItemsRequest) GetErrorsConfig

func (x *ImportCatalogItemsRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportCatalogItemsRequest) GetInputConfig

func (x *ImportCatalogItemsRequest) GetInputConfig() *InputConfig

func (*ImportCatalogItemsRequest) GetParent

func (x *ImportCatalogItemsRequest) GetParent() string

func (*ImportCatalogItemsRequest) GetRequestId

func (x *ImportCatalogItemsRequest) GetRequestId() string

func (*ImportCatalogItemsRequest) ProtoMessage

func (*ImportCatalogItemsRequest) ProtoMessage()

func (*ImportCatalogItemsRequest) ProtoReflect

func (x *ImportCatalogItemsRequest) ProtoReflect() protoreflect.Message

func (*ImportCatalogItemsRequest) Reset

func (x *ImportCatalogItemsRequest) Reset()

func (*ImportCatalogItemsRequest) String

func (x *ImportCatalogItemsRequest) String() string

ImportCatalogItemsResponse

type ImportCatalogItemsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// Echoes the destination for the complete errors in the request if set.
	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,2,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// contains filtered or unexported fields
}

Response of the ImportCatalogItemsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ImportCatalogItemsResponse) Descriptor

func (*ImportCatalogItemsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportCatalogItemsResponse.ProtoReflect.Descriptor instead.

func (*ImportCatalogItemsResponse) GetErrorSamples

func (x *ImportCatalogItemsResponse) GetErrorSamples() []*status.Status

func (*ImportCatalogItemsResponse) GetErrorsConfig

func (x *ImportCatalogItemsResponse) GetErrorsConfig() *ImportErrorsConfig

func (*ImportCatalogItemsResponse) ProtoMessage

func (*ImportCatalogItemsResponse) ProtoMessage()

func (*ImportCatalogItemsResponse) ProtoReflect

func (x *ImportCatalogItemsResponse) ProtoReflect() protoreflect.Message

func (*ImportCatalogItemsResponse) Reset

func (x *ImportCatalogItemsResponse) Reset()

func (*ImportCatalogItemsResponse) String

func (x *ImportCatalogItemsResponse) String() string

ImportErrorsConfig

type ImportErrorsConfig struct {

	// Required. Errors destination.
	//
	// Types that are assignable to Destination:
	//
	//	*ImportErrorsConfig_GcsPrefix
	Destination isImportErrorsConfig_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

Configuration of destination for Import related errors.

func (*ImportErrorsConfig) Descriptor

func (*ImportErrorsConfig) Descriptor() ([]byte, []int)

Deprecated: Use ImportErrorsConfig.ProtoReflect.Descriptor instead.

func (*ImportErrorsConfig) GetDestination

func (m *ImportErrorsConfig) GetDestination() isImportErrorsConfig_Destination

func (*ImportErrorsConfig) GetGcsPrefix

func (x *ImportErrorsConfig) GetGcsPrefix() string

func (*ImportErrorsConfig) ProtoMessage

func (*ImportErrorsConfig) ProtoMessage()

func (*ImportErrorsConfig) ProtoReflect

func (x *ImportErrorsConfig) ProtoReflect() protoreflect.Message

func (*ImportErrorsConfig) Reset

func (x *ImportErrorsConfig) Reset()

func (*ImportErrorsConfig) String

func (x *ImportErrorsConfig) String() string

ImportErrorsConfig_GcsPrefix

type ImportErrorsConfig_GcsPrefix struct {
	// 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.
	GcsPrefix string `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}

ImportMetadata

type ImportMetadata struct {

	// Name of the operation.
	OperationName string `protobuf:"bytes,5,opt,name=operation_name,json=operationName,proto3" json:"operation_name,omitempty"`
	// Id of the request / operation. This is parroting back the requestId that
	// was passed in the request.
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Count of entries that were processed successfully.
	SuccessCount int64 `protobuf:"varint,1,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of entries that encountered errors while processing.
	FailureCount int64 `protobuf:"varint,2,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.

func (*ImportMetadata) Descriptor

func (*ImportMetadata) Descriptor() ([]byte, []int)

Deprecated: Use ImportMetadata.ProtoReflect.Descriptor instead.

func (*ImportMetadata) GetCreateTime

func (x *ImportMetadata) GetCreateTime() *timestamppb.Timestamp

func (*ImportMetadata) GetFailureCount

func (x *ImportMetadata) GetFailureCount() int64

func (*ImportMetadata) GetOperationName

func (x *ImportMetadata) GetOperationName() string

func (*ImportMetadata) GetRequestId

func (x *ImportMetadata) GetRequestId() string

func (*ImportMetadata) GetSuccessCount

func (x *ImportMetadata) GetSuccessCount() int64

func (*ImportMetadata) GetUpdateTime

func (x *ImportMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*ImportMetadata) ProtoMessage

func (*ImportMetadata) ProtoMessage()

func (*ImportMetadata) ProtoReflect

func (x *ImportMetadata) ProtoReflect() protoreflect.Message

func (*ImportMetadata) Reset

func (x *ImportMetadata) Reset()

func (*ImportMetadata) String

func (x *ImportMetadata) String() string

ImportUserEventsRequest

type ImportUserEventsRequest struct {

	// Required.
	// `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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.
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Required. The desired input location of the data.
	InputConfig *InputConfig `protobuf:"bytes,3,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// Optional. The desired location of errors incurred during the Import.
	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,4,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ImportUserEvents request.

func (*ImportUserEventsRequest) Descriptor

func (*ImportUserEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsRequest.ProtoReflect.Descriptor instead.

func (*ImportUserEventsRequest) GetErrorsConfig

func (x *ImportUserEventsRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportUserEventsRequest) GetInputConfig

func (x *ImportUserEventsRequest) GetInputConfig() *InputConfig

func (*ImportUserEventsRequest) GetParent

func (x *ImportUserEventsRequest) GetParent() string

func (*ImportUserEventsRequest) GetRequestId

func (x *ImportUserEventsRequest) GetRequestId() string

func (*ImportUserEventsRequest) ProtoMessage

func (*ImportUserEventsRequest) ProtoMessage()

func (*ImportUserEventsRequest) ProtoReflect

func (x *ImportUserEventsRequest) ProtoReflect() protoreflect.Message

func (*ImportUserEventsRequest) Reset

func (x *ImportUserEventsRequest) Reset()

func (*ImportUserEventsRequest) String

func (x *ImportUserEventsRequest) String() string

ImportUserEventsResponse

type ImportUserEventsResponse struct {

	// A sample of errors encountered while processing the request.
	ErrorSamples []*status.Status `protobuf:"bytes,1,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// Echoes the destination for the complete errors if this field was set in
	// the request.
	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,2,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// Aggregated statistics of user event import status.
	ImportSummary *UserEventImportSummary `protobuf:"bytes,3,opt,name=import_summary,json=importSummary,proto3" json:"import_summary,omitempty"`
	// contains filtered or unexported fields
}

Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.

func (*ImportUserEventsResponse) Descriptor

func (*ImportUserEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportUserEventsResponse.ProtoReflect.Descriptor instead.

func (*ImportUserEventsResponse) GetErrorSamples

func (x *ImportUserEventsResponse) GetErrorSamples() []*status.Status

func (*ImportUserEventsResponse) GetErrorsConfig

func (x *ImportUserEventsResponse) GetErrorsConfig() *ImportErrorsConfig

func (*ImportUserEventsResponse) GetImportSummary

func (x *ImportUserEventsResponse) GetImportSummary() *UserEventImportSummary

func (*ImportUserEventsResponse) ProtoMessage

func (*ImportUserEventsResponse) ProtoMessage()

func (*ImportUserEventsResponse) ProtoReflect

func (x *ImportUserEventsResponse) ProtoReflect() protoreflect.Message

func (*ImportUserEventsResponse) Reset

func (x *ImportUserEventsResponse) Reset()

func (*ImportUserEventsResponse) String

func (x *ImportUserEventsResponse) String() string

InputConfig

type InputConfig struct {

	// Required. The source of the input.
	//
	// Types that are assignable to Source:
	//
	//	*InputConfig_CatalogInlineSource
	//	*InputConfig_GcsSource
	//	*InputConfig_UserEventInlineSource
	Source isInputConfig_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

The input config source.

func (*InputConfig) Descriptor

func (*InputConfig) Descriptor() ([]byte, []int)

Deprecated: Use InputConfig.ProtoReflect.Descriptor instead.

func (*InputConfig) GetCatalogInlineSource

func (x *InputConfig) GetCatalogInlineSource() *CatalogInlineSource

func (*InputConfig) GetGcsSource

func (x *InputConfig) GetGcsSource() *GcsSource

func (*InputConfig) GetSource

func (m *InputConfig) GetSource() isInputConfig_Source

func (*InputConfig) GetUserEventInlineSource

func (x *InputConfig) GetUserEventInlineSource() *UserEventInlineSource

func (*InputConfig) ProtoMessage

func (*InputConfig) ProtoMessage()

func (*InputConfig) ProtoReflect

func (x *InputConfig) ProtoReflect() protoreflect.Message

func (*InputConfig) Reset

func (x *InputConfig) Reset()

func (*InputConfig) String

func (x *InputConfig) String() string

InputConfig_CatalogInlineSource

type InputConfig_CatalogInlineSource struct {
	// The Inline source for the input content for Catalog items.
	CatalogInlineSource *CatalogInlineSource `protobuf:"bytes,1,opt,name=catalog_inline_source,json=catalogInlineSource,proto3,oneof"`
}

InputConfig_GcsSource

type InputConfig_GcsSource struct {
	// Google Cloud Storage location for the input content.
	GcsSource *GcsSource `protobuf:"bytes,2,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

InputConfig_UserEventInlineSource

type InputConfig_UserEventInlineSource struct {
	// The Inline source for the input content for UserEvents.
	UserEventInlineSource *UserEventInlineSource `protobuf:"bytes,3,opt,name=user_event_inline_source,json=userEventInlineSource,proto3,oneof"`
}

ListCatalogItemsRequest

type ListCatalogItemsRequest struct {

	// Required. The parent catalog resource name, such as
	// `projects/*/locations/global/catalogs/default_catalog`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Maximum number of results to return per page. If zero, the
	// service will choose a reasonable default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The previous ListCatalogItemsResponse.next_page_token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter to apply on the list results.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListCatalogItems method.

func (*ListCatalogItemsRequest) Descriptor

func (*ListCatalogItemsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListCatalogItemsRequest.ProtoReflect.Descriptor instead.

func (*ListCatalogItemsRequest) GetFilter

func (x *ListCatalogItemsRequest) GetFilter() string

func (*ListCatalogItemsRequest) GetPageSize

func (x *ListCatalogItemsRequest) GetPageSize() int32

func (*ListCatalogItemsRequest) GetPageToken

func (x *ListCatalogItemsRequest) GetPageToken() string

func (*ListCatalogItemsRequest) GetParent

func (x *ListCatalogItemsRequest) GetParent() string

func (*ListCatalogItemsRequest) ProtoMessage

func (*ListCatalogItemsRequest) ProtoMessage()

func (*ListCatalogItemsRequest) ProtoReflect

func (x *ListCatalogItemsRequest) ProtoReflect() protoreflect.Message

func (*ListCatalogItemsRequest) Reset

func (x *ListCatalogItemsRequest) Reset()

func (*ListCatalogItemsRequest) String

func (x *ListCatalogItemsRequest) String() string

ListCatalogItemsResponse

type ListCatalogItemsResponse struct {

	// The catalog items.
	CatalogItems []*CatalogItem `protobuf:"bytes,1,rep,name=catalog_items,json=catalogItems,proto3" json:"catalog_items,omitempty"`
	// If empty, the list is complete. If nonempty, the token to pass to the next
	// request's ListCatalogItemRequest.page_token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for ListCatalogItems method.

func (*ListCatalogItemsResponse) Descriptor

func (*ListCatalogItemsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListCatalogItemsResponse.ProtoReflect.Descriptor instead.

func (*ListCatalogItemsResponse) GetCatalogItems

func (x *ListCatalogItemsResponse) GetCatalogItems() []*CatalogItem

func (*ListCatalogItemsResponse) GetNextPageToken

func (x *ListCatalogItemsResponse) GetNextPageToken() string

func (*ListCatalogItemsResponse) ProtoMessage

func (*ListCatalogItemsResponse) ProtoMessage()

func (*ListCatalogItemsResponse) ProtoReflect

func (x *ListCatalogItemsResponse) ProtoReflect() protoreflect.Message

func (*ListCatalogItemsResponse) Reset

func (x *ListCatalogItemsResponse) Reset()

func (*ListCatalogItemsResponse) String

func (x *ListCatalogItemsResponse) String() string

ListPredictionApiKeyRegistrationsRequest

type ListPredictionApiKeyRegistrationsRequest struct {

	// Required. The parent placement resource name such as
	// `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Maximum number of results to return per page. If unset, the
	// service will choose a reasonable default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ListPredictionApiKeyRegistrations.

func (*ListPredictionApiKeyRegistrationsRequest) Descriptor

func (*ListPredictionApiKeyRegistrationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListPredictionApiKeyRegistrationsRequest.ProtoReflect.Descriptor instead.

func (*ListPredictionApiKeyRegistrationsRequest) GetPageSize

func (x *ListPredictionApiKeyRegistrationsRequest) GetPageSize() int32

func (*ListPredictionApiKeyRegistrationsRequest) GetPageToken

func (x *ListPredictionApiKeyRegistrationsRequest) GetPageToken() string

func (*ListPredictionApiKeyRegistrationsRequest) GetParent

func (x *ListPredictionApiKeyRegistrationsRequest) GetParent() string

func (*ListPredictionApiKeyRegistrationsRequest) ProtoMessage

func (*ListPredictionApiKeyRegistrationsRequest) ProtoMessage()

func (*ListPredictionApiKeyRegistrationsRequest) ProtoReflect

func (x *ListPredictionApiKeyRegistrationsRequest) ProtoReflect() protoreflect.Message

func (*ListPredictionApiKeyRegistrationsRequest) Reset

func (x *ListPredictionApiKeyRegistrationsRequest) Reset()

func (*ListPredictionApiKeyRegistrationsRequest) String

func (x *ListPredictionApiKeyRegistrationsRequest) String() string

ListPredictionApiKeyRegistrationsResponse

type ListPredictionApiKeyRegistrationsResponse struct {
	PredictionApiKeyRegistrations []*PredictionApiKeyRegistration "" /* 152 byte string literal not displayed */

	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`

}

Response message for the ListPredictionApiKeyRegistrations.

func (*ListPredictionApiKeyRegistrationsResponse) Descriptor

func (*ListPredictionApiKeyRegistrationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListPredictionApiKeyRegistrationsResponse.ProtoReflect.Descriptor instead.

func (*ListPredictionApiKeyRegistrationsResponse) GetNextPageToken

func (x *ListPredictionApiKeyRegistrationsResponse) GetNextPageToken() string

func (*ListPredictionApiKeyRegistrationsResponse) GetPredictionApiKeyRegistrations

func (x *ListPredictionApiKeyRegistrationsResponse) GetPredictionApiKeyRegistrations() []*PredictionApiKeyRegistration

func (*ListPredictionApiKeyRegistrationsResponse) ProtoMessage

func (*ListPredictionApiKeyRegistrationsResponse) ProtoMessage()

func (*ListPredictionApiKeyRegistrationsResponse) ProtoReflect

func (x *ListPredictionApiKeyRegistrationsResponse) ProtoReflect() protoreflect.Message

func (*ListPredictionApiKeyRegistrationsResponse) Reset

func (x *ListPredictionApiKeyRegistrationsResponse) Reset()

func (*ListPredictionApiKeyRegistrationsResponse) String

func (x *ListPredictionApiKeyRegistrationsResponse) String() string

ListUserEventsRequest

type ListUserEventsRequest struct {

	// Required. The parent eventStore resource name, such as
	// `projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Maximum number of results to return per page. If zero, the
	// service will choose a reasonable default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The previous ListUserEventsResponse.next_page_token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filtering expression to specify restrictions over
	// returned events. This is a sequence of terms, where each term applies some
	// kind of a restriction to the returned user events. Use this expression to
	// restrict results to a specific time range, or filter events 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="" be="" specified="" a="" maximum="" of="" 2="" times,="" once="" with="" a="" less="" than="" operator="" and="" once="" with="" a="" greater="" than="" operator.="" the="" eventtime="" restrict="" should="" result="" in="" one="" contiguous="" valid="" eventtime="" range.="" *="" eventtype:="" only="" 1="" eventtype="" restriction="" can="" be="" specified.="" *="" eventsmissingcatalogitems:="" specififying="" this="" will="" restrict="" results="" to="" events="" for="" which="" catalog="" items="" were="" not="" found="" in="" the="" catalog.="" the="" default="" behavior="" is="" to="" return="" only="" those="" events="" for="" which="" catalog="" 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
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListUserEvents method.

func (*ListUserEventsRequest) Descriptor

func (*ListUserEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListUserEventsRequest.ProtoReflect.Descriptor instead.

func (*ListUserEventsRequest) GetFilter

func (x *ListUserEventsRequest) GetFilter() string

func (*ListUserEventsRequest) GetPageSize

func (x *ListUserEventsRequest) GetPageSize() int32

func (*ListUserEventsRequest) GetPageToken

func (x *ListUserEventsRequest) GetPageToken() string

func (*ListUserEventsRequest) GetParent

func (x *ListUserEventsRequest) GetParent() string

func (*ListUserEventsRequest) ProtoMessage

func (*ListUserEventsRequest) ProtoMessage()

func (*ListUserEventsRequest) ProtoReflect

func (x *ListUserEventsRequest) ProtoReflect() protoreflect.Message

func (*ListUserEventsRequest) Reset

func (x *ListUserEventsRequest) Reset()

func (*ListUserEventsRequest) String

func (x *ListUserEventsRequest) String() string

ListUserEventsResponse

type ListUserEventsResponse struct {

	// The user events.
	UserEvents []*UserEvent `protobuf:"bytes,1,rep,name=user_events,json=userEvents,proto3" json:"user_events,omitempty"`
	// If empty, the list is complete. If nonempty, the token to pass to the next
	// request's ListUserEvents.page_token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for ListUserEvents method.

func (*ListUserEventsResponse) Descriptor

func (*ListUserEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListUserEventsResponse.ProtoReflect.Descriptor instead.

func (*ListUserEventsResponse) GetNextPageToken

func (x *ListUserEventsResponse) GetNextPageToken() string

func (*ListUserEventsResponse) GetUserEvents

func (x *ListUserEventsResponse) GetUserEvents() []*UserEvent

func (*ListUserEventsResponse) ProtoMessage

func (*ListUserEventsResponse) ProtoMessage()

func (*ListUserEventsResponse) ProtoReflect

func (x *ListUserEventsResponse) ProtoReflect() protoreflect.Message

func (*ListUserEventsResponse) Reset

func (x *ListUserEventsResponse) Reset()

func (*ListUserEventsResponse) String

func (x *ListUserEventsResponse) String() string

PredictRequest

type PredictRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`

	PageSize int32 `protobuf:"varint,7,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`

	PageToken string `protobuf:"bytes,8,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`

	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`

	DryRun bool `protobuf:"varint,4,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`

	Params map[string]*structpb.Value "" /* 153 byte string literal not displayed */

	Labels map[string]string "" /* 153 byte string literal not displayed */

}

Request message for Predict method.

func (*PredictRequest) Descriptor

func (*PredictRequest) Descriptor() ([]byte, []int)

Deprecated: Use PredictRequest.ProtoReflect.Descriptor instead.

func (*PredictRequest) GetDryRun

func (x *PredictRequest) GetDryRun() bool

func (*PredictRequest) GetFilter

func (x *PredictRequest) GetFilter() string

func (*PredictRequest) GetLabels

func (x *PredictRequest) GetLabels() map[string]string

func (*PredictRequest) GetName

func (x *PredictRequest) GetName() string

func (*PredictRequest) GetPageSize

func (x *PredictRequest) GetPageSize() int32

func (*PredictRequest) GetPageToken

func (x *PredictRequest) GetPageToken() string

func (*PredictRequest) GetParams

func (x *PredictRequest) GetParams() map[string]*structpb.Value

func (*PredictRequest) GetUserEvent

func (x *PredictRequest) GetUserEvent() *UserEvent

func (*PredictRequest) ProtoMessage

func (*PredictRequest) ProtoMessage()

func (*PredictRequest) ProtoReflect

func (x *PredictRequest) ProtoReflect() protoreflect.Message

func (*PredictRequest) Reset

func (x *PredictRequest) Reset()

func (*PredictRequest) String

func (x *PredictRequest) String() string

PredictResponse

type PredictResponse struct {
	Results []*PredictResponse_PredictionResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`

	RecommendationToken string `protobuf:"bytes,2,opt,name=recommendation_token,json=recommendationToken,proto3" json:"recommendation_token,omitempty"`

	ItemsMissingInCatalog []string "" /* 128 byte string literal not displayed */

	DryRun bool `protobuf:"varint,4,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`

	Metadata map[string]*structpb.Value "" /* 157 byte string literal not displayed */

	NextPageToken string `protobuf:"bytes,6,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`

}

Response message for predict method.

func (*PredictResponse) Descriptor

func (*PredictResponse) Descriptor() ([]byte, []int)

Deprecated: Use PredictResponse.ProtoReflect.Descriptor instead.

func (*PredictResponse) GetDryRun

func (x *PredictResponse) GetDryRun() bool

func (*PredictResponse) GetItemsMissingInCatalog

func (x *PredictResponse) GetItemsMissingInCatalog() []string

func (*PredictResponse) GetMetadata

func (x *PredictResponse) GetMetadata() map[string]*structpb.Value

func (*PredictResponse) GetNextPageToken

func (x *PredictResponse) GetNextPageToken() string

func (*PredictResponse) GetRecommendationToken

func (x *PredictResponse) GetRecommendationToken() string

func (*PredictResponse) GetResults

func (x *PredictResponse) GetResults() []*PredictResponse_PredictionResult

func (*PredictResponse) ProtoMessage

func (*PredictResponse) ProtoMessage()

func (*PredictResponse) ProtoReflect

func (x *PredictResponse) ProtoReflect() protoreflect.Message

func (*PredictResponse) Reset

func (x *PredictResponse) Reset()

func (*PredictResponse) String

func (x *PredictResponse) String() string

PredictResponse_PredictionResult

type PredictResponse_PredictionResult struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`

	ItemMetadata map[string]*structpb.Value "" /* 185 byte string literal not displayed */

}

PredictionResult represents the recommendation prediction results.

func (*PredictResponse_PredictionResult) Descriptor

func (*PredictResponse_PredictionResult) Descriptor() ([]byte, []int)

Deprecated: Use PredictResponse_PredictionResult.ProtoReflect.Descriptor instead.

func (*PredictResponse_PredictionResult) GetId

func (x *PredictResponse_PredictionResult) GetId() string

func (*PredictResponse_PredictionResult) GetItemMetadata

func (x *PredictResponse_PredictionResult) GetItemMetadata() map[string]*structpb.Value

func (*PredictResponse_PredictionResult) ProtoMessage

func (*PredictResponse_PredictionResult) ProtoMessage()

func (*PredictResponse_PredictionResult) ProtoReflect

func (x *PredictResponse_PredictionResult) ProtoReflect() protoreflect.Message

func (*PredictResponse_PredictionResult) Reset

func (x *PredictResponse_PredictionResult) Reset()

func (*PredictResponse_PredictionResult) String

func (x *PredictResponse_PredictionResult) String() string

PredictionApiKeyRegistration

type PredictionApiKeyRegistration struct {

	// The API key.
	ApiKey string `protobuf:"bytes,1,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"`
	// contains filtered or unexported fields
}

Registered Api Key.

func (*PredictionApiKeyRegistration) Descriptor

func (*PredictionApiKeyRegistration) Descriptor() ([]byte, []int)

Deprecated: Use PredictionApiKeyRegistration.ProtoReflect.Descriptor instead.

func (*PredictionApiKeyRegistration) GetApiKey

func (x *PredictionApiKeyRegistration) GetApiKey() string

func (*PredictionApiKeyRegistration) ProtoMessage

func (*PredictionApiKeyRegistration) ProtoMessage()

func (*PredictionApiKeyRegistration) ProtoReflect

func (x *PredictionApiKeyRegistration) ProtoReflect() protoreflect.Message

func (*PredictionApiKeyRegistration) Reset

func (x *PredictionApiKeyRegistration) Reset()

func (*PredictionApiKeyRegistration) String

func (x *PredictionApiKeyRegistration) String() string

PredictionApiKeyRegistryClient

type PredictionApiKeyRegistryClient interface {
	// Register an API key for use with predict method.
	CreatePredictionApiKeyRegistration(ctx context.Context, in *CreatePredictionApiKeyRegistrationRequest, opts ...grpc.CallOption) (*PredictionApiKeyRegistration, error)
	// List the registered apiKeys for use with predict method.
	ListPredictionApiKeyRegistrations(ctx context.Context, in *ListPredictionApiKeyRegistrationsRequest, opts ...grpc.CallOption) (*ListPredictionApiKeyRegistrationsResponse, error)
	// Unregister an apiKey from using for predict method.
	DeletePredictionApiKeyRegistration(ctx context.Context, in *DeletePredictionApiKeyRegistrationRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

PredictionApiKeyRegistryClient is the client API for PredictionApiKeyRegistry service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewPredictionApiKeyRegistryClient

func NewPredictionApiKeyRegistryClient(cc grpc.ClientConnInterface) PredictionApiKeyRegistryClient

PredictionApiKeyRegistryServer

type PredictionApiKeyRegistryServer interface {
	// Register an API key for use with predict method.
	CreatePredictionApiKeyRegistration(context.Context, *CreatePredictionApiKeyRegistrationRequest) (*PredictionApiKeyRegistration, error)
	// List the registered apiKeys for use with predict method.
	ListPredictionApiKeyRegistrations(context.Context, *ListPredictionApiKeyRegistrationsRequest) (*ListPredictionApiKeyRegistrationsResponse, error)
	// Unregister an apiKey from using for predict method.
	DeletePredictionApiKeyRegistration(context.Context, *DeletePredictionApiKeyRegistrationRequest) (*emptypb.Empty, error)
}

PredictionApiKeyRegistryServer is the server API for PredictionApiKeyRegistry service.

PredictionServiceClient

type PredictionServiceClient interface {
	// Makes a recommendation prediction. If using API Key based authentication,
	// the API Key must be registered using the
	// [PredictionApiKeyRegistry][google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry]
	// service. [Learn more](/recommendations-ai/docs/setting-up#register-key).
	Predict(ctx context.Context, in *PredictRequest, opts ...grpc.CallOption) (*PredictResponse, error)
}

PredictionServiceClient is the client API for PredictionService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewPredictionServiceClient

func NewPredictionServiceClient(cc grpc.ClientConnInterface) PredictionServiceClient

PredictionServiceServer

type PredictionServiceServer interface {
	// Makes a recommendation prediction. If using API Key based authentication,
	// the API Key must be registered using the
	// [PredictionApiKeyRegistry][google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry]
	// service. [Learn more](/recommendations-ai/docs/setting-up#register-key).
	Predict(context.Context, *PredictRequest) (*PredictResponse, error)
}

PredictionServiceServer is the server API for PredictionService service.

ProductCatalogItem

type ProductCatalogItem struct {
	Price isProductCatalogItem_Price `protobuf_oneof:"price"`

	Costs map[string]float32 "" /* 153 byte string literal not displayed */

	CurrencyCode string `protobuf:"bytes,4,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`

	StockState ProductCatalogItem_StockState "" /* 169 byte string literal not displayed */

	AvailableQuantity int64 `protobuf:"varint,6,opt,name=available_quantity,json=availableQuantity,proto3" json:"available_quantity,omitempty"`

	CanonicalProductUri string `protobuf:"bytes,7,opt,name=canonical_product_uri,json=canonicalProductUri,proto3" json:"canonical_product_uri,omitempty"`

	Images []*Image `protobuf:"bytes,8,rep,name=images,proto3" json:"images,omitempty"`

}

ProductCatalogItem captures item metadata specific to retail products.

func (*ProductCatalogItem) Descriptor

func (*ProductCatalogItem) Descriptor() ([]byte, []int)

Deprecated: Use ProductCatalogItem.ProtoReflect.Descriptor instead.

func (*ProductCatalogItem) GetAvailableQuantity

func (x *ProductCatalogItem) GetAvailableQuantity() int64

func (*ProductCatalogItem) GetCanonicalProductUri

func (x *ProductCatalogItem) GetCanonicalProductUri() string

func (*ProductCatalogItem) GetCosts

func (x *ProductCatalogItem) GetCosts() map[string]float32

func (*ProductCatalogItem) GetCurrencyCode

func (x *ProductCatalogItem) GetCurrencyCode() string

func (*ProductCatalogItem) GetExactPrice

func (x *ProductCatalogItem) GetExactPrice() *ProductCatalogItem_ExactPrice

func (*ProductCatalogItem) GetImages

func (x *ProductCatalogItem) GetImages() []*Image

func (*ProductCatalogItem) GetPrice

func (m *ProductCatalogItem) GetPrice() isProductCatalogItem_Price

func (*ProductCatalogItem) GetPriceRange

func (x *ProductCatalogItem) GetPriceRange() *ProductCatalogItem_PriceRange

func (*ProductCatalogItem) GetStockState

func (x *ProductCatalogItem) GetStockState() ProductCatalogItem_StockState

func (*ProductCatalogItem) ProtoMessage

func (*ProductCatalogItem) ProtoMessage()

func (*ProductCatalogItem) ProtoReflect

func (x *ProductCatalogItem) ProtoReflect() protoreflect.Message

func (*ProductCatalogItem) Reset

func (x *ProductCatalogItem) Reset()

func (*ProductCatalogItem) String

func (x *ProductCatalogItem) String() string

ProductCatalogItem_ExactPrice

type ProductCatalogItem_ExactPrice struct {

	// Optional. Display price of the product.
	DisplayPrice float32 `protobuf:"fixed32,1,opt,name=display_price,json=displayPrice,proto3" json:"display_price,omitempty"`
	// Optional. Price of the product without any discount. If zero, by default
	// set to be the 'displayPrice'.
	OriginalPrice float32 `protobuf:"fixed32,2,opt,name=original_price,json=originalPrice,proto3" json:"original_price,omitempty"`
	// contains filtered or unexported fields
}

Exact product price.

func (*ProductCatalogItem_ExactPrice) Descriptor

func (*ProductCatalogItem_ExactPrice) Descriptor() ([]byte, []int)

Deprecated: Use ProductCatalogItem_ExactPrice.ProtoReflect.Descriptor instead.

func (*ProductCatalogItem_ExactPrice) GetDisplayPrice

func (x *