Documentation

Index

Constants

This section is empty.

Variables

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

	1: "OUT_OF_STOCK",
	2: "PREORDER",
	3: "BACKORDER",
}
View Source
var ProductCatalogItem_StockState_value = map[string]int32{
	"STOCK_STATE_UNSPECIFIED": 0,
	"IN_STOCK":                0,
	"OUT_OF_STOCK":            1,
	"PREORDER":                2,
	"BACKORDER":               3,
}
View Source
var UserEvent_EventSource_name = map[int32]string{
	0: "EVENT_SOURCE_UNSPECIFIED",
	1: "AUTOML",
	2: "ECOMMERCE",
	3: "BATCH_UPLOAD",
}
View Source
var UserEvent_EventSource_value = map[string]int32{
	"EVENT_SOURCE_UNSPECIFIED": 0,
	"AUTOML":                   1,
	"ECOMMERCE":                2,
	"BATCH_UPLOAD":             3,
}

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)

Types

type 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"`
	XXX_NoUnkeyedLiteral struct{}       `json:"-"`
	XXX_unrecognized     []byte         `json:"-"`
	XXX_sizecache        int32          `json:"-"`
}

The inline source for the input config for ImportCatalogItems method.

func (*CatalogInlineSource) Descriptor

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

func (*CatalogInlineSource) GetCatalogItems

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

func (*CatalogInlineSource) ProtoMessage

func (*CatalogInlineSource) ProtoMessage()

func (*CatalogInlineSource) Reset

func (m *CatalogInlineSource) Reset()

func (*CatalogInlineSource) String

func (m *CatalogInlineSource) String() string

func (*CatalogInlineSource) XXX_DiscardUnknown

func (m *CatalogInlineSource) XXX_DiscardUnknown()

func (*CatalogInlineSource) XXX_Marshal

func (m *CatalogInlineSource) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CatalogInlineSource) XXX_Merge

func (m *CatalogInlineSource) XXX_Merge(src proto.Message)

func (*CatalogInlineSource) XXX_Size

func (m *CatalogInlineSource) XXX_Size() int

func (*CatalogInlineSource) XXX_Unmarshal

func (m *CatalogInlineSource) XXX_Unmarshal(b []byte) error

type 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 valid to be assigned to RecommendationType:
	//	*CatalogItem_ProductMetadata
	RecommendationType   isCatalogItem_RecommendationType `protobuf_oneof:"recommendation_type"`
	XXX_NoUnkeyedLiteral struct{}                         `json:"-"`
	XXX_unrecognized     []byte                           `json:"-"`
	XXX_sizecache        int32                            `json:"-"`
}

CatalogItem captures all metadata information of items to be recommended.

func (*CatalogItem) Descriptor

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

func (*CatalogItem) GetCategoryHierarchies

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

func (*CatalogItem) GetDescription

func (m *CatalogItem) GetDescription() string

func (*CatalogItem) GetId

func (m *CatalogItem) GetId() string

func (*CatalogItem) GetItemAttributes

func (m *CatalogItem) GetItemAttributes() *FeatureMap

func (*CatalogItem) GetItemGroupId

func (m *CatalogItem) GetItemGroupId() string

func (*CatalogItem) GetLanguageCode

func (m *CatalogItem) GetLanguageCode() string

func (*CatalogItem) GetProductMetadata

func (m *CatalogItem) GetProductMetadata() *ProductCatalogItem

func (*CatalogItem) GetRecommendationType

func (m *CatalogItem) GetRecommendationType() isCatalogItem_RecommendationType

func (*CatalogItem) GetTags

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

func (*CatalogItem) GetTitle

func (m *CatalogItem) GetTitle() string

func (*CatalogItem) ProtoMessage

func (*CatalogItem) ProtoMessage()

func (*CatalogItem) Reset

func (m *CatalogItem) Reset()

func (*CatalogItem) String

func (m *CatalogItem) String() string

func (*CatalogItem) XXX_DiscardUnknown

func (m *CatalogItem) XXX_DiscardUnknown()

func (*CatalogItem) XXX_Marshal

func (m *CatalogItem) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CatalogItem) XXX_Merge

func (m *CatalogItem) XXX_Merge(src proto.Message)

func (*CatalogItem) XXX_OneofWrappers

func (*CatalogItem) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*CatalogItem) XXX_Size

func (m *CatalogItem) XXX_Size() int

func (*CatalogItem) XXX_Unmarshal

func (m *CatalogItem) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Category represents catalog item category hierarchy.

func (*CatalogItem_CategoryHierarchy) Descriptor

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

func (*CatalogItem_CategoryHierarchy) GetCategories

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

func (*CatalogItem_CategoryHierarchy) ProtoMessage

func (*CatalogItem_CategoryHierarchy) ProtoMessage()

func (*CatalogItem_CategoryHierarchy) Reset

func (m *CatalogItem_CategoryHierarchy) Reset()

func (*CatalogItem_CategoryHierarchy) String

func (*CatalogItem_CategoryHierarchy) XXX_DiscardUnknown

func (m *CatalogItem_CategoryHierarchy) XXX_DiscardUnknown()

func (*CatalogItem_CategoryHierarchy) XXX_Marshal

func (m *CatalogItem_CategoryHierarchy) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CatalogItem_CategoryHierarchy) XXX_Merge

func (m *CatalogItem_CategoryHierarchy) XXX_Merge(src proto.Message)

func (*CatalogItem_CategoryHierarchy) XXX_Size

func (m *CatalogItem_CategoryHierarchy) XXX_Size() int

func (*CatalogItem_CategoryHierarchy) XXX_Unmarshal

func (m *CatalogItem_CategoryHierarchy) XXX_Unmarshal(b []byte) error

type CatalogItem_ProductMetadata

type CatalogItem_ProductMetadata struct {
	ProductMetadata *ProductCatalogItem `protobuf:"bytes,10,opt,name=product_metadata,json=productMetadata,proto3,oneof"`
}

type 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) (*empty.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.

type 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) (*empty.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.

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request message for CollectUserEvent method.

func (*CollectUserEventRequest) Descriptor

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

func (*CollectUserEventRequest) GetEts

func (m *CollectUserEventRequest) GetEts() int64

func (*CollectUserEventRequest) GetParent

func (m *CollectUserEventRequest) GetParent() string

func (*CollectUserEventRequest) GetUri

func (m *CollectUserEventRequest) GetUri() string

func (*CollectUserEventRequest) GetUserEvent

func (m *CollectUserEventRequest) GetUserEvent() string

func (*CollectUserEventRequest) ProtoMessage

func (*CollectUserEventRequest) ProtoMessage()

func (*CollectUserEventRequest) Reset

func (m *CollectUserEventRequest) Reset()

func (*CollectUserEventRequest) String

func (m *CollectUserEventRequest) String() string

func (*CollectUserEventRequest) XXX_DiscardUnknown

func (m *CollectUserEventRequest) XXX_DiscardUnknown()

func (*CollectUserEventRequest) XXX_Marshal

func (m *CollectUserEventRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CollectUserEventRequest) XXX_Merge

func (m *CollectUserEventRequest) XXX_Merge(src proto.Message)

func (*CollectUserEventRequest) XXX_Size

func (m *CollectUserEventRequest) XXX_Size() int

func (*CollectUserEventRequest) XXX_Unmarshal

func (m *CollectUserEventRequest) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

Request message for CreateCatalogItem method.

func (*CreateCatalogItemRequest) Descriptor

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

func (*CreateCatalogItemRequest) GetCatalogItem

func (m *CreateCatalogItemRequest) GetCatalogItem() *CatalogItem

func (*CreateCatalogItemRequest) GetParent

func (m *CreateCatalogItemRequest) GetParent() string

func (*CreateCatalogItemRequest) ProtoMessage

func (*CreateCatalogItemRequest) ProtoMessage()

func (*CreateCatalogItemRequest) Reset

func (m *CreateCatalogItemRequest) Reset()

func (*CreateCatalogItemRequest) String

func (m *CreateCatalogItemRequest) String() string

func (*CreateCatalogItemRequest) XXX_DiscardUnknown

func (m *CreateCatalogItemRequest) XXX_DiscardUnknown()

func (*CreateCatalogItemRequest) XXX_Marshal

func (m *CreateCatalogItemRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateCatalogItemRequest) XXX_Merge

func (m *CreateCatalogItemRequest) XXX_Merge(src proto.Message)

func (*CreateCatalogItemRequest) XXX_Size

func (m *CreateCatalogItemRequest) XXX_Size() int

func (*CreateCatalogItemRequest) XXX_Unmarshal

func (m *CreateCatalogItemRequest) XXX_Unmarshal(b []byte) error

type CreatePredictionApiKeyRegistrationRequest

type CreatePredictionApiKeyRegistrationRequest struct {
	// Required. The parent resource path.
	// "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store".
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The prediction API key registration.
	PredictionApiKeyRegistration *PredictionApiKeyRegistration "" /* 149 byte string literal not displayed */
	XXX_NoUnkeyedLiteral         struct{}                      `json:"-"`
	XXX_unrecognized             []byte                        `json:"-"`
	XXX_sizecache                int32                         `json:"-"`
}

Request message for the `CreatePredictionApiKeyRegistration` method.

func (*CreatePredictionApiKeyRegistrationRequest) Descriptor

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

func (*CreatePredictionApiKeyRegistrationRequest) GetParent

func (*CreatePredictionApiKeyRegistrationRequest) GetPredictionApiKeyRegistration

func (m *CreatePredictionApiKeyRegistrationRequest) GetPredictionApiKeyRegistration() *PredictionApiKeyRegistration

func (*CreatePredictionApiKeyRegistrationRequest) ProtoMessage

func (*CreatePredictionApiKeyRegistrationRequest) Reset

func (*CreatePredictionApiKeyRegistrationRequest) String

func (*CreatePredictionApiKeyRegistrationRequest) XXX_DiscardUnknown

func (m *CreatePredictionApiKeyRegistrationRequest) XXX_DiscardUnknown()

func (*CreatePredictionApiKeyRegistrationRequest) XXX_Marshal

func (m *CreatePredictionApiKeyRegistrationRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreatePredictionApiKeyRegistrationRequest) XXX_Merge

func (*CreatePredictionApiKeyRegistrationRequest) XXX_Size

func (*CreatePredictionApiKeyRegistrationRequest) XXX_Unmarshal

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request message for DeleteCatalogItem method.

func (*DeleteCatalogItemRequest) Descriptor

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

func (*DeleteCatalogItemRequest) GetName

func (m *DeleteCatalogItemRequest) GetName() string

func (*DeleteCatalogItemRequest) ProtoMessage

func (*DeleteCatalogItemRequest) ProtoMessage()

func (*DeleteCatalogItemRequest) Reset

func (m *DeleteCatalogItemRequest) Reset()

func (*DeleteCatalogItemRequest) String

func (m *DeleteCatalogItemRequest) String() string

func (*DeleteCatalogItemRequest) XXX_DiscardUnknown

func (m *DeleteCatalogItemRequest) XXX_DiscardUnknown()

func (*DeleteCatalogItemRequest) XXX_Marshal

func (m *DeleteCatalogItemRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteCatalogItemRequest) XXX_Merge

func (m *DeleteCatalogItemRequest) XXX_Merge(src proto.Message)

func (*DeleteCatalogItemRequest) XXX_Size

func (m *DeleteCatalogItemRequest) XXX_Size() int

func (*DeleteCatalogItemRequest) XXX_Unmarshal

func (m *DeleteCatalogItemRequest) XXX_Unmarshal(b []byte) error

type 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/<YOUR_API_KEY>"
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request message for `DeletePredictionApiKeyRegistration` method.

func (*DeletePredictionApiKeyRegistrationRequest) Descriptor

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

func (*DeletePredictionApiKeyRegistrationRequest) GetName

func (*DeletePredictionApiKeyRegistrationRequest) ProtoMessage

func (*DeletePredictionApiKeyRegistrationRequest) Reset

func (*DeletePredictionApiKeyRegistrationRequest) String

func (*DeletePredictionApiKeyRegistrationRequest) XXX_DiscardUnknown

func (m *DeletePredictionApiKeyRegistrationRequest) XXX_DiscardUnknown()

func (*DeletePredictionApiKeyRegistrationRequest) XXX_Marshal

func (m *DeletePredictionApiKeyRegistrationRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeletePredictionApiKeyRegistrationRequest) XXX_Merge

func (*DeletePredictionApiKeyRegistrationRequest) XXX_Size

func (*DeletePredictionApiKeyRegistrationRequest) XXX_Unmarshal

type 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"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

User event details shared by all recommendation types.

func (*EventDetail) Descriptor

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

func (*EventDetail) GetEventAttributes

func (m *EventDetail) GetEventAttributes() *FeatureMap

func (*EventDetail) GetExperimentIds

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

func (*EventDetail) GetPageViewId

func (m *EventDetail) GetPageViewId() string

func (*EventDetail) GetRecommendationToken

func (m *EventDetail) GetRecommendationToken() string

func (*EventDetail) GetReferrerUri

func (m *EventDetail) GetReferrerUri() string

func (*EventDetail) GetUri

func (m *EventDetail) GetUri() string

func (*EventDetail) ProtoMessage

func (*EventDetail) ProtoMessage()

func (*EventDetail) Reset

func (m *EventDetail) Reset()

func (*EventDetail) String

func (m *EventDetail) String() string

func (*EventDetail) XXX_DiscardUnknown

func (m *EventDetail) XXX_DiscardUnknown()

func (*EventDetail) XXX_Marshal

func (m *EventDetail) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*EventDetail) XXX_Merge

