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
Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.
func (*GcsSource) GetInputUris
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
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
Deprecated: Use Image.ProtoReflect.Descriptor instead.
func (*Image) GetHeight
func (*Image) GetUri
func (*Image) GetWidth
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
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 *ProductCatalogItem_ExactPrice) GetDisplayPrice() float32
func (*ProductCatalogItem_ExactPrice) GetOriginalPrice
func (x *ProductCatalogItem_ExactPrice) GetOriginalPrice() float32
func (*ProductCatalogItem_ExactPrice) ProtoMessage
func (*ProductCatalogItem_ExactPrice) ProtoMessage()
func (*ProductCatalogItem_ExactPrice) ProtoReflect
func (x *ProductCatalogItem_ExactPrice) ProtoReflect() protoreflect.Message
func (*ProductCatalogItem_ExactPrice) Reset
func (x *ProductCatalogItem_ExactPrice) Reset()
func (*ProductCatalogItem_ExactPrice) String
func (x *ProductCatalogItem_ExactPrice) String() string
ProductCatalogItem_ExactPrice_
type ProductCatalogItem_ExactPrice_ struct {
// Optional. The exact product price.
ExactPrice *ProductCatalogItem_ExactPrice `protobuf:"bytes,1,opt,name=exact_price,json=exactPrice,proto3,oneof"`
}
ProductCatalogItem_PriceRange
type ProductCatalogItem_PriceRange struct {
// Required. The minimum product price.
Min float32 `protobuf:"fixed32,1,opt,name=min,proto3" json:"min,omitempty"`
// Required. The maximum product price.
Max float32 `protobuf:"fixed32,2,opt,name=max,proto3" json:"max,omitempty"`
// contains filtered or unexported fields
}
Product price range when there are a range of prices for different variations of the same product.
func (*ProductCatalogItem_PriceRange) Descriptor
func (*ProductCatalogItem_PriceRange) Descriptor() ([]byte, []int)
Deprecated: Use ProductCatalogItem_PriceRange.ProtoReflect.Descriptor instead.
func (*ProductCatalogItem_PriceRange) GetMax
func (x *ProductCatalogItem_PriceRange) GetMax() float32
func (*ProductCatalogItem_PriceRange) GetMin
func (x *ProductCatalogItem_PriceRange) GetMin() float32
func (*ProductCatalogItem_PriceRange) ProtoMessage
func (*ProductCatalogItem_PriceRange) ProtoMessage()
func (*ProductCatalogItem_PriceRange) ProtoReflect
func (x *ProductCatalogItem_PriceRange) ProtoReflect() protoreflect.Message
func (*ProductCatalogItem_PriceRange) Reset
func (x *ProductCatalogItem_PriceRange) Reset()
func (*ProductCatalogItem_PriceRange) String
func (x *ProductCatalogItem_PriceRange) String() string
ProductCatalogItem_PriceRange_
type ProductCatalogItem_PriceRange_ struct {
// Optional. The product price range.
PriceRange *ProductCatalogItem_PriceRange `protobuf:"bytes,2,opt,name=price_range,json=priceRange,proto3,oneof"`
}
ProductCatalogItem_StockState
type ProductCatalogItem_StockState int32
Item stock state. If this field is unspecified, the item is assumed to be in stock.
ProductCatalogItem_STOCK_STATE_UNSPECIFIED, ProductCatalogItem_IN_STOCK, ProductCatalogItem_OUT_OF_STOCK, ProductCatalogItem_PREORDER, ProductCatalogItem_BACKORDER
const (
// Default item stock status. Should never be used.
ProductCatalogItem_STOCK_STATE_UNSPECIFIED ProductCatalogItem_StockState = 0
// Item in stock.
ProductCatalogItem_IN_STOCK ProductCatalogItem_StockState = 0
// Item out of stock.
ProductCatalogItem_OUT_OF_STOCK ProductCatalogItem_StockState = 1
// Item that is in pre-order state.
ProductCatalogItem_PREORDER ProductCatalogItem_StockState = 2
// Item that is back-ordered (i.e. temporarily out of stock).
ProductCatalogItem_BACKORDER ProductCatalogItem_StockState = 3
)
func (ProductCatalogItem_StockState) Descriptor
func (ProductCatalogItem_StockState) Descriptor() protoreflect.EnumDescriptor
func (ProductCatalogItem_StockState) Enum
func (x ProductCatalogItem_StockState) Enum() *ProductCatalogItem_StockState
func (ProductCatalogItem_StockState) EnumDescriptor
func (ProductCatalogItem_StockState) EnumDescriptor() ([]byte, []int)
Deprecated: Use ProductCatalogItem_StockState.Descriptor instead.
func (ProductCatalogItem_StockState) Number
func (x ProductCatalogItem_StockState) Number() protoreflect.EnumNumber
func (ProductCatalogItem_StockState) String
func (x ProductCatalogItem_StockState) String() string
func (ProductCatalogItem_StockState) Type
func (ProductCatalogItem_StockState) Type() protoreflect.EnumType
ProductDetail
type ProductDetail struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
CurrencyCode string `protobuf:"bytes,2,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
OriginalPrice float32 `protobuf:"fixed32,3,opt,name=original_price,json=originalPrice,proto3" json:"original_price,omitempty"`
DisplayPrice float32 `protobuf:"fixed32,4,opt,name=display_price,json=displayPrice,proto3" json:"display_price,omitempty"`
StockState ProductCatalogItem_StockState "" /* 169 byte string literal not displayed */
Quantity int32 `protobuf:"varint,6,opt,name=quantity,proto3" json:"quantity,omitempty"`
AvailableQuantity int32 `protobuf:"varint,7,opt,name=available_quantity,json=availableQuantity,proto3" json:"available_quantity,omitempty"`
ItemAttributes *FeatureMap `protobuf:"bytes,8,opt,name=item_attributes,json=itemAttributes,proto3" json:"item_attributes,omitempty"`
}
Detailed product information associated with a user event.
func (*ProductDetail) Descriptor
func (*ProductDetail) Descriptor() ([]byte, []int)
Deprecated: Use ProductDetail.ProtoReflect.Descriptor instead.
func (*ProductDetail) GetAvailableQuantity
func (x *ProductDetail) GetAvailableQuantity() int32
func (*ProductDetail) GetCurrencyCode
func (x *ProductDetail) GetCurrencyCode() string
func (*ProductDetail) GetDisplayPrice
func (x *ProductDetail) GetDisplayPrice() float32
func (*ProductDetail) GetId
func (x *ProductDetail) GetId() string
func (*ProductDetail) GetItemAttributes
func (x *ProductDetail) GetItemAttributes() *FeatureMap
func (*ProductDetail) GetOriginalPrice
func (x *ProductDetail) GetOriginalPrice() float32
func (*ProductDetail) GetQuantity
func (x *ProductDetail) GetQuantity() int32
func (*ProductDetail) GetStockState
func (x *ProductDetail) GetStockState() ProductCatalogItem_StockState
func (*ProductDetail) ProtoMessage
func (*ProductDetail) ProtoMessage()
func (*ProductDetail) ProtoReflect
func (x *ProductDetail) ProtoReflect() protoreflect.Message
func (*ProductDetail) Reset
func (x *ProductDetail) Reset()
func (*ProductDetail) String
func (x *ProductDetail) String() string
ProductEventDetail
type ProductEventDetail struct {
// 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.
SearchQuery string `protobuf:"bytes,1,opt,name=search_query,json=searchQuery,proto3" json:"search_query,omitempty"`
// Required for `category-page-view` 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 []*CatalogItem_CategoryHierarchy `protobuf:"bytes,2,rep,name=page_categories,json=pageCategories,proto3" json:"page_categories,omitempty"`
// 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.
//
// This field is not allowed for the following event types:
//
// * `category-page-view`
// * `home-page-view`
// * `search`
ProductDetails []*ProductDetail `protobuf:"bytes,3,rep,name=product_details,json=productDetails,proto3" json:"product_details,omitempty"`
// 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.
ListId string `protobuf:"bytes,4,opt,name=list_id,json=listId,proto3" json:"list_id,omitempty"`
// 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.
CartId string `protobuf:"bytes,5,opt,name=cart_id,json=cartId,proto3" json:"cart_id,omitempty"`
// 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 *PurchaseTransaction `protobuf:"bytes,6,opt,name=purchase_transaction,json=purchaseTransaction,proto3" json:"purchase_transaction,omitempty"`
// contains filtered or unexported fields
}
ProductEventDetail captures user event information specific to retail products.
func (*ProductEventDetail) Descriptor
func (*ProductEventDetail) Descriptor() ([]byte, []int)
Deprecated: Use ProductEventDetail.ProtoReflect.Descriptor instead.
func (*ProductEventDetail) GetCartId
func (x *ProductEventDetail) GetCartId() string
func (*ProductEventDetail) GetListId
func (x *ProductEventDetail) GetListId() string
func (*ProductEventDetail) GetPageCategories
func (x *ProductEventDetail) GetPageCategories() []*CatalogItem_CategoryHierarchy
func (*ProductEventDetail) GetProductDetails
func (x *ProductEventDetail) GetProductDetails() []*ProductDetail
func (*ProductEventDetail) GetPurchaseTransaction
func (x *ProductEventDetail) GetPurchaseTransaction() *PurchaseTransaction
func (*ProductEventDetail) GetSearchQuery
func (x *ProductEventDetail) GetSearchQuery() string
func (*ProductEventDetail) ProtoMessage
func (*ProductEventDetail) ProtoMessage()
func (*ProductEventDetail) ProtoReflect
func (x *ProductEventDetail) ProtoReflect() protoreflect.Message
func (*ProductEventDetail) Reset
func (x *ProductEventDetail) Reset()
func (*ProductEventDetail) String
func (x *ProductEventDetail) String() string
PurchaseTransaction
type PurchaseTransaction struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
Revenue float32 `protobuf:"fixed32,2,opt,name=revenue,proto3" json:"revenue,omitempty"`
Taxes map[string]float32 "" /* 153 byte string literal not displayed */
Costs map[string]float32 "" /* 153 byte string literal not displayed */
CurrencyCode string `protobuf:"bytes,6,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
}
A transaction represents the entire purchase transaction.
func (*PurchaseTransaction) Descriptor
func (*PurchaseTransaction) Descriptor() ([]byte, []int)
Deprecated: Use PurchaseTransaction.ProtoReflect.Descriptor instead.
func (*PurchaseTransaction) GetCosts
func (x *PurchaseTransaction) GetCosts() map[string]float32
func (*PurchaseTransaction) GetCurrencyCode
func (x *PurchaseTransaction) GetCurrencyCode() string
func (*PurchaseTransaction) GetId
func (x *PurchaseTransaction) GetId() string
func (*PurchaseTransaction) GetRevenue
func (x *PurchaseTransaction) GetRevenue() float32
func (*PurchaseTransaction) GetTaxes
func (x *PurchaseTransaction) GetTaxes() map[string]float32
func (*PurchaseTransaction) ProtoMessage
func (*PurchaseTransaction) ProtoMessage()
func (*PurchaseTransaction) ProtoReflect
func (x *PurchaseTransaction) ProtoReflect() protoreflect.Message
func (*PurchaseTransaction) Reset
func (x *PurchaseTransaction) Reset()
func (*PurchaseTransaction) String
func (x *PurchaseTransaction) String() string
PurgeUserEventsMetadata
type PurgeUserEventsMetadata struct {
// The ID of the request / operation.
OperationName string `protobuf:"bytes,1,opt,name=operation_name,json=operationName,proto3" json:"operation_name,omitempty"`
// Operation create time.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}
Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.
func (*PurgeUserEventsMetadata) Descriptor
func (*PurgeUserEventsMetadata) Descriptor() ([]byte, []int)
Deprecated: Use PurgeUserEventsMetadata.ProtoReflect.Descriptor instead.
func (*PurgeUserEventsMetadata) GetCreateTime
func (x *PurgeUserEventsMetadata) GetCreateTime() *timestamppb.Timestamp
func (*PurgeUserEventsMetadata) GetOperationName
func (x *PurgeUserEventsMetadata) GetOperationName() string
func (*PurgeUserEventsMetadata) ProtoMessage
func (*PurgeUserEventsMetadata) ProtoMessage()
func (*PurgeUserEventsMetadata) ProtoReflect
func (x *PurgeUserEventsMetadata) ProtoReflect() protoreflect.Message
func (*PurgeUserEventsMetadata) Reset
func (x *PurgeUserEventsMetadata) Reset()
func (*PurgeUserEventsMetadata) String
func (x *PurgeUserEventsMetadata) String() string
PurgeUserEventsRequest
type PurgeUserEventsRequest struct {
// Required. The resource name of the event_store under which the events are
// created. The format is
// `projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The filter string to specify the events to be deleted. Empty
// string filter is not allowed. This filter can also be used with
// ListUserEvents API to list events that will be deleted. 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.
// Example 1: Deleting all events in a time range.
// `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23t18:30:43.511z"`="" example="" 2:="" deleting="" specific="" eventtype="" in="" time="" range.="" `eventtime=""> "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
// Example 3: Deleting all events for a specific visitor
// `visitorId = visitor1024`
// The filtering fields are assumed to have an implicit AND.
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// 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.
Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}
Request message for PurgeUserEvents method.
func (*PurgeUserEventsRequest) Descriptor
func (*PurgeUserEventsRequest) Descriptor() ([]byte, []int)
Deprecated: Use PurgeUserEventsRequest.ProtoReflect.Descriptor instead.
func (*PurgeUserEventsRequest) GetFilter
func (x *PurgeUserEventsRequest) GetFilter() string
func (*PurgeUserEventsRequest) GetForce
func (x *PurgeUserEventsRequest) GetForce() bool
func (*PurgeUserEventsRequest) GetParent
func (x *PurgeUserEventsRequest) GetParent() string
func (*PurgeUserEventsRequest) ProtoMessage
func (*PurgeUserEventsRequest) ProtoMessage()
func (*PurgeUserEventsRequest) ProtoReflect
func (x *PurgeUserEventsRequest) ProtoReflect() protoreflect.Message
func (*PurgeUserEventsRequest) Reset
func (x *PurgeUserEventsRequest) Reset()
func (*PurgeUserEventsRequest) String
func (x *PurgeUserEventsRequest) String() string
PurgeUserEventsResponse
type PurgeUserEventsResponse struct {
// The total count of events purged as a result of the operation.
PurgedEventsCount int64 `protobuf:"varint,1,opt,name=purged_events_count,json=purgedEventsCount,proto3" json:"purged_events_count,omitempty"`
// 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 []*UserEvent `protobuf:"bytes,2,rep,name=user_events_sample,json=userEventsSample,proto3" json:"user_events_sample,omitempty"`
// contains filtered or unexported fields
}
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
func (*PurgeUserEventsResponse) Descriptor
func (*PurgeUserEventsResponse) Descriptor() ([]byte, []int)
Deprecated: Use PurgeUserEventsResponse.ProtoReflect.Descriptor instead.
func (*PurgeUserEventsResponse) GetPurgedEventsCount
func (x *PurgeUserEventsResponse) GetPurgedEventsCount() int64
func (*PurgeUserEventsResponse) GetUserEventsSample
func (x *PurgeUserEventsResponse) GetUserEventsSample() []*UserEvent
func (*PurgeUserEventsResponse) ProtoMessage
func (*PurgeUserEventsResponse) ProtoMessage()
func (*PurgeUserEventsResponse) ProtoReflect
func (x *PurgeUserEventsResponse) ProtoReflect() protoreflect.Message
func (*PurgeUserEventsResponse) Reset
func (x *PurgeUserEventsResponse) Reset()
func (*PurgeUserEventsResponse) String
func (x *PurgeUserEventsResponse) String() string
UnimplementedCatalogServiceServer
type UnimplementedCatalogServiceServer struct {
}
UnimplementedCatalogServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedCatalogServiceServer) CreateCatalogItem
func (*UnimplementedCatalogServiceServer) CreateCatalogItem(context.Context, *CreateCatalogItemRequest) (*CatalogItem, error)
func (*UnimplementedCatalogServiceServer) DeleteCatalogItem
func (*UnimplementedCatalogServiceServer) DeleteCatalogItem(context.Context, *DeleteCatalogItemRequest) (*emptypb.Empty, error)
func (*UnimplementedCatalogServiceServer) GetCatalogItem
func (*UnimplementedCatalogServiceServer) GetCatalogItem(context.Context, *GetCatalogItemRequest) (*CatalogItem, error)
func (*UnimplementedCatalogServiceServer) ImportCatalogItems
func (*UnimplementedCatalogServiceServer) ImportCatalogItems(context.Context, *ImportCatalogItemsRequest) (*longrunning.Operation, error)
func (*UnimplementedCatalogServiceServer) ListCatalogItems
func (*UnimplementedCatalogServiceServer) ListCatalogItems(context.Context, *ListCatalogItemsRequest) (*ListCatalogItemsResponse, error)
func (*UnimplementedCatalogServiceServer) UpdateCatalogItem
func (*UnimplementedCatalogServiceServer) UpdateCatalogItem(context.Context, *UpdateCatalogItemRequest) (*CatalogItem, error)
UnimplementedPredictionApiKeyRegistryServer
type UnimplementedPredictionApiKeyRegistryServer struct {
}
UnimplementedPredictionApiKeyRegistryServer can be embedded to have forward compatible implementations.
func (*UnimplementedPredictionApiKeyRegistryServer) CreatePredictionApiKeyRegistration
func (*UnimplementedPredictionApiKeyRegistryServer) CreatePredictionApiKeyRegistration(context.Context, *CreatePredictionApiKeyRegistrationRequest) (*PredictionApiKeyRegistration, error)
func (*UnimplementedPredictionApiKeyRegistryServer) DeletePredictionApiKeyRegistration
func (*UnimplementedPredictionApiKeyRegistryServer) DeletePredictionApiKeyRegistration(context.Context, *DeletePredictionApiKeyRegistrationRequest) (*emptypb.Empty, error)
func (*UnimplementedPredictionApiKeyRegistryServer) ListPredictionApiKeyRegistrations
func (*UnimplementedPredictionApiKeyRegistryServer) ListPredictionApiKeyRegistrations(context.Context, *ListPredictionApiKeyRegistrationsRequest) (*ListPredictionApiKeyRegistrationsResponse, error)
UnimplementedPredictionServiceServer
type UnimplementedPredictionServiceServer struct {
}
UnimplementedPredictionServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedPredictionServiceServer) Predict
func (*UnimplementedPredictionServiceServer) Predict(context.Context, *PredictRequest) (*PredictResponse, error)
UnimplementedUserEventServiceServer
type UnimplementedUserEventServiceServer struct {
}
UnimplementedUserEventServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedUserEventServiceServer) CollectUserEvent
func (*UnimplementedUserEventServiceServer) CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)
func (*UnimplementedUserEventServiceServer) ImportUserEvents
func (*UnimplementedUserEventServiceServer) ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunning.Operation, error)
func (*UnimplementedUserEventServiceServer) ListUserEvents
func (*UnimplementedUserEventServiceServer) ListUserEvents(context.Context, *ListUserEventsRequest) (*ListUserEventsResponse, error)
func (*UnimplementedUserEventServiceServer) PurgeUserEvents
func (*UnimplementedUserEventServiceServer) PurgeUserEvents(context.Context, *PurgeUserEventsRequest) (*longrunning.Operation, error)
func (*UnimplementedUserEventServiceServer) WriteUserEvent
func (*UnimplementedUserEventServiceServer) WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)
UpdateCatalogItemRequest
type UpdateCatalogItemRequest 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"`
// Required. The catalog item to update/create. The 'catalog_item_id' field
// has to match that in the 'name'.
CatalogItem *CatalogItem `protobuf:"bytes,2,opt,name=catalog_item,json=catalogItem,proto3" json:"catalog_item,omitempty"`
// Optional. Indicates which fields in the provided 'item' to update. If not
// set, will by default update all fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
Request message for UpdateCatalogItem method.
func (*UpdateCatalogItemRequest) Descriptor
func (*UpdateCatalogItemRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateCatalogItemRequest.ProtoReflect.Descriptor instead.
func (*UpdateCatalogItemRequest) GetCatalogItem
func (x *UpdateCatalogItemRequest) GetCatalogItem() *CatalogItem
func (*UpdateCatalogItemRequest) GetName
func (x *UpdateCatalogItemRequest) GetName() string
func (*UpdateCatalogItemRequest) GetUpdateMask
func (x *UpdateCatalogItemRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateCatalogItemRequest) ProtoMessage
func (*UpdateCatalogItemRequest) ProtoMessage()
func (*UpdateCatalogItemRequest) ProtoReflect
func (x *UpdateCatalogItemRequest) ProtoReflect() protoreflect.Message
func (*UpdateCatalogItemRequest) Reset
func (x *UpdateCatalogItemRequest) Reset()
func (*UpdateCatalogItemRequest) String
func (x *UpdateCatalogItemRequest) String() string
UserEvent
type UserEvent struct {
EventType string `protobuf:"bytes,1,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
UserInfo *UserInfo `protobuf:"bytes,2,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
EventDetail *EventDetail `protobuf:"bytes,3,opt,name=event_detail,json=eventDetail,proto3" json:"event_detail,omitempty"`
ProductEventDetail *ProductEventDetail `protobuf:"bytes,4,opt,name=product_event_detail,json=productEventDetail,proto3" json:"product_event_detail,omitempty"`
EventTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
EventSource UserEvent_EventSource "" /* 164 byte string literal not displayed */
}
UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.
func (*UserEvent) Descriptor
Deprecated: Use UserEvent.ProtoReflect.Descriptor instead.
func (*UserEvent) GetEventDetail
func (x *UserEvent) GetEventDetail() *EventDetail
func (*UserEvent) GetEventSource
func (x *UserEvent) GetEventSource() UserEvent_EventSource
func (*UserEvent) GetEventTime
func (x *UserEvent) GetEventTime() *timestamppb.Timestamp
func (*UserEvent) GetEventType
func (*UserEvent) GetProductEventDetail
func (x *UserEvent) GetProductEventDetail() *ProductEventDetail
func (*UserEvent) GetUserInfo
func (*UserEvent) ProtoMessage
func (*UserEvent) ProtoMessage()
func (*UserEvent) ProtoReflect
func (x *UserEvent) ProtoReflect() protoreflect.Message
func (*UserEvent) Reset
func (x *UserEvent) Reset()
func (*UserEvent) String
UserEventImportSummary
type UserEventImportSummary struct {
// Count of user events imported with complete existing catalog information.
JoinedEventsCount int64 `protobuf:"varint,1,opt,name=joined_events_count,json=joinedEventsCount,proto3" json:"joined_events_count,omitempty"`
// Count of user events imported, but with catalog information not found
// in the imported catalog.
UnjoinedEventsCount int64 `protobuf:"varint,2,opt,name=unjoined_events_count,json=unjoinedEventsCount,proto3" json:"unjoined_events_count,omitempty"`
// contains filtered or unexported fields
}
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
func (*UserEventImportSummary) Descriptor
func (*UserEventImportSummary) Descriptor() ([]byte, []int)
Deprecated: Use UserEventImportSummary.ProtoReflect.Descriptor instead.
func (*UserEventImportSummary) GetJoinedEventsCount
func (x *UserEventImportSummary) GetJoinedEventsCount() int64
func (*UserEventImportSummary) GetUnjoinedEventsCount
func (x *UserEventImportSummary) GetUnjoinedEventsCount() int64
func (*UserEventImportSummary) ProtoMessage
func (*UserEventImportSummary) ProtoMessage()
func (*UserEventImportSummary) ProtoReflect
func (x *UserEventImportSummary) ProtoReflect() protoreflect.Message
func (*UserEventImportSummary) Reset
func (x *UserEventImportSummary) Reset()
func (*UserEventImportSummary) String
func (x *UserEventImportSummary) String() string
UserEventInlineSource
type UserEventInlineSource struct {
// Optional. A list of user events to import. Recommended max of 10k items.
UserEvents []*UserEvent `protobuf:"bytes,1,rep,name=user_events,json=userEvents,proto3" json:"user_events,omitempty"`
// contains filtered or unexported fields
}
The inline source for the input config for ImportUserEvents method.
func (*UserEventInlineSource) Descriptor
func (*UserEventInlineSource) Descriptor() ([]byte, []int)
Deprecated: Use UserEventInlineSource.ProtoReflect.Descriptor instead.
func (*UserEventInlineSource) GetUserEvents
func (x *UserEventInlineSource) GetUserEvents() []*UserEvent
func (*UserEventInlineSource) ProtoMessage
func (*UserEventInlineSource) ProtoMessage()
func (*UserEventInlineSource) ProtoReflect
func (x *UserEventInlineSource) ProtoReflect() protoreflect.Message
func (*UserEventInlineSource) Reset
func (x *UserEventInlineSource) Reset()
func (*UserEventInlineSource) String
func (x *UserEventInlineSource) String() string
UserEventServiceClient
type UserEventServiceClient interface {
// Writes a single user event.
WriteUserEvent(ctx context.Context, in *WriteUserEventRequest, opts ...grpc.CallOption) (*UserEvent, error)
// Writes a single user event from the browser. This uses a GET request to
// due to browser restriction of POST-ing to a 3rd party domain.
//
// This method is used only by the Recommendations AI JavaScript pixel.
// Users should not call this method directly.
CollectUserEvent(ctx context.Context, in *CollectUserEventRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, error)
// Gets a list of user events within a time range, with potential filtering.
ListUserEvents(ctx context.Context, in *ListUserEventsRequest, opts ...grpc.CallOption) (*ListUserEventsResponse, error)
// Deletes permanently all user events specified by the filter provided.
// Depending on the number of events specified by the filter, this operation
// could take hours or days to complete. To test a filter, use the list
// command first.
PurgeUserEvents(ctx context.Context, in *PurgeUserEventsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Bulk import of User events. Request processing might be
// synchronous. Events that already exist are skipped.
// Use this method for backfilling historical user events.
//
// Operation.response is of type ImportResponse. Note that it is
// possible for a subset of the items to be successfully inserted.
// Operation.metadata is of type ImportMetadata.
ImportUserEvents(ctx context.Context, in *ImportUserEventsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}
UserEventServiceClient is the client API for UserEventService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewUserEventServiceClient
func NewUserEventServiceClient(cc grpc.ClientConnInterface) UserEventServiceClient
UserEventServiceServer
type UserEventServiceServer interface {
// Writes a single user event.
WriteUserEvent(context.Context, *WriteUserEventRequest) (*UserEvent, error)
// Writes a single user event from the browser. This uses a GET request to
// due to browser restriction of POST-ing to a 3rd party domain.
//
// This method is used only by the Recommendations AI JavaScript pixel.
// Users should not call this method directly.
CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, error)
// Gets a list of user events within a time range, with potential filtering.
ListUserEvents(context.Context, *ListUserEventsRequest) (*ListUserEventsResponse, error)
// Deletes permanently all user events specified by the filter provided.
// Depending on the number of events specified by the filter, this operation
// could take hours or days to complete. To test a filter, use the list
// command first.
PurgeUserEvents(context.Context, *PurgeUserEventsRequest) (*longrunning.Operation, error)
// Bulk import of User events. Request processing might be
// synchronous. Events that already exist are skipped.
// Use this method for backfilling historical user events.
//
// Operation.response is of type ImportResponse. Note that it is
// possible for a subset of the items to be successfully inserted.
// Operation.metadata is of type ImportMetadata.
ImportUserEvents(context.Context, *ImportUserEventsRequest) (*longrunning.Operation, error)
}
UserEventServiceServer is the server API for UserEventService service.
UserEvent_EventSource
type UserEvent_EventSource int32
User event source.
UserEvent_EVENT_SOURCE_UNSPECIFIED, UserEvent_AUTOML, UserEvent_ECOMMERCE, UserEvent_BATCH_UPLOAD
const (
// Unspecified event source.
UserEvent_EVENT_SOURCE_UNSPECIFIED UserEvent_EventSource = 0
// The event is ingested via a javascript pixel or Recommendations AI Tag
// through automl datalayer or JS Macros.
UserEvent_AUTOML UserEvent_EventSource = 1
// The event is ingested via Recommendations AI Tag through Enhanced
// Ecommerce datalayer.
UserEvent_ECOMMERCE UserEvent_EventSource = 2
// The event is ingested via Import user events API.
UserEvent_BATCH_UPLOAD UserEvent_EventSource = 3
)
func (UserEvent_EventSource) Descriptor
func (UserEvent_EventSource) Descriptor() protoreflect.EnumDescriptor
func (UserEvent_EventSource) Enum
func (x UserEvent_EventSource) Enum() *UserEvent_EventSource
func (UserEvent_EventSource) EnumDescriptor
func (UserEvent_EventSource) EnumDescriptor() ([]byte, []int)
Deprecated: Use UserEvent_EventSource.Descriptor instead.
func (UserEvent_EventSource) Number
func (x UserEvent_EventSource) Number() protoreflect.EnumNumber
func (UserEvent_EventSource) String
func (x UserEvent_EventSource) String() string
func (UserEvent_EventSource) Type
func (UserEvent_EventSource) Type() protoreflect.EnumType
UserInfo
type UserInfo struct {
// Required. A unique identifier for tracking visitors with a length limit of
// 128 bytes.
//
// For example, this could be implemented with a http cookie, which should be
// able to uniquely identify a visitor on a single device. This unique
// identifier should not change if the visitor log in/out of the website.
// Maximum length 128 bytes. Cannot be empty.
VisitorId string `protobuf:"bytes,1,opt,name=visitor_id,json=visitorId,proto3" json:"visitor_id,omitempty"`
// Optional. Unique identifier for logged-in user with a length limit of 128
// bytes. Required only for logged-in users.
UserId string `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
// 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.
IpAddress string `protobuf:"bytes,3,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`
// 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.
UserAgent string `protobuf:"bytes,4,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
// 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).
DirectUserRequest bool `protobuf:"varint,5,opt,name=direct_user_request,json=directUserRequest,proto3" json:"direct_user_request,omitempty"`
// contains filtered or unexported fields
}
Information of end users.
func (*UserInfo) Descriptor
Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.
func (*UserInfo) GetDirectUserRequest
func (*UserInfo) GetIpAddress
func (*UserInfo) GetUserAgent
func (*UserInfo) GetUserId
func (*UserInfo) GetVisitorId
func (*UserInfo) ProtoMessage
func (*UserInfo) ProtoMessage()
func (*UserInfo) ProtoReflect
func (x *UserInfo) ProtoReflect() protoreflect.Message
func (*UserInfo) Reset
func (x *UserInfo) Reset()
func (*UserInfo) String
WriteUserEventRequest
type WriteUserEventRequest struct {
// Required. The parent eventStore 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"`
// Required. User event to write.
UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
// contains filtered or unexported fields
}
Request message for WriteUserEvent method.
func (*WriteUserEventRequest) Descriptor
func (*WriteUserEventRequest) Descriptor() ([]byte, []int)
Deprecated: Use WriteUserEventRequest.ProtoReflect.Descriptor instead.
func (*WriteUserEventRequest) GetParent
func (x *WriteUserEventRequest) GetParent() string
func (*WriteUserEventRequest) GetUserEvent
func (x *WriteUserEventRequest) GetUserEvent() *UserEvent
func (*WriteUserEventRequest) ProtoMessage
func (*WriteUserEventRequest) ProtoMessage()
func (*WriteUserEventRequest) ProtoReflect
func (x *WriteUserEventRequest) ProtoReflect() protoreflect.Message
func (*WriteUserEventRequest) Reset
func (x *WriteUserEventRequest) Reset()
func (*WriteUserEventRequest) String
func (x *WriteUserEventRequest) String() string