func (m *EventDetail) XXX_Merge(src proto.Message)

func (*EventDetail) XXX_Size

func (m *EventDetail) XXX_Size() int

func (*EventDetail) XXX_Unmarshal

func (m *EventDetail) XXX_Unmarshal(b []byte) error

type FeatureMap

type FeatureMap struct {
	// Categorical features that can take on one of a limited number of possible
	// values. Some examples would be the brand/maker of a product, or country of
	// a customer.
	//
	// Feature names and values must be UTF-8 encoded strings.
	//
	// For example: `{ "colors": {"value": ["yellow", "green"]},
	//                 "sizes": {"value":["S", "M"]}`
	CategoricalFeatures map[string]*FeatureMap_StringList "" /* 206 byte string literal not displayed */
	// Numerical features. Some examples would be the height/weight of a product,
	// or age of a customer.
	//
	// Feature names must be UTF-8 encoded strings.
	//
	// For example: `{ "lengths_cm": {"value":[2.3, 15.4]},
	//                 "heights_cm": {"value":[8.1, 6.4]} }`
	NumericalFeatures    map[string]*FeatureMap_FloatList "" /* 200 byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}                         `json:"-"`
	XXX_unrecognized     []byte                           `json:"-"`
	XXX_sizecache        int32                            `json:"-"`
}

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)

func (*FeatureMap) GetCategoricalFeatures

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

func (*FeatureMap) GetNumericalFeatures

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

func (*FeatureMap) ProtoMessage

func (*FeatureMap) ProtoMessage()

func (*FeatureMap) Reset

func (m *FeatureMap) Reset()

func (*FeatureMap) String

func (m *FeatureMap) String() string

func (*FeatureMap) XXX_DiscardUnknown

func (m *FeatureMap) XXX_DiscardUnknown()

func (*FeatureMap) XXX_Marshal

func (m *FeatureMap) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*FeatureMap) XXX_Merge

func (m *FeatureMap) XXX_Merge(src proto.Message)

func (*FeatureMap) XXX_Size

func (m *FeatureMap) XXX_Size() int

func (*FeatureMap) XXX_Unmarshal

func (m *FeatureMap) XXX_Unmarshal(b []byte) error

type FeatureMap_FloatList

type FeatureMap_FloatList struct {
	// Float feature value.
	Value                []float32 `protobuf:"fixed32,1,rep,packed,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

A list of float features.

func (*FeatureMap_FloatList) Descriptor

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

func (*FeatureMap_FloatList) GetValue

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

func (*FeatureMap_FloatList) ProtoMessage

func (*FeatureMap_FloatList) ProtoMessage()

func (*FeatureMap_FloatList) Reset

func (m *FeatureMap_FloatList) Reset()

func (*FeatureMap_FloatList) String

func (m *FeatureMap_FloatList) String() string

func (*FeatureMap_FloatList) XXX_DiscardUnknown

func (m *FeatureMap_FloatList) XXX_DiscardUnknown()

func (*FeatureMap_FloatList) XXX_Marshal

func (m *FeatureMap_FloatList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*FeatureMap_FloatList) XXX_Merge

func (m *FeatureMap_FloatList) XXX_Merge(src proto.Message)

func (*FeatureMap_FloatList) XXX_Size

func (m *FeatureMap_FloatList) XXX_Size() int

func (*FeatureMap_FloatList) XXX_Unmarshal

func (m *FeatureMap_FloatList) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A list of string features.

func (*FeatureMap_StringList) Descriptor

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

func (*FeatureMap_StringList) GetValue

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

func (*FeatureMap_StringList) ProtoMessage

func (*FeatureMap_StringList) ProtoMessage()

func (*FeatureMap_StringList) Reset

func (m *FeatureMap_StringList) Reset()

func (*FeatureMap_StringList) String

func (m *FeatureMap_StringList) String() string

func (*FeatureMap_StringList) XXX_DiscardUnknown

func (m *FeatureMap_StringList) XXX_DiscardUnknown()

func (*FeatureMap_StringList) XXX_Marshal

func (m *FeatureMap_StringList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*FeatureMap_StringList) XXX_Merge

func (m *FeatureMap_StringList) XXX_Merge(src proto.Message)

func (*FeatureMap_StringList) XXX_Size

func (m *FeatureMap_StringList) XXX_Size() int

func (*FeatureMap_StringList) XXX_Unmarshal

func (m *FeatureMap_StringList) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Google Cloud Storage location for input content. format.

func (*GcsSource) Descriptor

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

func (*GcsSource) GetInputUris

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

func (*GcsSource) ProtoMessage

func (*GcsSource) ProtoMessage()

func (*GcsSource) Reset

func (m *GcsSource) Reset()

func (*GcsSource) String

func (m *GcsSource) String() string

func (*GcsSource) XXX_DiscardUnknown

func (m *GcsSource) XXX_DiscardUnknown()

func (*GcsSource) XXX_Marshal

func (m *GcsSource) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GcsSource) XXX_Merge

func (m *GcsSource) XXX_Merge(src proto.Message)

func (*GcsSource) XXX_Size

func (m *GcsSource) XXX_Size() int

func (*GcsSource) XXX_Unmarshal

func (m *GcsSource) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request message for GetCatalogItem method.

func (*GetCatalogItemRequest) Descriptor

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

func (*GetCatalogItemRequest) GetName

func (m *GetCatalogItemRequest) GetName() string

func (*GetCatalogItemRequest) ProtoMessage

func (*GetCatalogItemRequest) ProtoMessage()

func (*GetCatalogItemRequest) Reset

func (m *GetCatalogItemRequest) Reset()

func (*GetCatalogItemRequest) String

func (m *GetCatalogItemRequest) String() string

func (*GetCatalogItemRequest) XXX_DiscardUnknown

func (m *GetCatalogItemRequest) XXX_DiscardUnknown()

func (*GetCatalogItemRequest) XXX_Marshal

func (m *GetCatalogItemRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetCatalogItemRequest) XXX_Merge

func (m *GetCatalogItemRequest) XXX_Merge(src proto.Message)

func (*GetCatalogItemRequest) XXX_Size

func (m *GetCatalogItemRequest) XXX_Size() int

func (*GetCatalogItemRequest) XXX_Unmarshal

func (m *GetCatalogItemRequest) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Catalog item thumbnail/detail image.

func (*Image) Descriptor

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

func (*Image) GetHeight

func (m *Image) GetHeight() int32

func (*Image) GetUri

func (m *Image) GetUri() string

func (*Image) GetWidth

func (m *Image) GetWidth() int32

func (*Image) ProtoMessage

func (*Image) ProtoMessage()

func (*Image) Reset

func (m *Image) Reset()

func (*Image) String

func (m *Image) String() string

func (*Image) XXX_DiscardUnknown

func (m *Image) XXX_DiscardUnknown()

func (*Image) XXX_Marshal

func (m *Image) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Image) XXX_Merge

func (m *Image) XXX_Merge(src proto.Message)

func (*Image) XXX_Size

func (m *Image) XXX_Size() int

func (*Image) XXX_Unmarshal

func (m *Image) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

Request message for Import methods.

func (*ImportCatalogItemsRequest) Descriptor

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

func (*ImportCatalogItemsRequest) GetErrorsConfig

func (m *ImportCatalogItemsRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportCatalogItemsRequest) GetInputConfig

func (m *ImportCatalogItemsRequest) GetInputConfig() *InputConfig

func (*ImportCatalogItemsRequest) GetParent

func (m *ImportCatalogItemsRequest) GetParent() string

func (*ImportCatalogItemsRequest) GetRequestId

func (m *ImportCatalogItemsRequest) GetRequestId() string

func (*ImportCatalogItemsRequest) ProtoMessage

func (*ImportCatalogItemsRequest) ProtoMessage()

func (*ImportCatalogItemsRequest) Reset

func (m *ImportCatalogItemsRequest) Reset()

func (*ImportCatalogItemsRequest) String

func (m *ImportCatalogItemsRequest) String() string

func (*ImportCatalogItemsRequest) XXX_DiscardUnknown

func (m *ImportCatalogItemsRequest) XXX_DiscardUnknown()

func (*ImportCatalogItemsRequest) XXX_Marshal

func (m *ImportCatalogItemsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ImportCatalogItemsRequest) XXX_Merge

func (m *ImportCatalogItemsRequest) XXX_Merge(src proto.Message)

func (*ImportCatalogItemsRequest) XXX_Size

func (m *ImportCatalogItemsRequest) XXX_Size() int

func (*ImportCatalogItemsRequest) XXX_Unmarshal

func (m *ImportCatalogItemsRequest) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

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)

func (*ImportCatalogItemsResponse) GetErrorSamples

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

func (*ImportCatalogItemsResponse) GetErrorsConfig

func (m *ImportCatalogItemsResponse) GetErrorsConfig() *ImportErrorsConfig

func (*ImportCatalogItemsResponse) ProtoMessage

func (*ImportCatalogItemsResponse) ProtoMessage()

func (*ImportCatalogItemsResponse) Reset

func (m *ImportCatalogItemsResponse) Reset()

func (*ImportCatalogItemsResponse) String

func (m *ImportCatalogItemsResponse) String() string

func (*ImportCatalogItemsResponse) XXX_DiscardUnknown

func (m *ImportCatalogItemsResponse) XXX_DiscardUnknown()

func (*ImportCatalogItemsResponse) XXX_Marshal

func (m *ImportCatalogItemsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ImportCatalogItemsResponse) XXX_Merge

func (m *ImportCatalogItemsResponse) XXX_Merge(src proto.Message)

func (*ImportCatalogItemsResponse) XXX_Size

func (m *ImportCatalogItemsResponse) XXX_Size() int

func (*ImportCatalogItemsResponse) XXX_Unmarshal

func (m *ImportCatalogItemsResponse) XXX_Unmarshal(b []byte) error

type ImportErrorsConfig

type ImportErrorsConfig struct {
	// Required. Errors destination.
	//
	// Types that are valid to be assigned to Destination:
	//	*ImportErrorsConfig_GcsPrefix
	Destination          isImportErrorsConfig_Destination `protobuf_oneof:"destination"`
	XXX_NoUnkeyedLiteral struct{}                         `json:"-"`
	XXX_unrecognized     []byte                           `json:"-"`
	XXX_sizecache        int32                            `json:"-"`
}

Configuration of destination for Import related errors.

func (*ImportErrorsConfig) Descriptor

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

func (*ImportErrorsConfig) GetDestination

func (m *ImportErrorsConfig) GetDestination() isImportErrorsConfig_Destination

func (*ImportErrorsConfig) GetGcsPrefix

func (m *ImportErrorsConfig) GetGcsPrefix() string

func (*ImportErrorsConfig) ProtoMessage

func (*ImportErrorsConfig) ProtoMessage()

func (*ImportErrorsConfig) Reset

func (m *ImportErrorsConfig) Reset()

func (*ImportErrorsConfig) String

func (m *ImportErrorsConfig) String() string

func (*ImportErrorsConfig) XXX_DiscardUnknown

func (m *ImportErrorsConfig) XXX_DiscardUnknown()

func (*ImportErrorsConfig) XXX_Marshal

func (m *ImportErrorsConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ImportErrorsConfig) XXX_Merge

func (m *ImportErrorsConfig) XXX_Merge(src proto.Message)

func (*ImportErrorsConfig) XXX_OneofWrappers

func (*ImportErrorsConfig) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*ImportErrorsConfig) XXX_Size

func (m *ImportErrorsConfig) XXX_Size() int

func (*ImportErrorsConfig) XXX_Unmarshal

func (m *ImportErrorsConfig) XXX_Unmarshal(b []byte) error

type ImportErrorsConfig_GcsPrefix

type ImportErrorsConfig_GcsPrefix struct {
	GcsPrefix string `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}

type 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 *timestamp.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           *timestamp.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

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)

func (*ImportMetadata) GetCreateTime

func (m *ImportMetadata) GetCreateTime() *timestamp.Timestamp

func (*ImportMetadata) GetFailureCount

func (m *ImportMetadata) GetFailureCount() int64

func (*ImportMetadata) GetOperationName

func (m *ImportMetadata) GetOperationName() string

func (*ImportMetadata) GetRequestId

func (m *ImportMetadata) GetRequestId() string

func (*ImportMetadata) GetSuccessCount

func (m *ImportMetadata) GetSuccessCount() int64

func (*ImportMetadata) GetUpdateTime

func (m *ImportMetadata) GetUpdateTime() *timestamp.Timestamp

func (*ImportMetadata) ProtoMessage

func (*ImportMetadata) ProtoMessage()

func (*ImportMetadata) Reset

func (m *ImportMetadata) Reset()

func (*ImportMetadata) String

func (m *ImportMetadata) String() string

func (*ImportMetadata) XXX_DiscardUnknown

func (m *ImportMetadata) XXX_DiscardUnknown()

func (*ImportMetadata) XXX_Marshal

func (m *ImportMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ImportMetadata) XXX_Merge

func (m *ImportMetadata) XXX_Merge(src proto.Message)

func (*ImportMetadata) XXX_Size

func (m *ImportMetadata) XXX_Size() int

func (*ImportMetadata) XXX_Unmarshal

func (m *ImportMetadata) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

Request message for the ImportUserEvents request.

func (*ImportUserEventsRequest) Descriptor

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

func (*ImportUserEventsRequest) GetErrorsConfig

func (m *ImportUserEventsRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportUserEventsRequest) GetInputConfig

func (m *ImportUserEventsRequest) GetInputConfig() *InputConfig

func (*ImportUserEventsRequest) GetParent

func (m *ImportUserEventsRequest) GetParent() string

func (*ImportUserEventsRequest) GetRequestId

func (m *ImportUserEventsRequest) GetRequestId() string

func (*ImportUserEventsRequest) ProtoMessage

func (*ImportUserEventsRequest) ProtoMessage()

func (*ImportUserEventsRequest) Reset

func (m *ImportUserEventsRequest) Reset()

func (*ImportUserEventsRequest) String

func (m *ImportUserEventsRequest) String() string

func (*ImportUserEventsRequest) XXX_DiscardUnknown

func (m *ImportUserEventsRequest) XXX_DiscardUnknown()

func (*ImportUserEventsRequest) XXX_Marshal

func (m *ImportUserEventsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ImportUserEventsRequest) XXX_Merge

func (m *ImportUserEventsRequest) XXX_Merge(src proto.Message)

func (*ImportUserEventsRequest) XXX_Size

func (m *ImportUserEventsRequest) XXX_Size() int

func (*ImportUserEventsRequest) XXX_Unmarshal

func (m *ImportUserEventsRequest) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{}                `json:"-"`
	XXX_unrecognized     []byte                  `json:"-"`
	XXX_sizecache        int32                   `json:"-"`
}

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)

func (*ImportUserEventsResponse) GetErrorSamples

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

func (*ImportUserEventsResponse) GetErrorsConfig

func (m *ImportUserEventsResponse) GetErrorsConfig() *ImportErrorsConfig

func (*ImportUserEventsResponse) GetImportSummary

func (m *ImportUserEventsResponse) GetImportSummary() *UserEventImportSummary

func (*ImportUserEventsResponse) ProtoMessage

func (*ImportUserEventsResponse) ProtoMessage()

func (*ImportUserEventsResponse) Reset

func (m *ImportUserEventsResponse) Reset()

func (*ImportUserEventsResponse) String

func (m *ImportUserEventsResponse) String() string

func (*ImportUserEventsResponse) XXX_DiscardUnknown

func (m *ImportUserEventsResponse) XXX_DiscardUnknown()

func (*ImportUserEventsResponse) XXX_Marshal

func (m *ImportUserEventsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ImportUserEventsResponse) XXX_Merge

func (m *ImportUserEventsResponse) XXX_Merge(src proto.Message)

func (*ImportUserEventsResponse) XXX_Size

func (m *ImportUserEventsResponse) XXX_Size() int

func (*ImportUserEventsResponse) XXX_Unmarshal

func (m *ImportUserEventsResponse) XXX_Unmarshal(b []byte) error

type InputConfig

type InputConfig struct {
	// Required. The source of the input.
	//
	// Types that are valid to be assigned to Source:
	//	*InputConfig_CatalogInlineSource
	//	*InputConfig_GcsSource
	//	*InputConfig_UserEventInlineSource
	Source               isInputConfig_Source `protobuf_oneof:"source"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

The input config source.

func (*InputConfig) Descriptor

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

func (*InputConfig) GetCatalogInlineSource

func (m *InputConfig) GetCatalogInlineSource() *CatalogInlineSource

func (*InputConfig) GetGcsSource

func (m *InputConfig) GetGcsSource() *GcsSource

func (*InputConfig) GetSource

func (m *InputConfig) GetSource() isInputConfig_Source

func (*InputConfig) GetUserEventInlineSource

func (m *InputConfig) GetUserEventInlineSource() *UserEventInlineSource

func (*InputConfig) ProtoMessage

func (*InputConfig) ProtoMessage()

func (*InputConfig) Reset

func (m *InputConfig) Reset()

func (*InputConfig) String

func (m *InputConfig) String() string

func (*InputConfig) XXX_DiscardUnknown

func (m *InputConfig) XXX_DiscardUnknown()

func (*InputConfig) XXX_Marshal

func (m *InputConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InputConfig) XXX_Merge

func (m *InputConfig) XXX_Merge(src proto.Message)

func (*InputConfig) XXX_OneofWrappers

func (*InputConfig) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*InputConfig) XXX_Size

func (m *InputConfig) XXX_Size() int

func (*InputConfig) XXX_Unmarshal

func (m *InputConfig) XXX_Unmarshal(b []byte) error

type InputConfig_CatalogInlineSource

type InputConfig_CatalogInlineSource struct {
	CatalogInlineSource *CatalogInlineSource `protobuf:"bytes,1,opt,name=catalog_inline_source,json=catalogInlineSource,proto3,oneof"`
}

type InputConfig_GcsSource

type InputConfig_GcsSource struct {
	GcsSource *GcsSource `protobuf:"bytes,2,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}

type InputConfig_UserEventInlineSource

type InputConfig_UserEventInlineSource struct {
	UserEventInlineSource *UserEventInlineSource `protobuf:"bytes,3,opt,name=user_event_inline_source,json=userEventInlineSource,proto3,oneof"`
}

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request message for ListCatalogItems method.

func (*ListCatalogItemsRequest) Descriptor

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

func (*ListCatalogItemsRequest) GetFilter

func (m *ListCatalogItemsRequest) GetFilter() string

func (*ListCatalogItemsRequest) GetPageSize

func (m *ListCatalogItemsRequest) GetPageSize() int32

func (*ListCatalogItemsRequest) GetPageToken

func (m *ListCatalogItemsRequest) GetPageToken() string

func (*ListCatalogItemsRequest) GetParent

func (m *ListCatalogItemsRequest) GetParent() string

func (*ListCatalogItemsRequest) ProtoMessage

func (*ListCatalogItemsRequest) ProtoMessage()

func (*ListCatalogItemsRequest) Reset

func (m *ListCatalogItemsRequest) Reset()

func (*ListCatalogItemsRequest) String

func (m *ListCatalogItemsRequest) String() string

func (*ListCatalogItemsRequest) XXX_DiscardUnknown

func (m *ListCatalogItemsRequest) XXX_DiscardUnknown()

func (*ListCatalogItemsRequest) XXX_Marshal

func (m *ListCatalogItemsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListCatalogItemsRequest) XXX_Merge

func (m *ListCatalogItemsRequest) XXX_Merge(src proto.Message)

func (*ListCatalogItemsRequest) XXX_Size

func (m *ListCatalogItemsRequest) XXX_Size() int

func (*ListCatalogItemsRequest) XXX_Unmarshal

func (m *ListCatalogItemsRequest) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Response message for ListCatalogItems method.

func (*ListCatalogItemsResponse) Descriptor

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

func (*ListCatalogItemsResponse) GetCatalogItems

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

func (*ListCatalogItemsResponse) GetNextPageToken

func (m *ListCatalogItemsResponse) GetNextPageToken() string

func (*ListCatalogItemsResponse) ProtoMessage

func (*ListCatalogItemsResponse) ProtoMessage()

func (*ListCatalogItemsResponse) Reset

func (m *ListCatalogItemsResponse) Reset()

func (*ListCatalogItemsResponse) String

func (m *ListCatalogItemsResponse) String() string

func (*ListCatalogItemsResponse) XXX_DiscardUnknown

func (m *ListCatalogItemsResponse) XXX_DiscardUnknown()

func (*ListCatalogItemsResponse) XXX_Marshal

func (m *ListCatalogItemsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListCatalogItemsResponse) XXX_Merge

func (m *ListCatalogItemsResponse) XXX_Merge(src proto.Message)

func (*ListCatalogItemsResponse) XXX_Size

func (m *ListCatalogItemsResponse) XXX_Size() int

func (*ListCatalogItemsResponse) XXX_Unmarshal

func (m *ListCatalogItemsResponse) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request message for the `ListPredictionApiKeyRegistrations`.

func (*ListPredictionApiKeyRegistrationsRequest) Descriptor

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

func (*ListPredictionApiKeyRegistrationsRequest) GetPageSize

func (*ListPredictionApiKeyRegistrationsRequest) GetPageToken

func (*ListPredictionApiKeyRegistrationsRequest) GetParent

func (*ListPredictionApiKeyRegistrationsRequest) ProtoMessage

func (*ListPredictionApiKeyRegistrationsRequest) Reset

func (*ListPredictionApiKeyRegistrationsRequest) String

func (*ListPredictionApiKeyRegistrationsRequest) XXX_DiscardUnknown

func (m *ListPredictionApiKeyRegistrationsRequest) XXX_DiscardUnknown()

func (*ListPredictionApiKeyRegistrationsRequest) XXX_Marshal

func (m *ListPredictionApiKeyRegistrationsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListPredictionApiKeyRegistrationsRequest) XXX_Merge

func (*ListPredictionApiKeyRegistrationsRequest) XXX_Size

func (*ListPredictionApiKeyRegistrationsRequest) XXX_Unmarshal

func (m *ListPredictionApiKeyRegistrationsRequest) XXX_Unmarshal(b []byte) error

type ListPredictionApiKeyRegistrationsResponse

type ListPredictionApiKeyRegistrationsResponse struct {
	// The list of registered API keys.
	PredictionApiKeyRegistrations []*PredictionApiKeyRegistration "" /* 152 byte string literal not displayed */
	// If empty, the list is complete. If nonempty, pass the token to the next
	// request's `ListPredictionApiKeysRegistrationsRequest.pageToken`.
	NextPageToken        string   `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Response message for the `ListPredictionApiKeyRegistrations`.

func (*ListPredictionApiKeyRegistrationsResponse) Descriptor

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

func (*ListPredictionApiKeyRegistrationsResponse) GetNextPageToken

func (m *ListPredictionApiKeyRegistrationsResponse) GetNextPageToken() string

func (*ListPredictionApiKeyRegistrationsResponse) GetPredictionApiKeyRegistrations

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

func (*ListPredictionApiKeyRegistrationsResponse) ProtoMessage

func (*ListPredictionApiKeyRegistrationsResponse) Reset

func (*ListPredictionApiKeyRegistrationsResponse) String

func (*ListPredictionApiKeyRegistrationsResponse) XXX_DiscardUnknown

func (m *ListPredictionApiKeyRegistrationsResponse) XXX_DiscardUnknown()

func (*ListPredictionApiKeyRegistrationsResponse) XXX_Marshal

func (m *ListPredictionApiKeyRegistrationsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListPredictionApiKeyRegistrationsResponse) XXX_Merge

func (*ListPredictionApiKeyRegistrationsResponse) XXX_Size

func (*ListPredictionApiKeyRegistrationsResponse) XXX_Unmarshal

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request message for ListUserEvents method.

func (*ListUserEventsRequest) Descriptor

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

func (*ListUserEventsRequest) GetFilter

func (m *ListUserEventsRequest) GetFilter() string

func (*ListUserEventsRequest) GetPageSize

func (m *ListUserEventsRequest) GetPageSize() int32

func (*ListUserEventsRequest) GetPageToken

func (m *ListUserEventsRequest) GetPageToken() string

func (*ListUserEventsRequest) GetParent

func (m *ListUserEventsRequest) GetParent() string

func (*ListUserEventsRequest) ProtoMessage

func (*ListUserEventsRequest) ProtoMessage()

func (*ListUserEventsRequest) Reset

func (m *ListUserEventsRequest) Reset()

func (*ListUserEventsRequest) String

func (m *ListUserEventsRequest) String() string

func (*ListUserEventsRequest) XXX_DiscardUnknown

func (m *ListUserEventsRequest) XXX_DiscardUnknown()

func (*ListUserEventsRequest) XXX_Marshal

func (m *ListUserEventsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListUserEventsRequest) XXX_Merge

func (m *ListUserEventsRequest) XXX_Merge(src proto.Message)

func (*ListUserEventsRequest) XXX_Size

func (m *ListUserEventsRequest) XXX_Size() int

func (*ListUserEventsRequest) XXX_Unmarshal

func (m *ListUserEventsRequest) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Response message for ListUserEvents method.

func (*ListUserEventsResponse) Descriptor

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

func (*ListUserEventsResponse) GetNextPageToken

func (m *ListUserEventsResponse) GetNextPageToken() string

func (*ListUserEventsResponse) GetUserEvents

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

func (*ListUserEventsResponse) ProtoMessage

func (*ListUserEventsResponse) ProtoMessage()

func (*ListUserEventsResponse) Reset

func (m *ListUserEventsResponse) Reset()

func (*ListUserEventsResponse) String

func (m *ListUserEventsResponse) String() string

func (*ListUserEventsResponse) XXX_DiscardUnknown

func (m *ListUserEventsResponse) XXX_DiscardUnknown()

func (*ListUserEventsResponse) XXX_Marshal

func (m *ListUserEventsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListUserEventsResponse) XXX_Merge

func (m *ListUserEventsResponse) XXX_Merge(src proto.Message)

func (*ListUserEventsResponse) XXX_Size

func (m *ListUserEventsResponse) XXX_Size() int

func (*ListUserEventsResponse) XXX_Unmarshal

func (m *ListUserEventsResponse) XXX_Unmarshal(b []byte) error

type PredictRequest

type PredictRequest struct {
	// Required. Full resource name of the format:
	// {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}
	// The id of the recommendation engine placement. This id is used to identify
	// the set of models that will be used to make the prediction.
	//
	// We currently support three placements with the following IDs by default:
	//
	// * `shopping_cart`: Predicts items frequently bought together with one or
	//   more catalog items in the same shopping session. Commonly displayed after
	//   `add-to-cart` events, on product detail pages, or on the shopping cart
	//   page.
	//
	// * `home_page`: Predicts the next product that a user will most likely
	//   engage with or purchase based on the shopping or viewing history of the
	//   specified `userId` or `visitorId`. For example - Recommendations for you.
	//
	// * `product_detail`: Predicts the next product that a user will most likely
	//   engage with or purchase. The prediction is based on the shopping or
	//   viewing history of the specified `userId` or `visitorId` and its
	//   relevance to a specified `CatalogItem`. Typically used on product detail
	//   pages. For example - More items like this.
	//
	// * `recently_viewed_default`: Returns up to 75 items recently viewed by the
	//   specified `userId` or `visitorId`, most recent ones first. Returns
	//   nothing if neither of them has viewed any items yet. For example -
	//   Recently viewed.
	//
	// The full list of available placements can be seen at
	// https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Context about the user, what they are looking at and what action
	// they took to trigger the predict request. Note that this user event detail
	// won't be ingested to userEvent logs. Thus, a separate userEvent write
	// request is required for event logging.
	UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
	// Optional. Maximum number of results to return per page. Set this property
	// to the number of prediction results required. If zero, the service will
	// choose a reasonable default.
	PageSize int32 `protobuf:"varint,7,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The previous PredictResponse.next_page_token.
	PageToken string `protobuf:"bytes,8,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filter for restricting prediction results. Accepts values for
	// tags and the `filterOutOfStockItems` flag.
	//
	//  * Tag expressions. Restricts predictions to items that match all of the
	//    specified tags. Boolean operators `OR` and `NOT` are supported if the
	//    expression is enclosed in parentheses, and must be separated from the
	//    tag values by a space. `-"tagA"` is also supported and is equivalent to
	//    `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
	//    with a size limit of 1 KiB.
	//
	//  * filterOutOfStockItems. Restricts predictions to items that do not have a
	//    stockState value of OUT_OF_STOCK.
	//
	// Examples:
	//
	//  * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
	//  * filterOutOfStockItems  tag=(-"promotional")
	//  * filterOutOfStockItems
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Use dryRun mode for this prediction query. If set to true, a
	// dummy model will be used that returns arbitrary catalog items.
	// Note that the dryRun mode should only be used for testing the API, or if
	// the model is not ready.
	DryRun bool `protobuf:"varint,4,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
	// Optional. Additional domain specific parameters for the predictions.
	//
	// Allowed values:
	//
	// * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
	//    object will be returned in the
	//   `PredictResponse.PredictionResult.itemMetadata` object in the method
	//    response.
	// * `returnItemScore`: Boolean. If set to true, the prediction 'score'
	//    corresponding to each returned item will be set in the `metadata`
	//    field in the prediction response. The given 'score' indicates the
	//    probability of an item being clicked/purchased given the user's context
	//    and history.
	Params map[string]*_struct.Value "" /* 153 byte string literal not displayed */
	// Optional. The labels for the predict request.
	//
	//  * Label keys can contain lowercase letters, digits and hyphens, must start
	//    with a letter, and must end with a letter or digit.
	//  * Non-zero label values can contain lowercase letters, digits and hyphens,
	//    must start with a letter, and must end with a letter or digit.
	//  * No more than 64 labels can be associated with a given request.
	//
	// See https://goo.gl/xmQnxf for more information on and examples of labels.
	Labels               map[string]string "" /* 153 byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

Request message for Predict method.

func (*PredictRequest) Descriptor

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

func (*PredictRequest) GetDryRun

func (m *PredictRequest) GetDryRun() bool

func (*PredictRequest) GetFilter

func (m *PredictRequest) GetFilter() string

func (*PredictRequest) GetLabels

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

func (*PredictRequest) GetName

func (m *PredictRequest) GetName() string

func (*PredictRequest) GetPageSize

func (m *PredictRequest) GetPageSize() int32

func (*PredictRequest) GetPageToken

func (m *PredictRequest) GetPageToken() string

func (*PredictRequest) GetParams

func (m *PredictRequest) GetParams() map[string]*_struct.Value

func (*PredictRequest) GetUserEvent

func (m *PredictRequest) GetUserEvent() *UserEvent

func (*PredictRequest) ProtoMessage

func (*PredictRequest) ProtoMessage()

func (*PredictRequest) Reset

func (m *PredictRequest) Reset()

func (*PredictRequest) String

func (m *PredictRequest) String() string

func (*PredictRequest) XXX_DiscardUnknown

func (m *PredictRequest) XXX_DiscardUnknown()

func (*PredictRequest) XXX_Marshal

func (m *PredictRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PredictRequest) XXX_Merge

func (m *PredictRequest) XXX_Merge(src proto.Message)

func (*PredictRequest) XXX_Size

func (m *PredictRequest) XXX_Size() int

func (*PredictRequest) XXX_Unmarshal

func (m *PredictRequest) XXX_Unmarshal(b []byte) error

type PredictResponse

type PredictResponse struct {
	// A list of recommended items. The order represents the ranking (from the
	// most relevant item to the least).
	Results []*PredictResponse_PredictionResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// A unique recommendation token. This should be included in the user event
	// logs resulting from this recommendation, which enables accurate attribution
	// of recommendation model performance.
	RecommendationToken string `protobuf:"bytes,2,opt,name=recommendation_token,json=recommendationToken,proto3" json:"recommendation_token,omitempty"`
	// IDs of items in the request that were missing from the catalog.
	ItemsMissingInCatalog []string "" /* 128 byte string literal not displayed */
	// True if the dryRun property was set in the request.
	DryRun bool `protobuf:"varint,4,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
	// Additional domain specific prediction response metadata.
	Metadata map[string]*_struct.Value "" /* 157 byte string literal not displayed */
	// If empty, the list is complete. If nonempty, the token to pass to the next
	// request's PredictRequest.page_token.
	NextPageToken        string   `protobuf:"bytes,6,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Response message for predict method.

func (*PredictResponse) Descriptor

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

func (*PredictResponse) GetDryRun

func (m *PredictResponse) GetDryRun() bool

func (*PredictResponse) GetItemsMissingInCatalog

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

func (*PredictResponse) GetMetadata

func (m *PredictResponse) GetMetadata() map[string]*_struct.Value

func (*PredictResponse) GetNextPageToken

func (m *PredictResponse) GetNextPageToken() string

func (*PredictResponse) GetRecommendationToken

func (m *PredictResponse) GetRecommendationToken() string

func (*PredictResponse) GetResults

func (*PredictResponse) ProtoMessage

func (*PredictResponse) ProtoMessage()

func (*PredictResponse) Reset

func (m *PredictResponse) Reset()

func (*PredictResponse) String

func (m *PredictResponse) String() string

func (*PredictResponse) XXX_DiscardUnknown

func (m *PredictResponse) XXX_DiscardUnknown()

func (*PredictResponse) XXX_Marshal

func (m *PredictResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PredictResponse) XXX_Merge

func (m *PredictResponse) XXX_Merge(src proto.Message)

func (*PredictResponse) XXX_Size

func (m *PredictResponse) XXX_Size() int

func (*PredictResponse) XXX_Unmarshal

func (m *PredictResponse) XXX_Unmarshal(b []byte) error

type PredictResponse_PredictionResult

type PredictResponse_PredictionResult struct {
	// ID of the recommended catalog item
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Additional item metadata / annotations.
	//
	// Possible values:
	//
	// * `catalogItem`: JSON representation of the catalogItem. Will be set if
	//   `returnCatalogItem` is set to true in `PredictRequest.params`.
	// * `score`: Prediction score in double value. Will be set if
	//   `returnItemScore` is set to true in `PredictRequest.params`.
	ItemMetadata         map[string]*_struct.Value "" /* 185 byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
	XXX_unrecognized     []byte                    `json:"-"`
	XXX_sizecache        int32                     `json:"-"`
}

PredictionResult represents the recommendation prediction results.

func (*PredictResponse_PredictionResult) Descriptor

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

func (*PredictResponse_PredictionResult) GetId

func (*PredictResponse_PredictionResult) GetItemMetadata

func (m *PredictResponse_PredictionResult) GetItemMetadata() map[string]*_struct.Value

func (*PredictResponse_PredictionResult) ProtoMessage

func (*PredictResponse_PredictionResult) ProtoMessage()

func (*PredictResponse_PredictionResult) Reset

func (*PredictResponse_PredictionResult) String

func (*PredictResponse_PredictionResult) XXX_DiscardUnknown

func (m *PredictResponse_PredictionResult) XXX_DiscardUnknown()

func (*PredictResponse_PredictionResult) XXX_Marshal

func (m *PredictResponse_PredictionResult) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PredictResponse_PredictionResult) XXX_Merge

func (*PredictResponse_PredictionResult) XXX_Size

func (m *PredictResponse_PredictionResult) XXX_Size() int

func (*PredictResponse_PredictionResult) XXX_Unmarshal

func (m *PredictResponse_PredictionResult) XXX_Unmarshal(b []byte) error

type PredictionApiKeyRegistration

type PredictionApiKeyRegistration struct {
	// The API key.
	ApiKey               string   `protobuf:"bytes,1,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Registered Api Key.

func (*PredictionApiKeyRegistration) Descriptor

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

func (*PredictionApiKeyRegistration) GetApiKey

func (m *PredictionApiKeyRegistration) GetApiKey() string

func (*PredictionApiKeyRegistration) ProtoMessage

func (*PredictionApiKeyRegistration) ProtoMessage()

func (*PredictionApiKeyRegistration) Reset

func (m *PredictionApiKeyRegistration) Reset()

func (*PredictionApiKeyRegistration) String

func (*PredictionApiKeyRegistration) XXX_DiscardUnknown

func (m *PredictionApiKeyRegistration) XXX_DiscardUnknown()

func (*PredictionApiKeyRegistration) XXX_Marshal

func (m *PredictionApiKeyRegistration) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PredictionApiKeyRegistration) XXX_Merge

func (m *PredictionApiKeyRegistration) XXX_Merge(src proto.Message)

func (*PredictionApiKeyRegistration) XXX_Size

func (m *PredictionApiKeyRegistration) XXX_Size() int

func (*PredictionApiKeyRegistration) XXX_Unmarshal

func (m *PredictionApiKeyRegistration) XXX_Unmarshal(b []byte) error

type 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) (*empty.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.

type 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) (*empty.Empty, error)
}

PredictionApiKeyRegistryServer is the server API for PredictionApiKeyRegistry service.

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

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

type ProductCatalogItem

type ProductCatalogItem struct {
	// Product price. Only one of 'exactPrice'/'priceRange' can be provided.
	//
	// Types that are valid to be assigned to Price:
	//	*ProductCatalogItem_ExactPrice_
	//	*ProductCatalogItem_PriceRange_
	Price isProductCatalogItem_Price `protobuf_oneof:"price"`
	// Optional. A map to pass the costs associated with the product.
	//
	// For example:
	// {"manufacturing": 45.5} The profit of selling this item is computed like
	// so:
	//
	// * If 'exactPrice' is provided, profit = displayPrice - sum(costs)
	// * If 'priceRange' is provided, profit = minPrice - sum(costs)
	Costs map[string]float32 "" /* 153 byte string literal not displayed */
	// Optional. Only required if the price is set. Currency code for price/costs. Use
	// three-character ISO-4217 code.
	CurrencyCode string `protobuf:"bytes,4,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// Optional. Online stock state of the catalog item. Default is `IN_STOCK`.
	StockState ProductCatalogItem_StockState "" /* 169 byte string literal not displayed */
	// Optional. The available quantity of the item.
	AvailableQuantity int64 `protobuf:"varint,6,opt,name=available_quantity,json=availableQuantity,proto3" json:"available_quantity,omitempty"`
	// Optional. Canonical URL directly linking to the item detail page with a
	// length limit of 5 KiB..
	CanonicalProductUri string `protobuf:"bytes,7,opt,name=canonical_product_uri,json=canonicalProductUri,proto3" json:"canonical_product_uri,omitempty"`
	// Optional. Product images for the catalog item.
	Images               []*Image `protobuf:"bytes,8,rep,name=images,proto3" json:"images,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

ProductCatalogItem captures item metadata specific to retail products.

func (*ProductCatalogItem) Descriptor

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

func (*ProductCatalogItem) GetAvailableQuantity

func (m *ProductCatalogItem) GetAvailableQuantity() int64

func (*ProductCatalogItem) GetCanonicalProductUri

func (m *ProductCatalogItem) GetCanonicalProductUri() string

func (*ProductCatalogItem) GetCosts

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

func (*ProductCatalogItem) GetCurrencyCode

func (m *ProductCatalogItem) GetCurrencyCode() string

func (*ProductCatalogItem) GetExactPrice

func (*ProductCatalogItem) GetImages

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

func (*ProductCatalogItem) GetPrice

func (m *ProductCatalogItem) GetPrice() isProductCatalogItem_Price

func (*ProductCatalogItem) GetPriceRange

func (*ProductCatalogItem) GetStockState

func (*ProductCatalogItem) ProtoMessage

func (*ProductCatalogItem) ProtoMessage()

func (*ProductCatalogItem) Reset

func (m *ProductCatalogItem) Reset()

func (*ProductCatalogItem) String

func (m *ProductCatalogItem) String() string

func (*ProductCatalogItem) XXX_DiscardUnknown

func (m *ProductCatalogItem) XXX_DiscardUnknown()

func (*ProductCatalogItem) XXX_Marshal

func (m *ProductCatalogItem) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProductCatalogItem) XXX_Merge

func (m *ProductCatalogItem) XXX_Merge(src proto.Message)

func (*ProductCatalogItem) XXX_OneofWrappers

func (*ProductCatalogItem) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*ProductCatalogItem) XXX_Size

func (m *ProductCatalogItem) XXX_Size() int

func (*ProductCatalogItem) XXX_Unmarshal

func (m *ProductCatalogItem) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Exact product price.

func (*ProductCatalogItem_ExactPrice) Descriptor

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

func (*ProductCatalogItem_ExactPrice) GetDisplayPrice

func (m *ProductCatalogItem_ExactPrice) GetDisplayPrice() float32

func (*ProductCatalogItem_ExactPrice) GetOriginalPrice

func (m *ProductCatalogItem_ExactPrice) GetOriginalPrice() float32

func (*ProductCatalogItem_ExactPrice) ProtoMessage

func (*ProductCatalogItem_ExactPrice) ProtoMessage()

func (*ProductCatalogItem_ExactPrice) Reset

func (m *ProductCatalogItem_ExactPrice) Reset()

func (*ProductCatalogItem_ExactPrice) String

func (*ProductCatalogItem_ExactPrice) XXX_DiscardUnknown

func (m *ProductCatalogItem_ExactPrice) XXX_DiscardUnknown()

func (*ProductCatalogItem_ExactPrice) XXX_Marshal

func (m *ProductCatalogItem_ExactPrice) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProductCatalogItem_ExactPrice) XXX_Merge

func (m *ProductCatalogItem_ExactPrice) XXX_Merge(src proto.Message)

func (*ProductCatalogItem_ExactPrice) XXX_Size

func (m *ProductCatalogItem_ExactPrice) XXX_Size() int

func (*ProductCatalogItem_ExactPrice) XXX_Unmarshal

func (m *ProductCatalogItem_ExactPrice) XXX_Unmarshal(b []byte) error

type ProductCatalogItem_ExactPrice_

type ProductCatalogItem_ExactPrice_ struct {
	ExactPrice *ProductCatalogItem_ExactPrice `protobuf:"bytes,1,opt,name=exact_price,json=exactPrice,proto3,oneof"`
}

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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)

func (*ProductCatalogItem_PriceRange) GetMax

func (*ProductCatalogItem_PriceRange) GetMin

func (*ProductCatalogItem_PriceRange) ProtoMessage

func (*ProductCatalogItem_PriceRange) ProtoMessage()

func (*ProductCatalogItem_PriceRange) Reset

func (m *ProductCatalogItem_PriceRange) Reset()

func (*ProductCatalogItem_PriceRange) String

func (*ProductCatalogItem_PriceRange) XXX_DiscardUnknown

func (m *ProductCatalogItem_PriceRange) XXX_DiscardUnknown()

func (*ProductCatalogItem_PriceRange) XXX_Marshal

func (m *ProductCatalogItem_PriceRange) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProductCatalogItem_PriceRange) XXX_Merge

func (m *ProductCatalogItem_PriceRange) XXX_Merge(src proto.Message)

func (*ProductCatalogItem_PriceRange) XXX_Size

func (m *ProductCatalogItem_PriceRange) XXX_Size() int

func (*ProductCatalogItem_PriceRange) XXX_Unmarshal

func (m *ProductCatalogItem_PriceRange) XXX_Unmarshal(b []byte) error

type ProductCatalogItem_PriceRange_

type ProductCatalogItem_PriceRange_ struct {
	PriceRange *ProductCatalogItem_PriceRange `protobuf:"bytes,2,opt,name=price_range,json=priceRange,proto3,oneof"`
}

type ProductCatalogItem_StockState

type ProductCatalogItem_StockState int32

Item stock state. If this field is unspecified, the item is assumed to be in stock.

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) EnumDescriptor

func (ProductCatalogItem_StockState) EnumDescriptor() ([]byte, []int)

func (ProductCatalogItem_StockState) String

type ProductDetail

type ProductDetail struct {
	// Required. Catalog item ID. UTF-8 encoded string with a length limit of 128
	// characters.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Optional. Currency code for price/costs. Use three-character ISO-4217
	// code. Required only if originalPrice or displayPrice is set.
	CurrencyCode string `protobuf:"bytes,2,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// Optional. Original price of the product. If provided, this will override
	// the original price in Catalog for this product.
	OriginalPrice float32 `protobuf:"fixed32,3,opt,name=original_price,json=originalPrice,proto3" json:"original_price,omitempty"`
	// Optional. Display price of the product (e.g. discounted price). If
	// provided, this will override the display price in Catalog for this product.
	DisplayPrice float32 `protobuf:"fixed32,4,opt,name=display_price,json=displayPrice,proto3" json:"display_price,omitempty"`
	// Optional. Item stock state. If provided, this overrides the stock state
	// in Catalog for items in this event.
	StockState ProductCatalogItem_StockState "" /* 169 byte string literal not displayed */
	// Optional. Quantity of the product associated with the user event. For
	// example, this field will be 2 if two products are added to the shopping
	// cart for `add-to-cart` event. Required for `add-to-cart`, `add-to-list`,
	// `remove-from-cart`, `checkout-start`, `purchase-complete`, `refund` event
	// types.
	Quantity int32 `protobuf:"varint,6,opt,name=quantity,proto3" json:"quantity,omitempty"`
	// Optional. Quantity of the products in stock when a user event happens.
	// Optional. If provided, this overrides the available quantity in Catalog for
	// this event. and can only be set if `stock_status` is set to `IN_STOCK`.
	//
	// Note that if an item is out of stock, you must set the `stock_state` field
	// to be `OUT_OF_STOCK`. Leaving this field unspecified / as zero is not
	// sufficient to mark the item out of stock.
	AvailableQuantity int32 `protobuf:"varint,7,opt,name=available_quantity,json=availableQuantity,proto3" json:"available_quantity,omitempty"`
	// Optional. Extra features associated with a product in the user event.
	ItemAttributes       *FeatureMap `protobuf:"bytes,8,opt,name=item_attributes,json=itemAttributes,proto3" json:"item_attributes,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

Detailed product information associated with a user event.

func (*ProductDetail) Descriptor

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

func (*ProductDetail) GetAvailableQuantity

func (m *ProductDetail) GetAvailableQuantity() int32

func (*ProductDetail) GetCurrencyCode

func (m *ProductDetail) GetCurrencyCode() string

func (*ProductDetail) GetDisplayPrice

func (m *ProductDetail) GetDisplayPrice() float32

func (*ProductDetail) GetId

func (m *ProductDetail) GetId() string

func (*ProductDetail) GetItemAttributes

func (m *ProductDetail) GetItemAttributes() *FeatureMap

func (*ProductDetail) GetOriginalPrice

func (m *ProductDetail) GetOriginalPrice() float32

func (*ProductDetail) GetQuantity

func (m *ProductDetail) GetQuantity() int32

func (*ProductDetail) GetStockState

func (m *ProductDetail) GetStockState() ProductCatalogItem_StockState

func (*ProductDetail) ProtoMessage

func (*ProductDetail) ProtoMessage()

func (*ProductDetail) Reset

func (m *ProductDetail) Reset()

func (*ProductDetail) String

func (m *ProductDetail) String() string

func (*ProductDetail) XXX_DiscardUnknown

func (m *ProductDetail) XXX_DiscardUnknown()

func (*ProductDetail) XXX_Marshal

func (m *ProductDetail) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProductDetail) XXX_Merge

func (m *ProductDetail) XXX_Merge(src proto.Message)

func (*ProductDetail) XXX_Size

func (m *ProductDetail) XXX_Size() int

func (*ProductDetail) XXX_Unmarshal

func (m *ProductDetail) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

ProductEventDetail captures user event information specific to retail products.

func (*ProductEventDetail) Descriptor

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

func (*ProductEventDetail) GetCartId

func (m *ProductEventDetail) GetCartId() string

func (*ProductEventDetail) GetListId

func (m *ProductEventDetail) GetListId() string

func (*ProductEventDetail) GetPageCategories

func (m *ProductEventDetail) GetPageCategories() []*CatalogItem_CategoryHierarchy

func (*ProductEventDetail) GetProductDetails

func (m *ProductEventDetail) GetProductDetails() []*ProductDetail

func (*ProductEventDetail) GetPurchaseTransaction

func (m *ProductEventDetail) GetPurchaseTransaction() *PurchaseTransaction

func (*ProductEventDetail) GetSearchQuery

func (m *ProductEventDetail) GetSearchQuery() string

func (*ProductEventDetail) ProtoMessage

func (*ProductEventDetail) ProtoMessage()

func (*ProductEventDetail) Reset

func (m *ProductEventDetail) Reset()

func (*ProductEventDetail) String

func (m *ProductEventDetail) String() string

func (*ProductEventDetail) XXX_DiscardUnknown

func (m *ProductEventDetail) XXX_DiscardUnknown()

func (*ProductEventDetail) XXX_Marshal

func (m *ProductEventDetail) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ProductEventDetail) XXX_Merge

func (m *ProductEventDetail) XXX_Merge(src proto.Message)

func (*ProductEventDetail) XXX_Size

func (m *ProductEventDetail) XXX_Size() int

func (*ProductEventDetail) XXX_Unmarshal

func (m *ProductEventDetail) XXX_Unmarshal(b []byte) error

type PurchaseTransaction

type PurchaseTransaction struct {
	// Optional. The transaction ID with a length limit of 128 bytes.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Required. Total revenue or grand total associated with the transaction.
	// This value include shipping, tax, or other adjustments to total revenue
	// that you want to include as part of your revenue calculations. This field
	// is not required if the event type is `refund`.
	Revenue float32 `protobuf:"fixed32,2,opt,name=revenue,proto3" json:"revenue,omitempty"`
	// Optional. All the taxes associated with the transaction.
	Taxes map[string]float32 "" /* 153 byte string literal not displayed */
	// Optional. All the costs associated with the product. These can be
	// manufacturing costs, shipping expenses not borne by the end user, or any
	// other costs.
	//
	// Total product cost such that
	//   profit = revenue - (sum(taxes) + sum(costs))
	// If product_cost is not set, then
	//   profit = revenue - tax - shipping - sum(CatalogItem.costs).
	//
	// If CatalogItem.cost is not specified for one of the items, CatalogItem.cost
	// based profit *cannot* be calculated for this Transaction.
	Costs map[string]float32 "" /* 153 byte string literal not displayed */
	// Required. Currency code. Use three-character ISO-4217 code. This field
	// is not required if the event type is `refund`.
	CurrencyCode         string   `protobuf:"bytes,6,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A transaction represents the entire purchase transaction.

func (*PurchaseTransaction) Descriptor

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

func (*PurchaseTransaction) GetCosts

func (m *PurchaseTransaction) GetCosts() map[string]float32

func (*PurchaseTransaction) GetCurrencyCode

func (m *PurchaseTransaction) GetCurrencyCode() string

func (*PurchaseTransaction) GetId

func (m *PurchaseTransaction) GetId() string

func (*PurchaseTransaction) GetRevenue

func (m *PurchaseTransaction) GetRevenue() float32

func (*PurchaseTransaction) GetTaxes

func (m *PurchaseTransaction) GetTaxes() map[string]float32

func (*PurchaseTransaction) ProtoMessage

func (*PurchaseTransaction) ProtoMessage()

func (*PurchaseTransaction) Reset

func (m *PurchaseTransaction) Reset()

func (*PurchaseTransaction) String

func (m *PurchaseTransaction) String() string

func (*PurchaseTransaction) XXX_DiscardUnknown

func (m *PurchaseTransaction) XXX_DiscardUnknown()

func (*PurchaseTransaction) XXX_Marshal

func (m *PurchaseTransaction) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PurchaseTransaction) XXX_Merge

func (m *PurchaseTransaction) XXX_Merge(src proto.Message)

func (*PurchaseTransaction) XXX_Size

func (m *PurchaseTransaction) XXX_Size() int

func (*PurchaseTransaction) XXX_Unmarshal

func (m *PurchaseTransaction) XXX_Unmarshal(b []byte) error

type 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           *timestamp.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

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)

func (*PurgeUserEventsMetadata) GetCreateTime

func (m *PurgeUserEventsMetadata) GetCreateTime() *timestamp.Timestamp

func (*PurgeUserEventsMetadata) GetOperationName

func (m *PurgeUserEventsMetadata) GetOperationName() string

func (*PurgeUserEventsMetadata) ProtoMessage

func (*PurgeUserEventsMetadata) ProtoMessage()

func (*PurgeUserEventsMetadata) Reset

func (m *PurgeUserEventsMetadata) Reset()

func (*PurgeUserEventsMetadata) String

func (m *PurgeUserEventsMetadata) String() string

func (*PurgeUserEventsMetadata) XXX_DiscardUnknown

func (m *PurgeUserEventsMetadata) XXX_DiscardUnknown()

func (*PurgeUserEventsMetadata) XXX_Marshal

func (m *PurgeUserEventsMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PurgeUserEventsMetadata) XXX_Merge

func (m *PurgeUserEventsMetadata) XXX_Merge(src proto.Message)

func (*PurgeUserEventsMetadata) XXX_Size

func (m *PurgeUserEventsMetadata) XXX_Size() int

func (*PurgeUserEventsMetadata) XXX_Unmarshal

func (m *PurgeUserEventsMetadata) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request message for PurgeUserEvents method.

func (*PurgeUserEventsRequest) Descriptor

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

func (*PurgeUserEventsRequest) GetFilter

func (m *PurgeUserEventsRequest) GetFilter() string

func (*PurgeUserEventsRequest) GetForce

func (m *PurgeUserEventsRequest) GetForce() bool

func (*PurgeUserEventsRequest) GetParent

func (m *PurgeUserEventsRequest) GetParent() string

func (*PurgeUserEventsRequest) ProtoMessage

func (*PurgeUserEventsRequest) ProtoMessage()

func (*PurgeUserEventsRequest) Reset

func (m *PurgeUserEventsRequest) Reset()

func (*PurgeUserEventsRequest) String

func (m *PurgeUserEventsRequest) String() string

func (*PurgeUserEventsRequest) XXX_DiscardUnknown

func (m *PurgeUserEventsRequest) XXX_DiscardUnknown()

func (*PurgeUserEventsRequest) XXX_Marshal

func (m *PurgeUserEventsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PurgeUserEventsRequest) XXX_Merge

func (m *PurgeUserEventsRequest) XXX_Merge(src proto.Message)

func (*PurgeUserEventsRequest) XXX_Size

func (m *PurgeUserEventsRequest) XXX_Size() int

func (*PurgeUserEventsRequest) XXX_Unmarshal

func (m *PurgeUserEventsRequest) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

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)

func (*PurgeUserEventsResponse) GetPurgedEventsCount

func (m *PurgeUserEventsResponse) GetPurgedEventsCount() int64

func (*PurgeUserEventsResponse) GetUserEventsSample

func (m *PurgeUserEventsResponse) GetUserEventsSample() []*UserEvent

func (*PurgeUserEventsResponse) ProtoMessage

func (*PurgeUserEventsResponse) ProtoMessage()

func (*PurgeUserEventsResponse) Reset

func (m *PurgeUserEventsResponse) Reset()

func (*PurgeUserEventsResponse) String

func (m *PurgeUserEventsResponse) String() string

func (*PurgeUserEventsResponse) XXX_DiscardUnknown

func (m *PurgeUserEventsResponse) XXX_DiscardUnknown()

func (*PurgeUserEventsResponse) XXX_Marshal

func (m *PurgeUserEventsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PurgeUserEventsResponse) XXX_Merge

func (m *PurgeUserEventsResponse) XXX_Merge(src proto.Message)

func (*PurgeUserEventsResponse) XXX_Size

func (m *PurgeUserEventsResponse) XXX_Size() int

func (*PurgeUserEventsResponse) XXX_Unmarshal

func (m *PurgeUserEventsResponse) XXX_Unmarshal(b []byte) error

type UnimplementedCatalogServiceServer

type UnimplementedCatalogServiceServer struct {
}

UnimplementedCatalogServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCatalogServiceServer) CreateCatalogItem

func (*UnimplementedCatalogServiceServer) DeleteCatalogItem

func (*UnimplementedCatalogServiceServer) GetCatalogItem

func (*UnimplementedCatalogServiceServer) ImportCatalogItems

func (*UnimplementedCatalogServiceServer) ListCatalogItems

func (*UnimplementedCatalogServiceServer) UpdateCatalogItem

type UnimplementedPredictionApiKeyRegistryServer

type UnimplementedPredictionApiKeyRegistryServer struct {
}

UnimplementedPredictionApiKeyRegistryServer can be embedded to have forward compatible implementations.

func (*UnimplementedPredictionApiKeyRegistryServer) CreatePredictionApiKeyRegistration

func (*UnimplementedPredictionApiKeyRegistryServer) DeletePredictionApiKeyRegistration

type UnimplementedPredictionServiceServer

type UnimplementedPredictionServiceServer struct {
}

UnimplementedPredictionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedPredictionServiceServer) Predict

type UnimplementedUserEventServiceServer

type UnimplementedUserEventServiceServer struct {
}

UnimplementedUserEventServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedUserEventServiceServer) CollectUserEvent

func (*UnimplementedUserEventServiceServer) ImportUserEvents

func (*UnimplementedUserEventServiceServer) ListUserEvents

func (*UnimplementedUserEventServiceServer) PurgeUserEvents

func (*UnimplementedUserEventServiceServer) WriteUserEvent

type 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           *field_mask.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	XXX_NoUnkeyedLiteral struct{}              `json:"-"`
	XXX_unrecognized     []byte                `json:"-"`
	XXX_sizecache        int32                 `json:"-"`
}

Request message for UpdateCatalogItem method.

func (*UpdateCatalogItemRequest) Descriptor

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

func (*UpdateCatalogItemRequest) GetCatalogItem

func (m *UpdateCatalogItemRequest) GetCatalogItem() *CatalogItem

func (*UpdateCatalogItemRequest) GetName

func (m *UpdateCatalogItemRequest) GetName() string

func (*UpdateCatalogItemRequest) GetUpdateMask

func (m *UpdateCatalogItemRequest) GetUpdateMask() *field_mask.FieldMask

func (*UpdateCatalogItemRequest) ProtoMessage

func (*UpdateCatalogItemRequest) ProtoMessage()

func (*UpdateCatalogItemRequest) Reset

func (m *UpdateCatalogItemRequest) Reset()

func (*UpdateCatalogItemRequest) String

func (m *UpdateCatalogItemRequest) String() string

func (*UpdateCatalogItemRequest) XXX_DiscardUnknown

func (m *UpdateCatalogItemRequest) XXX_DiscardUnknown()

func (*UpdateCatalogItemRequest) XXX_Marshal

func (m *UpdateCatalogItemRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateCatalogItemRequest) XXX_Merge

func (m *UpdateCatalogItemRequest) XXX_Merge(src proto.Message)

func (*UpdateCatalogItemRequest) XXX_Size

func (m *UpdateCatalogItemRequest) XXX_Size() int

func (*UpdateCatalogItemRequest) XXX_Unmarshal

func (m *UpdateCatalogItemRequest) XXX_Unmarshal(b []byte) error

type UserEvent

type UserEvent struct {
	// Required. User event type. Allowed values are:
	//
	// * `add-to-cart` Products being added to cart.
	// * `add-to-list` Items being added to a list (shopping list, favorites
	//   etc).
	// * `category-page-view` Special pages such as sale or promotion pages
	//   viewed.
	// * `checkout-start` User starting a checkout process.
	// * `detail-page-view` Products detail page viewed.
	// * `home-page-view` Homepage viewed.
	// * `page-visit` Generic page visits not included in the event types above.
	// * `purchase-complete` User finishing a purchase.
	// * `refund` Purchased items being refunded or returned.
	// * `remove-from-cart` Products being removed from cart.
	// * `remove-from-list` Items being removed from a list.
	// * `search` Product search.
	// * `shopping-cart-page-view` User viewing a shopping cart.
	// * `impression` List of items displayed. Used by Google Tag Manager.
	EventType string `protobuf:"bytes,1,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
	// Required. User information.
	UserInfo *UserInfo `protobuf:"bytes,2,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
	// Optional. User event detailed information common across different
	// recommendation types.
	EventDetail *EventDetail `protobuf:"bytes,3,opt,name=event_detail,json=eventDetail,proto3" json:"event_detail,omitempty"`
	// Optional. Retail product specific user event metadata.
	//
	// This field is required for the following event types:
	//
	// * `add-to-cart`
	// * `add-to-list`
	// * `category-page-view`
	// * `checkout-start`
	// * `detail-page-view`
	// * `purchase-complete`
	// * `refund`
	// * `remove-from-cart`
	// * `remove-from-list`
	// * `search`
	//
	// This field is optional for the following event types:
	//
	// * `page-visit`
	// * `shopping-cart-page-view` - note that 'product_event_detail' should be
	//   set for this unless the shopping cart is empty.
	//
	// This field is not allowed for the following event types:
	//
	// * `home-page-view`
	ProductEventDetail *ProductEventDetail `protobuf:"bytes,4,opt,name=product_event_detail,json=productEventDetail,proto3" json:"product_event_detail,omitempty"`
	// Optional. Only required for ImportUserEvents method. Timestamp of user
	// event created.
	EventTime *timestamp.Timestamp `protobuf:"bytes,5,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
	// Optional. This field should *not* be set when using JavaScript pixel
	// or the Recommendations AI Tag. Defaults to `EVENT_SOURCE_UNSPECIFIED`.
	EventSource          UserEvent_EventSource "" /* 164 byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}              `json:"-"`
	XXX_unrecognized     []byte                `json:"-"`
	XXX_sizecache        int32                 `json:"-"`
}

UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.

func (*UserEvent) Descriptor

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

func (*UserEvent) GetEventDetail

func (m *UserEvent) GetEventDetail() *EventDetail

func (*UserEvent) GetEventSource

func (m *UserEvent) GetEventSource() UserEvent_EventSource

func (*UserEvent) GetEventTime

func (m *UserEvent) GetEventTime() *timestamp.Timestamp

func (*UserEvent) GetEventType

func (m *UserEvent) GetEventType() string

func (*UserEvent) GetProductEventDetail

func (m *UserEvent) GetProductEventDetail() *ProductEventDetail

func (*UserEvent) GetUserInfo

func (m *UserEvent) GetUserInfo() *UserInfo

func (*UserEvent) ProtoMessage

func (*UserEvent) ProtoMessage()

func (*UserEvent) Reset

func (m *UserEvent) Reset()

func (*UserEvent) String

func (m *UserEvent) String() string

func (*UserEvent) XXX_DiscardUnknown

func (m *UserEvent) XXX_DiscardUnknown()

func (*UserEvent) XXX_Marshal

func (m *UserEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UserEvent) XXX_Merge

func (m *UserEvent) XXX_Merge(src proto.Message)

func (*UserEvent) XXX_Size

func (m *UserEvent) XXX_Size() int

func (*UserEvent) XXX_Unmarshal

func (m *UserEvent) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*UserEventImportSummary) Descriptor

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

func (*UserEventImportSummary) GetJoinedEventsCount

func (m *UserEventImportSummary) GetJoinedEventsCount() int64

func (*UserEventImportSummary) GetUnjoinedEventsCount

func (m *UserEventImportSummary) GetUnjoinedEventsCount() int64

func (*UserEventImportSummary) ProtoMessage

func (*UserEventImportSummary) ProtoMessage()

func (*UserEventImportSummary) Reset

func (m *UserEventImportSummary) Reset()

func (*UserEventImportSummary) String

func (m *UserEventImportSummary) String() string

func (*UserEventImportSummary) XXX_DiscardUnknown

func (m *UserEventImportSummary) XXX_DiscardUnknown()

func (*UserEventImportSummary) XXX_Marshal

func (m *UserEventImportSummary) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UserEventImportSummary) XXX_Merge

func (m *UserEventImportSummary) XXX_Merge(src proto.Message)

func (*UserEventImportSummary) XXX_Size

func (m *UserEventImportSummary) XXX_Size() int

func (*UserEventImportSummary) XXX_Unmarshal

func (m *UserEventImportSummary) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

The inline source for the input config for ImportUserEvents method.

func (*UserEventInlineSource) Descriptor

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

func (*UserEventInlineSource) GetUserEvents

func (m *UserEventInlineSource) GetUserEvents() []*UserEvent

func (*UserEventInlineSource) ProtoMessage

func (*UserEventInlineSource) ProtoMessage()

func (*UserEventInlineSource) Reset

func (m *UserEventInlineSource) Reset()

func (*UserEventInlineSource) String

func (m *UserEventInlineSource) String() string

func (*UserEventInlineSource) XXX_DiscardUnknown

func (m *UserEventInlineSource) XXX_DiscardUnknown()

func (*UserEventInlineSource) XXX_Marshal

func (m *UserEventInlineSource) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UserEventInlineSource) XXX_Merge

func (m *UserEventInlineSource) XXX_Merge(src proto.Message)

func (*UserEventInlineSource) XXX_Size

func (m *UserEventInlineSource) XXX_Size() int

func (*UserEventInlineSource) XXX_Unmarshal

func (m *UserEventInlineSource) XXX_Unmarshal(b []byte) error

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

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

type UserEvent_EventSource

type UserEvent_EventSource int32

User event source.

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) EnumDescriptor

func (UserEvent_EventSource) EnumDescriptor() ([]byte, []int)

func (UserEvent_EventSource) String

func (x UserEvent_EventSource) String() string

type 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Information of end users.

func (*UserInfo) Descriptor

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

func (*UserInfo) GetDirectUserRequest

func (m *UserInfo) GetDirectUserRequest() bool

func (*UserInfo) GetIpAddress

func (m *UserInfo) GetIpAddress() string

func (*UserInfo) GetUserAgent

func (m *UserInfo) GetUserAgent() string

func (*UserInfo) GetUserId

func (m *UserInfo) GetUserId() string

func (*UserInfo) GetVisitorId

func (m *UserInfo) GetVisitorId() string

func (*UserInfo) ProtoMessage

func (*UserInfo) ProtoMessage()

func (*UserInfo) Reset

func (m *UserInfo) Reset()

func (*UserInfo) String

func (m *UserInfo) String() string

func (*UserInfo) XXX_DiscardUnknown

func (m *UserInfo) XXX_DiscardUnknown()

func (*UserInfo) XXX_Marshal

func (m *UserInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UserInfo) XXX_Merge

func (m *UserInfo) XXX_Merge(src proto.Message)

func (*UserInfo) XXX_Size

func (m *UserInfo) XXX_Size() int

func (*UserInfo) XXX_Unmarshal

func (m *UserInfo) XXX_Unmarshal(b []byte) error

type 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"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

Request message for WriteUserEvent method.

func (*WriteUserEventRequest) Descriptor

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

func (*WriteUserEventRequest) GetParent

func (m *WriteUserEventRequest) GetParent() string

func (*WriteUserEventRequest) GetUserEvent

func (m *WriteUserEventRequest) GetUserEvent() *UserEvent

func (*WriteUserEventRequest) ProtoMessage

func (*WriteUserEventRequest) ProtoMessage()

func (*WriteUserEventRequest) Reset

func (m *WriteUserEventRequest) Reset()

func (*WriteUserEventRequest) String

func (m *WriteUserEventRequest) String() string

func (*WriteUserEventRequest) XXX_DiscardUnknown

func (m *WriteUserEventRequest) XXX_DiscardUnknown()

func (*WriteUserEventRequest) XXX_Marshal

func (m *WriteUserEventRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WriteUserEventRequest) XXX_Merge

func (m *WriteUserEventRequest) XXX_Merge(src proto.Message)

func (*WriteUserEventRequest) XXX_Size

func (m *WriteUserEventRequest) XXX_Size() int

func (*WriteUserEventRequest) XXX_Unmarshal

func (m *WriteUserEventRequest) XXX_Unmarshal(b []byte) error