Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Product_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "PRIMARY",
		2: "VARIANT",
		3: "COLLECTION",
	}
	Product_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"PRIMARY":          1,
		"VARIANT":          2,
		"COLLECTION":       3,
	}
)

Enum value maps for Product_Type.

View Source
var (
	Product_Availability_name = map[int32]string{
		0: "AVAILABILITY_UNSPECIFIED",
		1: "IN_STOCK",
		2: "OUT_OF_STOCK",
		3: "PREORDER",
		4: "BACKORDER",
	}
	Product_Availability_value = map[string]int32{
		"AVAILABILITY_UNSPECIFIED": 0,
		"IN_STOCK":                 1,
		"OUT_OF_STOCK":             2,
		"PREORDER":                 3,
		"BACKORDER":                4,
	}
)

Enum value maps for Product_Availability.

View Source
var (
	RejoinUserEventsRequest_UserEventRejoinScope_name = map[int32]string{
		0: "USER_EVENT_REJOIN_SCOPE_UNSPECIFIED",
		1: "JOINED_EVENTS",
		2: "UNJOINED_EVENTS",
	}
	RejoinUserEventsRequest_UserEventRejoinScope_value = map[string]int32{
		"USER_EVENT_REJOIN_SCOPE_UNSPECIFIED": 0,
		"JOINED_EVENTS":                       1,
		"UNJOINED_EVENTS":                     2,
	}
)

Enum value maps for RejoinUserEventsRequest_UserEventRejoinScope.

View Source
var File_google_cloud_retail_v2alpha_catalog_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_catalog_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_common_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_export_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_import_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_prediction_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_product_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_product_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_purge_config_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_user_event_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_retail_v2alpha_user_event_service_proto protoreflect.FileDescriptor

Functions

func RegisterCatalogServiceServer

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

func RegisterPredictionServiceServer

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

func RegisterProductServiceServer

func RegisterProductServiceServer(s *grpc.Server, srv ProductServiceServer)

func RegisterUserEventServiceServer

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

Types

type BigQuerySource

type BigQuerySource struct {

	// The project id (can be project # or id) that the BigQuery source is in with
	// a length limit of 128 characters. If not specified, inherits the project
	// id from the parent request.
	ProjectId string `protobuf:"bytes,5,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Required. The BigQuery data set to copy the data from with a length limit
	// of 1,024 characters.
	DatasetId string `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// Required. The BigQuery table to copy the data from with a length limit of
	// 1,024 characters.
	TableId string `protobuf:"bytes,2,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
	// Intermediate Cloud Storage directory used for the import with a length
	// limit of 2,000 characters. Can be specified if one wants to have the
	// BigQuery export to a specific Cloud Storage directory.
	GcsStagingDir string `protobuf:"bytes,3,opt,name=gcs_staging_dir,json=gcsStagingDir,proto3" json:"gcs_staging_dir,omitempty"`
	// The schema to use when parsing the data from the source.
	//
	// Supported values for product imports:
	//
	// * `product` (default): One JSON
	// [Product][google.cloud.retail.v2alpha.Product] per line. Each product must
	//   have a valid [Product.id][google.cloud.retail.v2alpha.Product.id].
	// * `product_merchant_center`: See [Importing catalog data from Merchant
	//   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
	//
	// Supported values for user events imports:
	//
	// * `user_event` (default): One JSON
	// [UserEvent][google.cloud.retail.v2alpha.UserEvent] per line.
	// * `user_event_ga360`: Using
	//   https://support.google.com/analytics/answer/3437719?hl=en.
	DataSchema string `protobuf:"bytes,4,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
	// contains filtered or unexported fields
}

BigQuery source import data from.

func (*BigQuerySource) Descriptor

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

Deprecated: Use BigQuerySource.ProtoReflect.Descriptor instead.

func (*BigQuerySource) GetDataSchema

func (x *BigQuerySource) GetDataSchema() string

func (*BigQuerySource) GetDatasetId

func (x *BigQuerySource) GetDatasetId() string

func (*BigQuerySource) GetGcsStagingDir

func (x *BigQuerySource) GetGcsStagingDir() string

func (*BigQuerySource) GetProjectId

func (x *BigQuerySource) GetProjectId() string

func (*BigQuerySource) GetTableId

func (x *BigQuerySource) GetTableId() string

func (*BigQuerySource) ProtoMessage

func (*BigQuerySource) ProtoMessage()

func (*BigQuerySource) ProtoReflect

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

func (*BigQuerySource) Reset

func (x *BigQuerySource) Reset()

func (*BigQuerySource) String

func (x *BigQuerySource) String() string

type Catalog

type Catalog struct {

	// Required. Immutable. The fully qualified resource name of the catalog.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Immutable. The catalog display name.
	//
	// This field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Required. The product level configuration.
	ProductLevelConfig *ProductLevelConfig `protobuf:"bytes,4,opt,name=product_level_config,json=productLevelConfig,proto3" json:"product_level_config,omitempty"`
	// contains filtered or unexported fields
}

The catalog configuration.

func (*Catalog) Descriptor

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

Deprecated: Use Catalog.ProtoReflect.Descriptor instead.

func (*Catalog) GetDisplayName

func (x *Catalog) GetDisplayName() string

func (*Catalog) GetName

func (x *Catalog) GetName() string

func (*Catalog) GetProductLevelConfig

func (x *Catalog) GetProductLevelConfig() *ProductLevelConfig

func (*Catalog) ProtoMessage

func (*Catalog) ProtoMessage()

func (*Catalog) ProtoReflect

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

func (*Catalog) Reset

func (x *Catalog) Reset()

func (*Catalog) String

func (x *Catalog) String() string

type CatalogServiceClient

type CatalogServiceClient interface {
	// Lists all the [Catalog][google.cloud.retail.v2alpha.Catalog]s associated
	// with the project.
	ListCatalogs(ctx context.Context, in *ListCatalogsRequest, opts ...grpc.CallOption) (*ListCatalogsResponse, error)
	// Updates the [Catalog][google.cloud.retail.v2alpha.Catalog]s.
	UpdateCatalog(ctx context.Context, in *UpdateCatalogRequest, opts ...grpc.CallOption) (*Catalog, 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 {
	// Lists all the [Catalog][google.cloud.retail.v2alpha.Catalog]s associated
	// with the project.
	ListCatalogs(context.Context, *ListCatalogsRequest) (*ListCatalogsResponse, error)
	// Updates the [Catalog][google.cloud.retail.v2alpha.Catalog]s.
	UpdateCatalog(context.Context, *UpdateCatalogRequest) (*Catalog, error)
}

CatalogServiceServer is the server API for CatalogService service.

type CollectUserEventRequest

type CollectUserEventRequest struct {

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

Request message for CollectUserEvent method.

func (*CollectUserEventRequest) Descriptor

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

Deprecated: Use CollectUserEventRequest.ProtoReflect.Descriptor instead.

func (*CollectUserEventRequest) GetEts

func (x *CollectUserEventRequest) GetEts() int64

func (*CollectUserEventRequest) GetParent

func (x *CollectUserEventRequest) GetParent() string

func (*CollectUserEventRequest) GetUri

func (x *CollectUserEventRequest) GetUri() string

func (*CollectUserEventRequest) GetUserEvent

func (x *CollectUserEventRequest) GetUserEvent() string

func (*CollectUserEventRequest) ProtoMessage

func (*CollectUserEventRequest) ProtoMessage()

func (*CollectUserEventRequest) ProtoReflect

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

func (*CollectUserEventRequest) Reset

func (x *CollectUserEventRequest) Reset()

func (*CollectUserEventRequest) String

func (x *CollectUserEventRequest) String() string

type CreateProductRequest

type CreateProductRequest struct {

	// Required. The parent catalog resource name, such as
	// "projects/*/locations/global/catalogs/default_catalog/branches/default_branch".
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The [Product][google.cloud.retail.v2alpha.Product] to create.
	Product *Product `protobuf:"bytes,2,opt,name=product,proto3" json:"product,omitempty"`
	// Required. The ID to use for the
	// [Product][google.cloud.retail.v2alpha.Product], which will become the final
	// component of the [Product.name][google.cloud.retail.v2alpha.Product.name].
	//
	// If the caller does not have permission to create the
	// [Product][google.cloud.retail.v2alpha.Product], regardless of whether or
	// not it exists, a PERMISSION_DENIED error is returned.
	//
	// This field must be unique among all
	// [Product][google.cloud.retail.v2alpha.Product]s with the same
	// [parent][google.cloud.retail.v2alpha.CreateProductRequest.parent].
	// Otherwise, an ALREADY_EXISTS error is returned.
	//
	// This field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	ProductId string `protobuf:"bytes,3,opt,name=product_id,json=productId,proto3" json:"product_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for [CreateProduct][] method.

func (*CreateProductRequest) Descriptor

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

Deprecated: Use CreateProductRequest.ProtoReflect.Descriptor instead.

func (*CreateProductRequest) GetParent

func (x *CreateProductRequest) GetParent() string

func (*CreateProductRequest) GetProduct

func (x *CreateProductRequest) GetProduct() *Product

func (*CreateProductRequest) GetProductId

func (x *CreateProductRequest) GetProductId() string

func (*CreateProductRequest) ProtoMessage

func (*CreateProductRequest) ProtoMessage()

func (*CreateProductRequest) ProtoReflect

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

func (*CreateProductRequest) Reset

func (x *CreateProductRequest) Reset()

func (*CreateProductRequest) String

func (x *CreateProductRequest) String() string

type CustomAttribute

type CustomAttribute struct {

	// The textual values of this custom attribute. For example, `["yellow",
	// "green"]` when the key is "color".
	//
	// At most 400 values are allowed. Empty values are not allowed. Each value
	// must be a UTF-8 encoded string with a length limit of 256 characters.
	// Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Exactly one of [text][google.cloud.retail.v2alpha.CustomAttribute.text] or
	// [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
	// set. Otherwise, an INVALID_ARGUMENT error is returned.
	Text []string `protobuf:"bytes,1,rep,name=text,proto3" json:"text,omitempty"`
	// The numerical values of this custom attribute. For example, `[2.3, 15.4]`
	// when the key is "lengths_cm".
	//
	// At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is
	// returned.
	//
	// Exactly one of [text][google.cloud.retail.v2alpha.CustomAttribute.text] or
	// [numbers][google.cloud.retail.v2alpha.CustomAttribute.numbers] should be
	// set. Otherwise, an INVALID_ARGUMENT error is returned.
	Numbers []float64 `protobuf:"fixed64,2,rep,packed,name=numbers,proto3" json:"numbers,omitempty"`
	// contains filtered or unexported fields
}

A custom attribute that is not explicitly modeled in [Product][google.cloud.retail.v2alpha.Product]].

func (*CustomAttribute) Descriptor

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

Deprecated: Use CustomAttribute.ProtoReflect.Descriptor instead.

func (*CustomAttribute) GetNumbers

func (x *CustomAttribute) GetNumbers() []float64

func (*CustomAttribute) GetText

func (x *CustomAttribute) GetText() []string

func (*CustomAttribute) ProtoMessage

func (*CustomAttribute) ProtoMessage()

func (*CustomAttribute) ProtoReflect

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

func (*CustomAttribute) Reset

func (x *CustomAttribute) Reset()

func (*CustomAttribute) String

func (x *CustomAttribute) String() string

type DeleteProductRequest

type DeleteProductRequest struct {

	// Required. Full resource name of
	// [Product][google.cloud.retail.v2alpha.Product], such as
	// "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
	//
	// If the caller does not have permission to delete the
	// [Product][google.cloud.retail.v2alpha.Product], regardless of whether or
	// not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Product][google.cloud.retail.v2alpha.Product] to delete does not
	// exist, a NOT_FOUND error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [DeleteProduct][] method.

func (*DeleteProductRequest) Descriptor

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

Deprecated: Use DeleteProductRequest.ProtoReflect.Descriptor instead.

func (*DeleteProductRequest) GetName

func (x *DeleteProductRequest) GetName() string

func (*DeleteProductRequest) ProtoMessage

func (*DeleteProductRequest) ProtoMessage()

func (*DeleteProductRequest) ProtoReflect

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

func (*DeleteProductRequest) Reset

func (x *DeleteProductRequest) Reset()

func (*DeleteProductRequest) String

func (x *DeleteProductRequest) String() string

type ExportErrorsConfig

type ExportErrorsConfig struct {

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

Configuration of destination for Export related errors.

func (*ExportErrorsConfig) Descriptor

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

Deprecated: Use ExportErrorsConfig.ProtoReflect.Descriptor instead.

func (*ExportErrorsConfig) GetDestination

func (m *ExportErrorsConfig) GetDestination() isExportErrorsConfig_Destination

func (*ExportErrorsConfig) GetGcsPrefix

func (x *ExportErrorsConfig) GetGcsPrefix() string

func (*ExportErrorsConfig) ProtoMessage

func (*ExportErrorsConfig) ProtoMessage()

func (*ExportErrorsConfig) ProtoReflect

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

func (*ExportErrorsConfig) Reset

func (x *ExportErrorsConfig) Reset()

func (*ExportErrorsConfig) String

func (x *ExportErrorsConfig) String() string

type ExportErrorsConfig_GcsPrefix

type ExportErrorsConfig_GcsPrefix struct {
	// Google Cloud Storage path for import errors. This must be an empty,
	// existing Cloud Storage bucket. Export errors will be written to a file in
	// this bucket, one per line, as a JSON-encoded
	// `google.rpc.Status` message.
	GcsPrefix string `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}

type ExportMetadata

type ExportMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ExportMetadata) Descriptor

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

Deprecated: Use ExportMetadata.ProtoReflect.Descriptor instead.

func (*ExportMetadata) GetCreateTime

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

func (*ExportMetadata) GetUpdateTime

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

func (*ExportMetadata) ProtoMessage

func (*ExportMetadata) ProtoMessage()

func (*ExportMetadata) ProtoReflect

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

func (*ExportMetadata) Reset

func (x *ExportMetadata) Reset()

func (*ExportMetadata) String

func (x *ExportMetadata) String() string

type ExportProductsRequest

type ExportProductsRequest struct {

	// Required.
	// "projects/1234/locations/global/catalogs/default_catalog/branches/default_branch"
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The desired output location of the data.
	OutputConfig *OutputConfig `protobuf:"bytes,2,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
	// Filtering expression to specify restrictions over
	// returned products. This is a sequence of terms, where each term applies
	// some kind of a restriction to the returned products. Use this expression to
	// restrict results to a specific time range, tag, stock state or filter
	// products by product type.
	//    eg: lastModifiedTime > "2012-04-23T18:25:43.511Z"
	//    lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary
	//
	//   We expect only 4 types of fields:
	//
	//    * lastModifiedTime: this can be specified a maximum of 2 times, once
	//    with a
	//      less than operator and once with a greater than operator. The
	//      lastModifiedTime restrict should result in one contiguous valid last
	//      modified time range.
	//
	//    * productType: supported values are 'primary' and 'variant'. Boolean
	//    operators `OR` and `NOT` are supported if the
	//      expression is enclosed in parentheses, and must be separated from the
	//      productType values by a space.
	//
	//    * availability: supported values are IN_STOCK, OUT_OF_STOCK,
	//    PREORDER and BACKORDER. Boolean operators `OR` and `NOT` are
	//    supported if the
	//      expression is enclosed in parentheses, and must be separated from the
	//      availability values by a space.
	//
	//    * Tag expressions. Restricts output to products that match all of the
	//      specified tags. Boolean operators `OR` and `NOT` are supported if the
	//      expression is enclosed in parentheses, and must be separated from the
	//      tag values by a space. `-"tagA"` is also supported and is equivalent
	//      to `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded
	//      strings with a size limit of 1,000 characters.
	//
	//   Some examples of valid filters expressions:
	//
	//   * Example 1: lastModifiedTime > "2012-04-23T18:25:43.511Z"
	//             lastModifiedTime < "2012-04-23T18:30:43.511Z"
	//   * Example 2: lastModifiedTime > "2012-04-23T18:25:43.511Z"
	//             productType = "variant"
	//   * Example 3: tag=("Red" OR "Blue") tag="New-Arrival"
	//             tag=(NOT "promotional")
	//             productType = "primary" lastModifiedTime <
	//             "2018-04-23T18:30:43.511Z"
	//   * Example 4: lastModifiedTime > "2012-04-23T18:25:43.511Z"
	//   * Example 5: availability = (IN_STOCK OR BACKORDER)
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for ExportProducts method.

func (*ExportProductsRequest) Descriptor

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

Deprecated: Use ExportProductsRequest.ProtoReflect.Descriptor instead.

func (*ExportProductsRequest) GetFilter

func (x *ExportProductsRequest) GetFilter() string

func (*ExportProductsRequest) GetOutputConfig

func (x *ExportProductsRequest) GetOutputConfig() *OutputConfig

func (*ExportProductsRequest) GetParent

func (x *ExportProductsRequest) GetParent() string

func (*ExportProductsRequest) ProtoMessage

func (*ExportProductsRequest) ProtoMessage()

func (*ExportProductsRequest) ProtoReflect

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

func (*ExportProductsRequest) Reset

func (x *ExportProductsRequest) Reset()

func (*ExportProductsRequest) String

func (x *ExportProductsRequest) String() string

type ExportProductsResponse

type ExportProductsResponse 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 *ExportErrorsConfig `protobuf:"bytes,2,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// contains filtered or unexported fields
}

Response of the ExportProductsRequest. 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 (*ExportProductsResponse) Descriptor

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

Deprecated: Use ExportProductsResponse.ProtoReflect.Descriptor instead.

func (*ExportProductsResponse) GetErrorSamples

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

func (*ExportProductsResponse) GetErrorsConfig

func (x *ExportProductsResponse) GetErrorsConfig() *ExportErrorsConfig

func (*ExportProductsResponse) ProtoMessage

func (*ExportProductsResponse) ProtoMessage()

func (*ExportProductsResponse) ProtoReflect

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

func (*ExportProductsResponse) Reset

func (x *ExportProductsResponse) Reset()

func (*ExportProductsResponse) String

func (x *ExportProductsResponse) String() string

type ExportUserEventsRequest

type ExportUserEventsRequest struct {

	// Required. "projects/1234/locations/global/catalogs/default_catalog"
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The desired output location of the data.
	OutputConfig *OutputConfig `protobuf:"bytes,2,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
	// 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: 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.
	//
	//    * eventsMissingCatalogItems: specifying 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 = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"
	//   * Example 4: eventTime > "2012-04-23T18:25:43.511Z"
	//   * Example 5: eventType = (search OR impression)
	//   * Example 6: eventsMissingCatalogItems
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for ExportUserEvents method.

func (*ExportUserEventsRequest) Descriptor

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

Deprecated: Use ExportUserEventsRequest.ProtoReflect.Descriptor instead.

func (*ExportUserEventsRequest) GetFilter

func (x *ExportUserEventsRequest) GetFilter() string

func (*ExportUserEventsRequest) GetOutputConfig

func (x *ExportUserEventsRequest) GetOutputConfig() *OutputConfig

func (*ExportUserEventsRequest) GetParent

func (x *ExportUserEventsRequest) GetParent() string

func (*ExportUserEventsRequest) ProtoMessage

func (*ExportUserEventsRequest) ProtoMessage()

func (*ExportUserEventsRequest) ProtoReflect

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

func (*ExportUserEventsRequest) Reset

func (x *ExportUserEventsRequest) Reset()

func (*ExportUserEventsRequest) String

func (x *ExportUserEventsRequest) String() string

type ExportUserEventsResponse

type ExportUserEventsResponse 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 *ExportErrorsConfig `protobuf:"bytes,2,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// contains filtered or unexported fields
}

Response of the ExportUserEventsRequest. 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 (*ExportUserEventsResponse) Descriptor

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

Deprecated: Use ExportUserEventsResponse.ProtoReflect.Descriptor instead.

func (*ExportUserEventsResponse) GetErrorSamples

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

func (*ExportUserEventsResponse) GetErrorsConfig

func (x *ExportUserEventsResponse) GetErrorsConfig() *ExportErrorsConfig

func (*ExportUserEventsResponse) ProtoMessage

func (*ExportUserEventsResponse) ProtoMessage()

func (*ExportUserEventsResponse) ProtoReflect

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

func (*ExportUserEventsResponse) Reset

func (x *ExportUserEventsResponse) Reset()

func (*ExportUserEventsResponse) String

func (x *ExportUserEventsResponse) String() string

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 product 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"`
	// The schema to use when parsing the data from the source.
	//
	// Supported values for product imports:
	//
	// * `product` (default): One JSON
	// [Product][google.cloud.retail.v2alpha.Product] per line. Each product must
	//   have a valid [Product.id][google.cloud.retail.v2alpha.Product.id].
	// * `product_merchant_center`: See [Importing catalog data from Merchant
	//   Center](/retail/recommendations-ai/docs/upload-catalog#mc).
	//
	// Supported values for user events imports:
	//
	// * `user_event` (default): One JSON
	// [UserEvent][google.cloud.retail.v2alpha.UserEvent] per line.
	// * `user_event_ga360`: Using
	//   https://support.google.com/analytics/answer/3437719?hl=en.
	DataSchema string `protobuf:"bytes,2,opt,name=data_schema,json=dataSchema,proto3" json:"data_schema,omitempty"`
	// contains filtered or unexported fields
}

Google Cloud Storage location for input content. format.

func (*GcsSource) Descriptor

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

Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.

func (*GcsSource) GetDataSchema

func (x *GcsSource) GetDataSchema() string

func (*GcsSource) GetInputUris

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

func (*GcsSource) ProtoMessage

func (*GcsSource) ProtoMessage()

func (*GcsSource) ProtoReflect

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

func (*GcsSource) Reset

func (x *GcsSource) Reset()

func (*GcsSource) String

func (x *GcsSource) String() string

type GetProductRequest

type GetProductRequest struct {

	// Required. Full resource name of
	// [Product][google.cloud.retail.v2alpha.Product], such as
	// "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
	//
	// If the caller does not have permission to access the
	// [Product][google.cloud.retail.v2alpha.Product], regardless of whether or
	// not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the requested [Product][google.cloud.retail.v2alpha.Product] does not
	// exist, a NOT_FOUND error is returned.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [GetProduct][] method.

func (*GetProductRequest) Descriptor

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

Deprecated: Use GetProductRequest.ProtoReflect.Descriptor instead.

func (*GetProductRequest) GetName

func (x *GetProductRequest) GetName() string

func (*GetProductRequest) ProtoMessage

func (*GetProductRequest) ProtoMessage()

func (*GetProductRequest) ProtoReflect

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

func (*GetProductRequest) Reset

func (x *GetProductRequest) Reset()

func (*GetProductRequest) String

func (x *GetProductRequest) String() string

type Image

type Image struct {

	// Required. URI of the image.
	//
	// This field must be a valid UTF-8 encoded URI with a length limit of 5,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Google Merchant Center property
	// [image_link](https://support.google.com/merchants/answer/6324350).
	// Schema.org property [Product.image](https://schema.org/image).
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Height of the image in number of pixels.
	//
	// This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is
	// returned.
	Height int32 `protobuf:"varint,2,opt,name=height,proto3" json:"height,omitempty"`
	// Width of the image in number of pixels.
	//
	// This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is
	// returned.
	Width int32 `protobuf:"varint,3,opt,name=width,proto3" json:"width,omitempty"`
	// contains filtered or unexported fields
}

[Product][google.cloud.retail.v2alpha.Product] thumbnail/detail image.

func (*Image) Descriptor

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

Deprecated: Use Image.ProtoReflect.Descriptor instead.

func (*Image) GetHeight

func (x *Image) GetHeight() int32

func (*Image) GetUri

func (x *Image) GetUri() string

func (*Image) GetWidth

func (x *Image) GetWidth() int32

func (*Image) ProtoMessage

func (*Image) ProtoMessage()

func (*Image) ProtoReflect

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

func (*Image) Reset

func (x *Image) Reset()

func (*Image) String

func (x *Image) String() string

type ImportErrorsConfig

type ImportErrorsConfig struct {

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

Configuration of destination for Import related errors.

func (*ImportErrorsConfig) Descriptor

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

Deprecated: Use ImportErrorsConfig.ProtoReflect.Descriptor instead.

func (*ImportErrorsConfig) GetDestination

func (m *ImportErrorsConfig) GetDestination() isImportErrorsConfig_Destination

func (*ImportErrorsConfig) GetGcsPrefix

func (x *ImportErrorsConfig) GetGcsPrefix() string

func (*ImportErrorsConfig) ProtoMessage

func (*ImportErrorsConfig) ProtoMessage()

func (*ImportErrorsConfig) ProtoReflect

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

func (*ImportErrorsConfig) Reset

func (x *ImportErrorsConfig) Reset()

func (*ImportErrorsConfig) String

func (x *ImportErrorsConfig) String() string

type ImportErrorsConfig_GcsPrefix

type ImportErrorsConfig_GcsPrefix struct {
	// Google Cloud Storage path for import errors. This must be an empty,
	// existing Cloud Storage bucket. Import errors will be written to a file in
	// this bucket, one per line, as a JSON-encoded
	// `google.rpc.Status` message.
	GcsPrefix string `protobuf:"bytes,1,opt,name=gcs_prefix,json=gcsPrefix,proto3,oneof"`
}

type ImportMetadata

type ImportMetadata struct {

	// Operation create time.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Operation last update time. If the operation is done, this is also the
	// finish time.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Count of entries that were processed successfully.
	SuccessCount int64 `protobuf:"varint,3,opt,name=success_count,json=successCount,proto3" json:"success_count,omitempty"`
	// Count of entries that encountered errors while processing.
	FailureCount int64 `protobuf:"varint,4,opt,name=failure_count,json=failureCount,proto3" json:"failure_count,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ImportMetadata) Descriptor

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

Deprecated: Use ImportMetadata.ProtoReflect.Descriptor instead.

func (*ImportMetadata) GetCreateTime

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

func (*ImportMetadata) GetFailureCount

func (x *ImportMetadata) GetFailureCount() int64

func (*ImportMetadata) GetSuccessCount

func (x *ImportMetadata) GetSuccessCount() int64

func (*ImportMetadata) GetUpdateTime

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

func (*ImportMetadata) ProtoMessage

func (*ImportMetadata) ProtoMessage()

func (*ImportMetadata) ProtoReflect

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

func (*ImportMetadata) Reset

func (x *ImportMetadata) Reset()

func (*ImportMetadata) String

func (x *ImportMetadata) String() string

type ImportProductsRequest

type ImportProductsRequest struct {

	// Required.
	// "projects/1234/locations/global/catalogs/default_catalog/branches/default_branch"
	//
	// If no updateMask is specified, requires products.create permission.
	// If updateMask is specified, requires products.update permission.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The desired input location of the data.
	InputConfig *ProductInputConfig `protobuf:"bytes,2,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// The desired location of errors incurred during the Import.
	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,3,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// Indicates which fields in the provided imported 'products' to update. If
	// not set, will by default update all fields.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for Import methods.

func (*ImportProductsRequest) Descriptor

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

Deprecated: Use ImportProductsRequest.ProtoReflect.Descriptor instead.

func (*ImportProductsRequest) GetErrorsConfig

func (x *ImportProductsRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportProductsRequest) GetInputConfig

func (x *ImportProductsRequest) GetInputConfig() *ProductInputConfig

func (*ImportProductsRequest) GetParent

func (x *ImportProductsRequest) GetParent() string

func (*ImportProductsRequest) GetUpdateMask

func (x *ImportProductsRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*ImportProductsRequest) ProtoMessage

func (*ImportProductsRequest) ProtoMessage()

func (*ImportProductsRequest) ProtoReflect

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

func (*ImportProductsRequest) Reset

func (x *ImportProductsRequest) Reset()

func (*ImportProductsRequest) String

func (x *ImportProductsRequest) String() string

type ImportProductsResponse

type ImportProductsResponse struct {

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

Response of the [ImportProductsRequest][google.cloud.retail.v2alpha.ImportProductsRequest]. 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 (*ImportProductsResponse) Descriptor

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

Deprecated: Use ImportProductsResponse.ProtoReflect.Descriptor instead.

func (*ImportProductsResponse) GetErrorSamples

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

func (*ImportProductsResponse) GetErrorsConfig

func (x *ImportProductsResponse) GetErrorsConfig() *ImportErrorsConfig

func (*ImportProductsResponse) ProtoMessage

func (*ImportProductsResponse) ProtoMessage()

func (*ImportProductsResponse) ProtoReflect

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

func (*ImportProductsResponse) Reset

func (x *ImportProductsResponse) Reset()

func (*ImportProductsResponse) String

func (x *ImportProductsResponse) String() string

type ImportUserEventsRequest

type ImportUserEventsRequest struct {

	// Required. "projects/1234/locations/global/catalogs/default_catalog"
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The desired input location of the data.
	InputConfig *UserEventInputConfig `protobuf:"bytes,2,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// The desired location of errors incurred during the Import. Cannot be set
	// for inline user event imports.
	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,3,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ImportUserEvents request.

func (*ImportUserEventsRequest) Descriptor

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

Deprecated: Use ImportUserEventsRequest.ProtoReflect.Descriptor instead.

func (*ImportUserEventsRequest) GetErrorsConfig

func (x *ImportUserEventsRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportUserEventsRequest) GetInputConfig

func (x *ImportUserEventsRequest) GetInputConfig() *UserEventInputConfig

func (*ImportUserEventsRequest) GetParent

func (x *ImportUserEventsRequest) GetParent() string

func (*ImportUserEventsRequest) ProtoMessage

func (*ImportUserEventsRequest) ProtoMessage()

func (*ImportUserEventsRequest) ProtoReflect

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

func (*ImportUserEventsRequest) Reset

func (x *ImportUserEventsRequest) Reset()

func (*ImportUserEventsRequest) String

func (x *ImportUserEventsRequest) String() string

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"`
	// contains filtered or unexported fields
}

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

func (*ImportUserEventsResponse) Descriptor

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

Deprecated: Use ImportUserEventsResponse.ProtoReflect.Descriptor instead.

func (*ImportUserEventsResponse) GetErrorSamples

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

func (*ImportUserEventsResponse) GetErrorsConfig

func (x *ImportUserEventsResponse) GetErrorsConfig() *ImportErrorsConfig

func (*ImportUserEventsResponse) GetImportSummary

func (x *ImportUserEventsResponse) GetImportSummary() *UserEventImportSummary

func (*ImportUserEventsResponse) ProtoMessage

func (*ImportUserEventsResponse) ProtoMessage()

func (*ImportUserEventsResponse) ProtoReflect

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

func (*ImportUserEventsResponse) Reset

func (x *ImportUserEventsResponse) Reset()

func (*ImportUserEventsResponse) String

func (x *ImportUserEventsResponse) String() string

type ListCatalogsRequest

type ListCatalogsRequest struct {

	// Required. The account resource name with an associated location.
	//
	// If the caller does not have permission to list
	// [Catalog][google.cloud.retail.v2alpha.Catalog]s under this location,
	// regardless of whether or not this location exists, a PERMISSION_DENIED
	// error is returned.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Maximum number of [Catalog][google.cloud.retail.v2alpha.Catalog]s to
	// return. If unspecified, defaults to 50. The maximum allowed value is 1000.
	// Values above 1000 will be coerced to 1000.
	//
	// If this field is negative, an INVALID_ARGUMENT is returned.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token
	// [ListCatalogsResponse.next_page_token][google.cloud.retail.v2alpha.ListCatalogsResponse.next_page_token],
	// received from a previous
	// [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs]
	// must match the call that provided the page token. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs] method.

func (*ListCatalogsRequest) Descriptor

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

Deprecated: Use ListCatalogsRequest.ProtoReflect.Descriptor instead.

func (*ListCatalogsRequest) GetPageSize

func (x *ListCatalogsRequest) GetPageSize() int32

func (*ListCatalogsRequest) GetPageToken

func (x *ListCatalogsRequest) GetPageToken() string

func (*ListCatalogsRequest) GetParent

func (x *ListCatalogsRequest) GetParent() string

func (*ListCatalogsRequest) ProtoMessage

func (*ListCatalogsRequest) ProtoMessage()

func (*ListCatalogsRequest) ProtoReflect

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

func (*ListCatalogsRequest) Reset

func (x *ListCatalogsRequest) Reset()

func (*ListCatalogsRequest) String

func (x *ListCatalogsRequest) String() string

type ListCatalogsResponse

type ListCatalogsResponse struct {

	// All the customer's [Catalog][google.cloud.retail.v2alpha.Catalog]s.
	Catalogs []*Catalog `protobuf:"bytes,1,rep,name=catalogs,proto3" json:"catalogs,omitempty"`
	// A token that can be sent as
	// [ListCatalogsRequest.page_token][google.cloud.retail.v2alpha.ListCatalogsRequest.page_token]
	// to retrieve the next page. If this field is omitted, there are no
	// subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for [CatalogService.ListCatalogs][google.cloud.retail.v2alpha.CatalogService.ListCatalogs] method.

func (*ListCatalogsResponse) Descriptor

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

Deprecated: Use ListCatalogsResponse.ProtoReflect.Descriptor instead.

func (*ListCatalogsResponse) GetCatalogs

func (x *ListCatalogsResponse) GetCatalogs() []*Catalog

func (*ListCatalogsResponse) GetNextPageToken

func (x *ListCatalogsResponse) GetNextPageToken() string

func (*ListCatalogsResponse) ProtoMessage

func (*ListCatalogsResponse) ProtoMessage()

func (*ListCatalogsResponse) ProtoReflect

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

func (*ListCatalogsResponse) Reset

func (x *ListCatalogsResponse) Reset()

func (*ListCatalogsResponse) String

func (x *ListCatalogsResponse) String() string

type OutputConfig

type OutputConfig struct {

	// The configuration of destination for holding output data.
	//
	// Types that are assignable to Destination:
	//	*OutputConfig_GcsDestination_
	//	*OutputConfig_BigqueryDestination
	Destination isOutputConfig_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

The output configuration setting.

func (*OutputConfig) Descriptor

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

Deprecated: Use OutputConfig.ProtoReflect.Descriptor instead.

func (*OutputConfig) GetBigqueryDestination

func (x *OutputConfig) GetBigqueryDestination() *OutputConfig_BigQueryDestination

func (*OutputConfig) GetDestination

func (m *OutputConfig) GetDestination() isOutputConfig_Destination

func (*OutputConfig) GetGcsDestination

func (x *OutputConfig) GetGcsDestination() *OutputConfig_GcsDestination

func (*OutputConfig) ProtoMessage

func (*OutputConfig) ProtoMessage()

func (*OutputConfig) ProtoReflect

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

func (*OutputConfig) Reset

func (x *OutputConfig) Reset()

func (*OutputConfig) String

func (x *OutputConfig) String() string

type OutputConfig_BigQueryDestination

type OutputConfig_BigQueryDestination struct {

	// The ID of a BigQuery Dataset.
	DatasetId string `protobuf:"bytes,1,opt,name=dataset_id,json=datasetId,proto3" json:"dataset_id,omitempty"`
	// contains filtered or unexported fields
}

The BigQuery output destination configuration.

func (*OutputConfig_BigQueryDestination) Descriptor

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

Deprecated: Use OutputConfig_BigQueryDestination.ProtoReflect.Descriptor instead.

func (*OutputConfig_BigQueryDestination) GetDatasetId

func (x *OutputConfig_BigQueryDestination) GetDatasetId() string

func (*OutputConfig_BigQueryDestination) ProtoMessage

func (*OutputConfig_BigQueryDestination) ProtoMessage()

func (*OutputConfig_BigQueryDestination) ProtoReflect

func (*OutputConfig_BigQueryDestination) Reset

func (*OutputConfig_BigQueryDestination) String

type OutputConfig_BigqueryDestination

type OutputConfig_BigqueryDestination struct {
	// The BigQuery location where the output is to be written to.
	BigqueryDestination *OutputConfig_BigQueryDestination `protobuf:"bytes,2,opt,name=bigquery_destination,json=bigqueryDestination,proto3,oneof"`
}

type OutputConfig_GcsDestination

type OutputConfig_GcsDestination struct {

	// Required. The output uri prefix for saving output data to json files.
	// Some mapping examples are as follows:
	// output_uri_prefix         sample output(assuming the object is foo.json)
	// ========================  =============================================
	// gs://bucket/              gs://bucket/foo.json
	// gs://bucket/folder/       gs://bucket/folder/foo.json
	// gs://bucket/folder/item_  gs://bucket/folder/item_foo.json
	OutputUriPrefix string `protobuf:"bytes,1,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"`
	// contains filtered or unexported fields
}

The Google Cloud Storage output destination configuration.

func (*OutputConfig_GcsDestination) Descriptor

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

Deprecated: Use OutputConfig_GcsDestination.ProtoReflect.Descriptor instead.

func (*OutputConfig_GcsDestination) GetOutputUriPrefix

func (x *OutputConfig_GcsDestination) GetOutputUriPrefix() string

func (*OutputConfig_GcsDestination) ProtoMessage

func (*OutputConfig_GcsDestination) ProtoMessage()

func (*OutputConfig_GcsDestination) ProtoReflect

func (*OutputConfig_GcsDestination) Reset

func (x *OutputConfig_GcsDestination) Reset()

func (*OutputConfig_GcsDestination) String

func (x *OutputConfig_GcsDestination) String() string

type OutputConfig_GcsDestination_

type OutputConfig_GcsDestination_ struct {
	// The Google Cloud Storage location where the output is to be written to.
	GcsDestination *OutputConfig_GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}

type PredictRequest

type PredictRequest struct {

	// Required. Full resource name of the format:
	// {name=projects/*/locations/global/catalogs/default_catalog/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 products frequently bought together with one or
	//   more  products 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 products like this.
	//
	// * `recently_viewed_default`: Returns up to 75 products recently viewed by
	//   the specified `userId` or `visitorId`, most recent ones first. Returns
	//   nothing if neither of them has viewed any products yet. For example -
	//   Recently viewed.
	//
	// The full list of available placements can be seen at
	// https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
	Placement string `protobuf:"bytes,1,opt,name=placement,proto3" json:"placement,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"`
	// Maximum number of results to return per page. Set this property
	// to the number of prediction results needed. If zero, the service will
	// choose a reasonable default. The maximum allowed value is 100. Values
	// above 100 will be coerced to 100.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The previous PredictResponse.next_page_token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filter for restricting prediction results with a length limit of 5,000
	// characters. Accepts values for tags and the `filterOutOfStockItems` flag.
	//
	//  * Tag expressions. Restricts predictions to products that match all of the
	//    specified tags. Boolean operators `OR` and `NOT` are supported if the
	//    expression is enclosed in parentheses, and must be separated from the
	//    tag values by a space. `-"tagA"` is also supported and is equivalent to
	//    `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
	//    with a size limit of 1,000 characters.
	//
	//  * filterOutOfStockItems. Restricts predictions to products that do not
	//  have a
	//    stockState value of OUT_OF_STOCK.
	//
	// Examples:
	//
	//  * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
	//  * filterOutOfStockItems  tag=(-"promotional")
	//  * filterOutOfStockItems
	//
	// If your filter blocks all prediction results, nothing will be returned. If
	// you want generic (unfiltered) popular products to be returned instead, set
	// `strictFiltering` to false in `PredictRequest.params`.
	Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
	// Use validate only mode for this prediction query. If set to true, a
	// dummy model will be used that returns arbitrary products.
	// Note that the validate only mode should only be used for testing the API,
	// or if the model is not ready.
	ValidateOnly bool `protobuf:"varint,6,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// Additional domain specific parameters for the predictions.
	//
	// Allowed values:
	//
	// * `returnProduct`: Boolean. If set to true, the associated product
	//    object will be returned in the `results.metadata` field in the
	//    prediction response.
	// * `returnScore`: Boolean. If set to true, the prediction 'score'
	//    corresponding to each returned product will be set in the
	//    `results.metadata` field in the prediction response. The given
	//    'score' indicates the probability of an product being clicked/purchased
	//    given the user's context and history.
	// * `strictFiltering`: Boolean. True by default. If set to false, the service
	//    will return generic (unfiltered) popular products instead of empty if
	//    your filter blocks all prediction results.
	Params map[string]*structpb.Value `` /* 153-byte string literal not displayed */
	// 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 */
	// contains filtered or unexported fields
}

Request message for Predict method.

func (*PredictRequest) Descriptor

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

Deprecated: Use PredictRequest.ProtoReflect.Descriptor instead.

func (*PredictRequest) GetFilter

func (x *PredictRequest) GetFilter() string

func (*PredictRequest) GetLabels

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

func (*PredictRequest) GetPageSize

func (x *PredictRequest) GetPageSize() int32

func (*PredictRequest) GetPageToken

func (x *PredictRequest) GetPageToken() string

func (*PredictRequest) GetParams

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

func (*PredictRequest) GetPlacement

func (x *PredictRequest) GetPlacement() string

func (*PredictRequest) GetUserEvent

func (x *PredictRequest) GetUserEvent() *UserEvent

func (*PredictRequest) GetValidateOnly

func (x *PredictRequest) GetValidateOnly() bool

func (*PredictRequest) ProtoMessage

func (*PredictRequest) ProtoMessage()

func (*PredictRequest) ProtoReflect

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

func (*PredictRequest) Reset

func (x *PredictRequest) Reset()

func (*PredictRequest) String

func (x *PredictRequest) String() string

type PredictResponse

type PredictResponse struct {

	// A list of recommended products. The order represents the ranking (from the
	// most relevant product to the least).
	Results []*PredictResponse_PredictionResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// A unique attribution token. This should be included in the
	// [UserEvent][google.cloud.retail.v2alpha.UserEvent] logs resulting from this
	// recommendation, which enables accurate attribution of recommendation model
	// performance.
	AttributionToken string `protobuf:"bytes,2,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
	// IDs of products in the request that were missing from the inventory.
	MissingIds []string `protobuf:"bytes,3,rep,name=missing_ids,json=missingIds,proto3" json:"missing_ids,omitempty"`
	// True if the validateOnly property was set in the request.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Response message for predict method.

func (*PredictResponse) Descriptor

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

Deprecated: Use PredictResponse.ProtoReflect.Descriptor instead.

func (*PredictResponse) GetAttributionToken

func (x *PredictResponse) GetAttributionToken() string

func (*PredictResponse) GetMissingIds

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

func (*PredictResponse) GetResults

func (*PredictResponse) GetValidateOnly

func (x *PredictResponse) GetValidateOnly() bool

func (*PredictResponse) ProtoMessage

func (*PredictResponse) ProtoMessage()

func (*PredictResponse) ProtoReflect

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

func (*PredictResponse) Reset

func (x *PredictResponse) Reset()

func (*PredictResponse) String

func (x *PredictResponse) String() string

type PredictResponse_PredictionResult

type PredictResponse_PredictionResult struct {

	// ID of the recommended product
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Additional product metadata / annotations.
	//
	// Possible values:
	//
	// * `product`: JSON representation of the product. Will be set if
	//   `returnProduct` is set to true in `PredictRequest.params`.
	// * `score`: Prediction score in double value. Will be set if
	//   `returnScore` is set to true in `PredictRequest.params`.
	Metadata map[string]*structpb.Value `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

PredictionResult represents the recommendation prediction results.

func (*PredictResponse_PredictionResult) Descriptor

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

Deprecated: Use PredictResponse_PredictionResult.ProtoReflect.Descriptor instead.

func (*PredictResponse_PredictionResult) GetId

func (*PredictResponse_PredictionResult) GetMetadata

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

func (*PredictResponse_PredictionResult) ProtoMessage

func (*PredictResponse_PredictionResult) ProtoMessage()

func (*PredictResponse_PredictionResult) ProtoReflect

func (*PredictResponse_PredictionResult) Reset

func (*PredictResponse_PredictionResult) String

type PredictionServiceClient

type PredictionServiceClient interface {
	// Makes a recommendation prediction.
	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.
	Predict(context.Context, *PredictRequest) (*PredictResponse, error)
}

PredictionServiceServer is the server API for PredictionService service.

type PriceInfo

type PriceInfo struct {

	// The 3-letter currency code defined in [ISO
	// 4217](https://www.iso.org/iso-4217-currency-codes.html).
	//
	// If this field is an unrecognizable currency code, an INVALID_ARGUMENT
	// error is returned.
	CurrencyCode string `protobuf:"bytes,1,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// Price of the product.
	//
	// Google Merchant Center property
	// [price](https://support.google.com/merchants/answer/6324371). Schema.org
	// property [Offer.priceSpecification](https://schema.org/priceSpecification).
	Price float32 `protobuf:"fixed32,2,opt,name=price,proto3" json:"price,omitempty"`
	// Price of the product without any discount. If zero, by default set to be
	// the [price][google.cloud.retail.v2alpha.PriceInfo.price].
	OriginalPrice float32 `protobuf:"fixed32,3,opt,name=original_price,json=originalPrice,proto3" json:"original_price,omitempty"`
	// The costs associated with the sale of a particular product. Used for gross
	// profit reporting.
	//
	// * Profit = [price][google.cloud.retail.v2alpha.PriceInfo.price] -
	// [cost][google.cloud.retail.v2alpha.PriceInfo.cost]
	//
	// Google Merchant Center property
	// [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895).
	Cost float32 `protobuf:"fixed32,4,opt,name=cost,proto3" json:"cost,omitempty"`
	// contains filtered or unexported fields
}

The price information of a [Product][google.cloud.retail.v2alpha.Product].

func (*PriceInfo) Descriptor

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

Deprecated: Use PriceInfo.ProtoReflect.Descriptor instead.

func (*PriceInfo) GetCost

func (x *PriceInfo) GetCost() float32

func (*PriceInfo) GetCurrencyCode

func (x *PriceInfo) GetCurrencyCode() string

func (*PriceInfo) GetOriginalPrice

func (x *PriceInfo) GetOriginalPrice() float32

func (*PriceInfo) GetPrice

func (x *PriceInfo) GetPrice() float32

func (*PriceInfo) ProtoMessage

func (*PriceInfo) ProtoMessage()

func (*PriceInfo) ProtoReflect

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

func (*PriceInfo) Reset

func (x *PriceInfo) Reset()

func (*PriceInfo) String

func (x *PriceInfo) String() string

type Product

type Product struct {

	// Immutable. Full resource name of the product, such as
	// "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id".
	//
	// The branch ID must be "default_branch".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Immutable. [Product][google.cloud.retail.v2alpha.Product] identifier, which
	// is the final component of [name][google.cloud.retail.v2alpha.Product.name].
	// For example, this field is "id_1", if
	// [name][google.cloud.retail.v2alpha.Product.name] is
	// "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1".
	//
	// This field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Google Merchant Center property
	// [id](https://support.google.com/merchants/answer/6324405). Schema.org
	// Property [Product.sku](https://schema.org/sku).
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// Immutable. The type of the product. This field is output-only.
	Type Product_Type `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.retail.v2alpha.Product_Type" json:"type,omitempty"`
	// Variant group identifier. Must be an
	// [id][google.cloud.retail.v2alpha.Product.id], with the same parent branch
	// with this product. Otherwise, an error is thrown.
	//
	// For [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2alpha.Product]s, this field can only be
	// empty or set to the same value as
	// [id][google.cloud.retail.v2alpha.Product.id].
	//
	// For VARIANT [Product][google.cloud.retail.v2alpha.Product]s, this field
	// cannot be empty. A maximum of 2,000 products are allowed to share the same
	// [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2alpha.Product]. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	//
	// Google Merchant Center Property
	// [item_group_id](https://support.google.com/merchants/answer/6324507).
	// Schema.org Property
	// [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
	//
	// This field must be enabled before it can be used. [Learn
	// more](/recommendations-ai/docs/catalog#item-group-id).
	PrimaryProductId string `protobuf:"bytes,4,opt,name=primary_product_id,json=primaryProductId,proto3" json:"primary_product_id,omitempty"`
	// Product categories. This field is repeated for supporting one product
	// belonging to several parallel categories. Strongly recommended using the
	// full path for better search / recommendation quality.
	//
	//
	// To represent full path of category, use '>' sign to separate different
	// hierarchies. If '>' is part of the category name, please replace it with
	// other character(s).
	//
	// For example, if a shoes product belongs to both
	// ["Shoes & Accessories" -> "Shoes"] and
	// ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
	// represented as:
	//
	//      "categories": [
	//        "Shoes & Accessories > Shoes",
	//        "Sports & Fitness > Athletic Clothing > Shoes"
	//      ]
	//
	// Must be set for
	// [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2alpha.Product] otherwise an
	// INVALID_ARGUMENT error is returned.
	//
	// At most 250 values are allowed per
	// [Product][google.cloud.retail.v2alpha.Product]. Empty values are not
	// allowed. Each value must be a UTF-8 encoded string with a length limit of
	// 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Google Merchant Center property
	// [google_product_category][mc_google_product_category]. Schema.org property
	// [Product.category] (https://schema.org/category).
	//
	// [mc_google_product_category]:
	// https://support.google.com/merchants/answer/6324436
	Categories []string `protobuf:"bytes,7,rep,name=categories,proto3" json:"categories,omitempty"`
	// Required. Product title.
	//
	// This field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Google Merchant Center property
	// [title](https://support.google.com/merchants/answer/6324415). Schema.org
	// property [Product.name](https://schema.org/name).
	Title string `protobuf:"bytes,8,opt,name=title,proto3" json:"title,omitempty"`
	// Product description.
	//
	// This field must be a UTF-8 encoded string with a length limit of 5,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Google Merchant Center property
	// [description](https://support.google.com/merchants/answer/6324468).
	// schema.org property [Product.description](https://schema.org/description).
	Description string `protobuf:"bytes,10,opt,name=description,proto3" json:"description,omitempty"`
	// Highly encouraged. Extra product attributes to be included. For example,
	// for products, this could include the store name, vendor, style, color, etc.
	// These are very strong signals for recommendation model, thus we highly
	// recommend providing the attributes here.
	//
	// Features that can take on one of a limited number of possible values. Two
	// types of features can be set are:
	//
	// Textual features. some examples would be the brand/maker of a product, or
	// country of a customer. Numerical features. Some examples would be the
	// height/weight of a product, or age of a customer.
	//
	// For example: `{ "vendor": {"text": ["vendor123", "vendor456"]},
	// "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]}
	// }`.
	//
	// A maximum of 150 attributes are allowed. Otherwise, an INVALID_ARGUMENT
	// error is returned.
	//
	// The key must be a UTF-8 encoded string with a length limit of 5,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	Attributes map[string]*CustomAttribute `` /* 162-byte string literal not displayed */
	// Custom tags associated with the product.
	//
	// At most 250 values are allowed per
	// [Product][google.cloud.retail.v2alpha.Product]. This value must be a UTF-8
	// encoded string with a length limit of 1,000 characters. Otherwise, an
	// INVALID_ARGUMENT error is returned.
	//
	// This tag can be used for filtering recommendation results by passing the
	// tag as part of the
	// [PredictRequest.filter][google.cloud.retail.v2alpha.PredictRequest.filter].
	//
	// Google Merchant Center property
	// [custom_label_0–4](https://support.google.com/merchants/answer/6324473).
	Tags []string `protobuf:"bytes,13,rep,name=tags,proto3" json:"tags,omitempty"`
	// Product price and cost information.
	//
	// Google Merchant Center property
	// [price](https://support.google.com/merchants/answer/6324371).
	PriceInfo *PriceInfo `protobuf:"bytes,14,opt,name=price_info,json=priceInfo,proto3" json:"price_info,omitempty"`
	// The timestamp when this [Product][google.cloud.retail.v2alpha.Product]
	// becomes available recommendation and search.
	AvailableTime *timestamppb.Timestamp `protobuf:"bytes,18,opt,name=available_time,json=availableTime,proto3" json:"available_time,omitempty"`
	// The online availability of the
	// [Product][google.cloud.retail.v2alpha.Product]. Default to
	// [Availability.IN_STOCK][google.cloud.retail.v2alpha.Product.Availability.IN_STOCK].
	//
	// Google Merchant Center Property
	// [availability](https://support.google.com/merchants/answer/6324448).
	// Schema.org Property [Offer.availability](https://schema.org/availability).
	Availability Product_Availability `` /* 133-byte string literal not displayed */
	// The available quantity of the item.
	AvailableQuantity *wrapperspb.Int32Value `protobuf:"bytes,20,opt,name=available_quantity,json=availableQuantity,proto3" json:"available_quantity,omitempty"`
	// Canonical URL directly linking to the product detail page.
	//
	// This field must be a UTF-8 encoded string with a length limit of 5,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Google Merchant Center property
	// [link](https://support.google.com/merchants/answer/6324416). Schema.org
	// property [Offer.url](https://schema.org/url).
	Uri string `protobuf:"bytes,22,opt,name=uri,proto3" json:"uri,omitempty"`
	// Product images for the product.
	//
	// A maximum of 300 images are allowed.
	//
	// Google Merchant Center property
	// [image_link](https://support.google.com/merchants/answer/6324350).
	// Schema.org property [Product.image](https://schema.org/image).
	Images []*Image `protobuf:"bytes,23,rep,name=images,proto3" json:"images,omitempty"`
	// contains filtered or unexported fields
}

Product captures all metadata information of items to be recommended or searched.

func (*Product) Descriptor

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

Deprecated: Use Product.ProtoReflect.Descriptor instead.

func (*Product) GetAttributes

func (x *Product) GetAttributes() map[string]*CustomAttribute

func (*Product) GetAvailability

func (x *Product) GetAvailability() Product_Availability

func (*Product) GetAvailableQuantity

func (x *Product) GetAvailableQuantity() *wrapperspb.Int32Value

func (*Product) GetAvailableTime

func (x *Product) GetAvailableTime() *timestamppb.Timestamp

func (*Product) GetCategories

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

func (*Product) GetDescription

func (x *Product) GetDescription() string

func (*Product) GetId

func (x *Product) GetId() string

func (*Product) GetImages

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

func (*Product) GetName

func (x *Product) GetName() string

func (*Product) GetPriceInfo

func (x *Product) GetPriceInfo() *PriceInfo

func (*Product) GetPrimaryProductId

func (x *Product) GetPrimaryProductId() string

func (*Product) GetTags

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

func (*Product) GetTitle

func (x *Product) GetTitle() string

func (*Product) GetType

func (x *Product) GetType() Product_Type

func (*Product) GetUri

func (x *Product) GetUri() string

func (*Product) ProtoMessage

func (*Product) ProtoMessage()

func (*Product) ProtoReflect

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

func (*Product) Reset

func (x *Product) Reset()

func (*Product) String

func (x *Product) String() string

type ProductDetail

type ProductDetail struct {

	// Required. [Product][google.cloud.retail.v2alpha.Product] information.
	//
	// Only [Product.id][google.cloud.retail.v2alpha.Product.id] field is used
	// when ingesting an event, all other product fields are ignored as we will
	// look them up from the catalog.
	Product *Product `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
	// Quantity of the product associated with the user event.
	//
	// For example, this field will be 2 if two products are added to the shopping
	// cart for `purchase-complete` event. Required for `add-to-cart` and
	// `purchase-complete` event types.
	Quantity *wrapperspb.Int32Value `protobuf:"bytes,2,opt,name=quantity,proto3" json:"quantity,omitempty"`
	// contains filtered or unexported fields
}

Detailed product information associated with a user event.

func (*ProductDetail) Descriptor

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

Deprecated: Use ProductDetail.ProtoReflect.Descriptor instead.

func (*ProductDetail) GetProduct

func (x *ProductDetail) GetProduct() *Product

func (*ProductDetail) GetQuantity

func (x *ProductDetail) GetQuantity() *wrapperspb.Int32Value

func (*ProductDetail) ProtoMessage

func (*ProductDetail) ProtoMessage()

func (*ProductDetail) ProtoReflect

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

func (*ProductDetail) Reset

func (x *ProductDetail) Reset()

func (*ProductDetail) String

func (x *ProductDetail) String() string

type ProductInlineSource

type ProductInlineSource struct {

	// Required. A list of products to update/create. Each product must have a
	// valid [Product.id][google.cloud.retail.v2alpha.Product.id]. Recommended max
	// of 10k items.
	Products []*Product `protobuf:"bytes,1,rep,name=products,proto3" json:"products,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for ImportProducts method.

func (*ProductInlineSource) Descriptor

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

Deprecated: Use ProductInlineSource.ProtoReflect.Descriptor instead.

func (*ProductInlineSource) GetProducts

func (x *ProductInlineSource) GetProducts() []*Product

func (*ProductInlineSource) ProtoMessage

func (*ProductInlineSource) ProtoMessage()

func (*ProductInlineSource) ProtoReflect

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

func (*ProductInlineSource) Reset

func (x *ProductInlineSource) Reset()

func (*ProductInlineSource) String

func (x *ProductInlineSource) String() string

type ProductInputConfig

type ProductInputConfig struct {

	// Required. The source of the input.
	//
	// Types that are assignable to Source:
	//	*ProductInputConfig_ProductInlineSource
	//	*ProductInputConfig_GcsSource
	//	*ProductInputConfig_BigQuerySource
	Source isProductInputConfig_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

The input config source for products.

func (*ProductInputConfig) Descriptor

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

Deprecated: Use ProductInputConfig.ProtoReflect.Descriptor instead.

func (*ProductInputConfig) GetBigQuerySource

func (x *ProductInputConfig) GetBigQuerySource() *BigQuerySource

func (*ProductInputConfig) GetGcsSource

func (x *ProductInputConfig) GetGcsSource() *GcsSource

func (*ProductInputConfig) GetProductInlineSource

func (x *ProductInputConfig) GetProductInlineSource() *ProductInlineSource

func (*ProductInputConfig) GetSource

func (m *ProductInputConfig) GetSource() isProductInputConfig_Source

func (*ProductInputConfig) ProtoMessage

func (*ProductInputConfig) ProtoMessage()

func (*ProductInputConfig) ProtoReflect

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

func (*ProductInputConfig) Reset

func (x *ProductInputConfig) Reset()

func (*ProductInputConfig) String

func (x *ProductInputConfig) String() string

type ProductInputConfig_BigQuerySource

type ProductInputConfig_BigQuerySource struct {
	// BigQuery input source.
	BigQuerySource *BigQuerySource `protobuf:"bytes,3,opt,name=big_query_source,json=bigQuerySource,proto3,oneof"`
}

type ProductInputConfig_GcsSource

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

type ProductInputConfig_ProductInlineSource

type ProductInputConfig_ProductInlineSource struct {
	// The Inline source for the input content for products.
	ProductInlineSource *ProductInlineSource `protobuf:"bytes,1,opt,name=product_inline_source,json=productInlineSource,proto3,oneof"`
}

type ProductLevelConfig

type ProductLevelConfig struct {

	// The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be
	// ingested into the catalog. Acceptable values are:
	//
	// * `primary` (default): You can only ingest
	// [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
	//   [Product][google.cloud.retail.v2alpha.Product]s. This means
	//   [Product.primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id]
	//   can only be empty or set to the same value as
	//   [Product.id][google.cloud.retail.v2alpha.Product.id].
	// * `variant`: You can only ingest
	// [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2alpha.Product]s.
	//   This means
	//   [Product.primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id]
	//   cannot be empty.
	//
	// If this field is set to an invalid value other than these, an
	// INVALID_ARGUMENT error is returned.
	//
	// If this field is `variant` and
	// [merchant_center_product_id_field][google.cloud.retail.v2alpha.ProductLevelConfig.merchant_center_product_id_field]
	// is `itemGroupId`, an INVALID_ARGUMENT error is returned.
	//
	// See [Using catalog
	// levels](/retail/recommendations-ai/docs/catalog#catalog-levels) for more
	// details.
	IngestionProductType string `protobuf:"bytes,1,opt,name=ingestion_product_type,json=ingestionProductType,proto3" json:"ingestion_product_type,omitempty"`
	// Which field of [Merchant Center
	// Product](/bigquery-transfer/docs/merchant-center-products-schema) should be
	// imported as [Product.id][google.cloud.retail.v2alpha.Product.id].
	// Acceptable values are:
	//
	// * `offerId` (default): Import `offerId` as the product ID.
	// * `itemGroupId`: Import `itemGroupId` as the product ID. Notice that Retail
	//   API will choose one item from the ones with the same `itemGroupId`, and
	//   use it to represent the item group.
	//
	// If this field is set to an invalid value other than these, an
	// INVALID_ARGUMENT error is returned.
	//
	// If this field is `itemGroupId` and
	// [ingestion_product_type][google.cloud.retail.v2alpha.ProductLevelConfig.ingestion_product_type]
	// is `variant`, an INVALID_ARGUMENT error is returned.
	//
	// See [Using catalog
	// levels](/retail/recommendations-ai/docs/catalog#catalog-levels) for more
	// details.
	MerchantCenterProductIdField string `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.

func (*ProductLevelConfig) Descriptor

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

Deprecated: Use ProductLevelConfig.ProtoReflect.Descriptor instead.

func (*ProductLevelConfig) GetIngestionProductType

func (x *ProductLevelConfig) GetIngestionProductType() string

func (*ProductLevelConfig) GetMerchantCenterProductIdField

func (x *ProductLevelConfig) GetMerchantCenterProductIdField() string

func (*ProductLevelConfig) ProtoMessage

func (*ProductLevelConfig) ProtoMessage()

func (*ProductLevelConfig) ProtoReflect

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

func (*ProductLevelConfig) Reset

func (x *ProductLevelConfig) Reset()

func (*ProductLevelConfig) String

func (x *ProductLevelConfig) String() string

type ProductServiceClient

type ProductServiceClient interface {
	// Creates a [Product][google.cloud.retail.v2alpha.Product].
	CreateProduct(ctx context.Context, in *CreateProductRequest, opts ...grpc.CallOption) (*Product, error)
	// Gets a [Product][google.cloud.retail.v2alpha.Product].
	GetProduct(ctx context.Context, in *GetProductRequest, opts ...grpc.CallOption) (*Product, error)
	// Updates a [Product][google.cloud.retail.v2alpha.Product].
	UpdateProduct(ctx context.Context, in *UpdateProductRequest, opts ...grpc.CallOption) (*Product, error)
	// Deletes a [Product][google.cloud.retail.v2alpha.Product].
	DeleteProduct(ctx context.Context, in *DeleteProductRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Bulk import of multiple [Product][google.cloud.retail.v2alpha.Product]s.
	//
	// Request processing may be synchronous. No partial updating is supported.
	// Non-existing items are created.
	//
	// Note that it is possible for a subset of the
	// [Product][google.cloud.retail.v2alpha.Product]s to be successfully updated.
	ImportProducts(ctx context.Context, in *ImportProductsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}

ProductServiceClient is the client API for ProductService service.

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

type ProductServiceServer

type ProductServiceServer interface {
	// Creates a [Product][google.cloud.retail.v2alpha.Product].
	CreateProduct(context.Context, *CreateProductRequest) (*Product, error)
	// Gets a [Product][google.cloud.retail.v2alpha.Product].
	GetProduct(context.Context, *GetProductRequest) (*Product, error)
	// Updates a [Product][google.cloud.retail.v2alpha.Product].
	UpdateProduct(context.Context, *UpdateProductRequest) (*Product, error)
	// Deletes a [Product][google.cloud.retail.v2alpha.Product].
	DeleteProduct(context.Context, *DeleteProductRequest) (*emptypb.Empty, error)
	// Bulk import of multiple [Product][google.cloud.retail.v2alpha.Product]s.
	//
	// Request processing may be synchronous. No partial updating is supported.
	// Non-existing items are created.
	//
	// Note that it is possible for a subset of the
	// [Product][google.cloud.retail.v2alpha.Product]s to be successfully updated.
	ImportProducts(context.Context, *ImportProductsRequest) (*longrunning.Operation, error)
}

ProductServiceServer is the server API for ProductService service.

type Product_Availability

type Product_Availability int32

Product availability. If this field is unspecified, the product is assumed to be in stock.

const (
	// Default product availability. Default to
	// [Availability.IN_STOCK][google.cloud.retail.v2alpha.Product.Availability.IN_STOCK]
	// if unset.
	Product_AVAILABILITY_UNSPECIFIED Product_Availability = 0
	// Product in stock.
	Product_IN_STOCK Product_Availability = 1
	// Product out of stock.
	Product_OUT_OF_STOCK Product_Availability = 2
	// Product that is in pre-order state.
	Product_PREORDER Product_Availability = 3
	// Product that is back-ordered (i.e. temporarily out of stock).
	Product_BACKORDER Product_Availability = 4
)

func (Product_Availability) Descriptor

func (Product_Availability) Enum

func (Product_Availability) EnumDescriptor

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

Deprecated: Use Product_Availability.Descriptor instead.

func (Product_Availability) Number

func (Product_Availability) String

func (x Product_Availability) String() string

func (Product_Availability) Type

type Product_Type

type Product_Type int32

The type of this product.

const (
	// Default value. Default to
	// [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY] if
	// unset.
	Product_TYPE_UNSPECIFIED Product_Type = 0
	// The primary type.
	//
	// As the primary unit for predicting, indexing and search serving, a
	// [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2alpha.Product] is grouped with multiple
	// [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2alpha.Product]s.
	Product_PRIMARY Product_Type = 1
	// The variant type.
	//
	// [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2alpha.Product]s usually share some common
	// attributes on the same
	// [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2alpha.Product]s, but they have variant
	// attributes like different colors, sizes and prices, etc.
	Product_VARIANT Product_Type = 2
	// The collection type. Collection products are bundled
	// [Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
	// [Product][google.cloud.retail.v2alpha.Product]s or
	// [Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
	// [Product][google.cloud.retail.v2alpha.Product]s that are sold together,
	// such as a jewelry set with necklaces, earrings and rings, etc.
	Product_COLLECTION Product_Type = 3
)

func (Product_Type) Descriptor

func (Product_Type) Enum

func (x Product_Type) Enum() *Product_Type

func (Product_Type) EnumDescriptor

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

Deprecated: Use Product_Type.Descriptor instead.

func (Product_Type) Number

func (Product_Type) String

func (x Product_Type) String() string

func (Product_Type) Type

type PurchaseTransaction

type PurchaseTransaction struct {

	// The transaction ID with a length limit of 128 characters.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Required. Total non-zero revenue or grand total associated with the
	// transaction. This value include shipping, tax, or other adjustments to
	// total revenue that you want to include as part of your revenue
	// calculations.
	Revenue float32 `protobuf:"fixed32,2,opt,name=revenue,proto3" json:"revenue,omitempty"`
	// All the taxes associated with the transaction.
	Tax float32 `protobuf:"fixed32,3,opt,name=tax,proto3" json:"tax,omitempty"`
	// All the costs associated with the products. These can be manufacturing
	// costs, shipping expenses not borne by the end user, or any other costs,
	// such that:
	//
	// * Profit =
	// [revenue][google.cloud.retail.v2alpha.PurchaseTransaction.revenue] -
	// [tax][google.cloud.retail.v2alpha.PurchaseTransaction.tax] -
	// [cost][google.cloud.retail.v2alpha.PurchaseTransaction.cost]
	Cost float32 `protobuf:"fixed32,4,opt,name=cost,proto3" json:"cost,omitempty"`
	// Required. Currency code. Use three-character ISO-4217 code.
	CurrencyCode string `protobuf:"bytes,5,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
	// contains filtered or unexported fields
}

A transaction represents the entire purchase transaction.

func (*PurchaseTransaction) Descriptor

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

Deprecated: Use PurchaseTransaction.ProtoReflect.Descriptor instead.

func (*PurchaseTransaction) GetCost

func (x *PurchaseTransaction) GetCost() float32

func (*PurchaseTransaction) GetCurrencyCode

func (x *PurchaseTransaction) GetCurrencyCode() string

func (*PurchaseTransaction) GetId

func (x *PurchaseTransaction) GetId() string

func (*PurchaseTransaction) GetRevenue

func (x *PurchaseTransaction) GetRevenue() float32

func (*PurchaseTransaction) GetTax

func (x *PurchaseTransaction) GetTax() float32

func (*PurchaseTransaction) ProtoMessage

func (*PurchaseTransaction) ProtoMessage()

func (*PurchaseTransaction) ProtoReflect

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

func (*PurchaseTransaction) Reset

func (x *PurchaseTransaction) Reset()

func (*PurchaseTransaction) String

func (x *PurchaseTransaction) String() string

type PurgeMetadata

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

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

func (*PurgeMetadata) Descriptor

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

Deprecated: Use PurgeMetadata.ProtoReflect.Descriptor instead.

func (*PurgeMetadata) ProtoMessage

func (*PurgeMetadata) ProtoMessage()

func (*PurgeMetadata) ProtoReflect

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

func (*PurgeMetadata) Reset

func (x *PurgeMetadata) Reset()

func (*PurgeMetadata) String

func (x *PurgeMetadata) String() string

type PurgeUserEventsRequest

type PurgeUserEventsRequest struct {

	// Required. The resource name of the catalog under which the events are
	// created. The format is
	// "projects/${projectId}/locations/global/catalogs/${catalogId}"
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The filter string to specify the events to be deleted with a
	// length limit of 5,000 characters. Empty string filter is not allowed. The
	// eligible fields for filtering are:
	//
	// * `eventType`: Double quoted
	// [UserEvent.event_type][google.cloud.retail.v2alpha.UserEvent.event_type]
	// string.
	// * `eventTime`: in ISO 8601 "zulu" format.
	// * `visitorId`: Double quoted string. Specifying this will delete all
	//   events associated with a visitor.
	// * `userId`: Double quoted string. Specifying this will delete all events
	//   associated with a user.
	//
	// Examples:
	//
	// * Deleting all events in a time range:
	//   `eventTime > "2012-04-23T18:25:43.511Z"
	//   eventTime < "2012-04-23T18:30:43.511Z"`
	// * Deleting specific eventType in time range:
	//   `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
	// * Deleting all events for a specific visitor:
	//   `visitorId = "visitor1024"`
	//
	// The filtering fields are assumed to have an implicit AND.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Actually perform the purge.
	// If `force` is set to false, the method will return the expected purge count
	// without deleting any user events.
	Force bool `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for PurgeUserEvents method.

func (*PurgeUserEventsRequest) Descriptor

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

Deprecated: Use PurgeUserEventsRequest.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsRequest) GetFilter

func (x *PurgeUserEventsRequest) GetFilter() string

func (*PurgeUserEventsRequest) GetForce

func (x *PurgeUserEventsRequest) GetForce() bool

func (*PurgeUserEventsRequest) GetParent

func (x *PurgeUserEventsRequest) GetParent() string

func (*PurgeUserEventsRequest) ProtoMessage

func (*PurgeUserEventsRequest) ProtoMessage()

func (*PurgeUserEventsRequest) ProtoReflect

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

func (*PurgeUserEventsRequest) Reset

func (x *PurgeUserEventsRequest) Reset()

func (*PurgeUserEventsRequest) String

func (x *PurgeUserEventsRequest) String() string

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"`
	// contains filtered or unexported fields
}

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

func (*PurgeUserEventsResponse) Descriptor

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

Deprecated: Use PurgeUserEventsResponse.ProtoReflect.Descriptor instead.

func (*PurgeUserEventsResponse) GetPurgedEventsCount

func (x *PurgeUserEventsResponse) GetPurgedEventsCount() int64

func (*PurgeUserEventsResponse) ProtoMessage

func (*PurgeUserEventsResponse) ProtoMessage()

func (*PurgeUserEventsResponse) ProtoReflect

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

func (*PurgeUserEventsResponse) Reset

func (x *PurgeUserEventsResponse) Reset()

func (*PurgeUserEventsResponse) String

func (x *PurgeUserEventsResponse) String() string

type RejoinUserEventsMetadata

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

Metadata for RejoinUserEvents method.

func (*RejoinUserEventsMetadata) Descriptor

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

Deprecated: Use RejoinUserEventsMetadata.ProtoReflect.Descriptor instead.

func (*RejoinUserEventsMetadata) ProtoMessage

func (*RejoinUserEventsMetadata) ProtoMessage()

func (*RejoinUserEventsMetadata) ProtoReflect

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

func (*RejoinUserEventsMetadata) Reset

func (x *RejoinUserEventsMetadata) Reset()

func (*RejoinUserEventsMetadata) String

func (x *RejoinUserEventsMetadata) String() string

type RejoinUserEventsRequest

type RejoinUserEventsRequest struct {

	// Required. The parent catalog resource name, such as
	// "projects/1234/locations/global/catalogs/default_catalog".
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The type of the user event rejoin to define the scope and range of the user
	// events to be rejoined with the latest product catalog. Defaults to
	// USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
	// invalid integer value.
	UserEventRejoinScope RejoinUserEventsRequest_UserEventRejoinScope `` /* 204-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for RejoinUserEvents method.

func (*RejoinUserEventsRequest) Descriptor

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

Deprecated: Use RejoinUserEventsRequest.ProtoReflect.Descriptor instead.

func (*RejoinUserEventsRequest) GetParent

func (x *RejoinUserEventsRequest) GetParent() string

func (*RejoinUserEventsRequest) GetUserEventRejoinScope

func (*RejoinUserEventsRequest) ProtoMessage

func (*RejoinUserEventsRequest) ProtoMessage()

func (*RejoinUserEventsRequest) ProtoReflect

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

func (*RejoinUserEventsRequest) Reset

func (x *RejoinUserEventsRequest) Reset()

func (*RejoinUserEventsRequest) String

func (x *RejoinUserEventsRequest) String() string

type RejoinUserEventsRequest_UserEventRejoinScope

type RejoinUserEventsRequest_UserEventRejoinScope int32

The scope of user events to be rejoined with the latest product catalog. If the rejoining aims at reducing number of unjoined events, set UserEventRejoinScope to UNJOINED_EVENTS. If the rejoining aims at correcting product catalog information in joined events, set UserEventRejoinScope to JOINED_EVENTS. If all events needs to be rejoined, set UserEventRejoinScope to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED.

const (
	// Rejoin all events with the latest product catalog, including both joined
	// events and unjoined events.
	RejoinUserEventsRequest_USER_EVENT_REJOIN_SCOPE_UNSPECIFIED RejoinUserEventsRequest_UserEventRejoinScope = 0
	// Only rejoin joined events with the latest product catalog.
	RejoinUserEventsRequest_JOINED_EVENTS RejoinUserEventsRequest_UserEventRejoinScope = 1
	// Only rejoin unjoined events with the latest product catalog.
	RejoinUserEventsRequest_UNJOINED_EVENTS RejoinUserEventsRequest_UserEventRejoinScope = 2
)

func (RejoinUserEventsRequest_UserEventRejoinScope) Descriptor

func (RejoinUserEventsRequest_UserEventRejoinScope) Enum

func (RejoinUserEventsRequest_UserEventRejoinScope) EnumDescriptor

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

Deprecated: Use RejoinUserEventsRequest_UserEventRejoinScope.Descriptor instead.

func (RejoinUserEventsRequest_UserEventRejoinScope) Number

func (RejoinUserEventsRequest_UserEventRejoinScope) String

func (RejoinUserEventsRequest_UserEventRejoinScope) Type

type RejoinUserEventsResponse

type RejoinUserEventsResponse struct {

	// Number of user events that were joined with latest product catalog.
	RejoinedUserEventsCount int64 `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response message for RejoinUserEvents method.

func (*RejoinUserEventsResponse) Descriptor

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

Deprecated: Use RejoinUserEventsResponse.ProtoReflect.Descriptor instead.

func (*RejoinUserEventsResponse) GetRejoinedUserEventsCount

func (x *RejoinUserEventsResponse) GetRejoinedUserEventsCount() int64

func (*RejoinUserEventsResponse) ProtoMessage

func (*RejoinUserEventsResponse) ProtoMessage()

func (*RejoinUserEventsResponse) ProtoReflect

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

func (*RejoinUserEventsResponse) Reset

func (x *RejoinUserEventsResponse) Reset()

func (*RejoinUserEventsResponse) String

func (x *RejoinUserEventsResponse) String() string

type UnimplementedCatalogServiceServer

type UnimplementedCatalogServiceServer struct {
}

UnimplementedCatalogServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCatalogServiceServer) ListCatalogs

func (*UnimplementedCatalogServiceServer) UpdateCatalog

type UnimplementedPredictionServiceServer

type UnimplementedPredictionServiceServer struct {
}

UnimplementedPredictionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedPredictionServiceServer) Predict

type UnimplementedProductServiceServer

type UnimplementedProductServiceServer struct {
}

UnimplementedProductServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedProductServiceServer) CreateProduct

func (*UnimplementedProductServiceServer) DeleteProduct

func (*UnimplementedProductServiceServer) GetProduct

func (*UnimplementedProductServiceServer) ImportProducts

func (*UnimplementedProductServiceServer) UpdateProduct

type UnimplementedUserEventServiceServer

type UnimplementedUserEventServiceServer struct {
}

UnimplementedUserEventServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedUserEventServiceServer) CollectUserEvent

func (*UnimplementedUserEventServiceServer) ImportUserEvents

func (*UnimplementedUserEventServiceServer) PurgeUserEvents

func (*UnimplementedUserEventServiceServer) RejoinUserEvents

func (*UnimplementedUserEventServiceServer) WriteUserEvent

type UpdateCatalogRequest

type UpdateCatalogRequest struct {

	// Required. The [Catalog][google.cloud.retail.v2alpha.Catalog] to update.
	//
	// If the caller does not have permission to update the
	// [Catalog][google.cloud.retail.v2alpha.Catalog], regardless of whether or
	// not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Catalog][google.cloud.retail.v2alpha.Catalog] to update does not
	// exist, a NOT_FOUND error is returned.
	Catalog *Catalog `protobuf:"bytes,1,opt,name=catalog,proto3" json:"catalog,omitempty"`
	// Indicates which fields in the provided
	// [Catalog][google.cloud.retail.v2alpha.Catalog] to update. If not set, will
	// only update the
	// [Catalog.product_level_config][google.cloud.retail.v2alpha.Catalog.product_level_config]
	// field, which is also the only currently supported field to update.
	//
	// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
	// is returned.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request for [CatalogService.UpdateCatalog][google.cloud.retail.v2alpha.CatalogService.UpdateCatalog] method.

func (*UpdateCatalogRequest) Descriptor

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

Deprecated: Use UpdateCatalogRequest.ProtoReflect.Descriptor instead.

func (*UpdateCatalogRequest) GetCatalog

func (x *UpdateCatalogRequest) GetCatalog() *Catalog

func (*UpdateCatalogRequest) GetUpdateMask

func (x *UpdateCatalogRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateCatalogRequest) ProtoMessage

func (*UpdateCatalogRequest) ProtoMessage()

func (*UpdateCatalogRequest) ProtoReflect

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

func (*UpdateCatalogRequest) Reset

func (x *UpdateCatalogRequest) Reset()

func (*UpdateCatalogRequest) String

func (x *UpdateCatalogRequest) String() string

type UpdateProductRequest

type UpdateProductRequest struct {

	// Required. The product to update/create.
	//
	// If the caller does not have permission to update the
	// [Product][google.cloud.retail.v2alpha.Product], regardless of whether or
	// not it exists, a PERMISSION_DENIED error is returned.
	//
	// If the [Product][google.cloud.retail.v2alpha.Product] to update does not
	// exist, a NOT_FOUND error is returned.
	Product *Product `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
	// Indicates which fields in the provided
	// [Product][google.cloud.retail.v2alpha.Product] to update. The immutable and
	// output only fields are NOT supported. If not set, all supported fields (the
	// fields that are neither immutable nor output only) are updated.
	//
	// If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
	// is returned.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for [UpdateProduct][] method.

func (*UpdateProductRequest) Descriptor

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

Deprecated: Use UpdateProductRequest.ProtoReflect.Descriptor instead.

func (*UpdateProductRequest) GetProduct

func (x *UpdateProductRequest) GetProduct() *Product

func (*UpdateProductRequest) GetUpdateMask

func (x *UpdateProductRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateProductRequest) ProtoMessage

func (*UpdateProductRequest) ProtoMessage()

func (*UpdateProductRequest) ProtoReflect

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

func (*UpdateProductRequest) Reset

func (x *UpdateProductRequest) Reset()

func (*UpdateProductRequest) String

func (x *UpdateProductRequest) String() string

type UserEvent

type UserEvent struct {

	// Required. User event type. Allowed values are:
	//
	// * `add-to-cart`: Products being added to cart.
	// * `category-page-view`: Special pages such as sale or promotion pages
	//   viewed.
	// * `detail-page-view`: Products detail page viewed.
	// * `home-page-view`: Homepage viewed.
	// * `purchase-complete`: User finishing a purchase.
	// * `search`: Product search.
	// * `shopping-cart-page-view`: User viewing a shopping cart.
	EventType string `protobuf:"bytes,1,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
	// Required. A unique identifier for tracking visitors.
	//
	// For example, this could be implemented with an HTTP cookie, which should be
	// able to uniquely identify a visitor on a single device. This unique
	// identifier should not change if the visitor log in/out of the website.
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	VisitorId string `protobuf:"bytes,2,opt,name=visitor_id,json=visitorId,proto3" json:"visitor_id,omitempty"`
	// Only required for
	// [UserEventService.ImportUserEvents][google.cloud.retail.v2alpha.UserEventService.ImportUserEvents]
	// method. Timestamp of when the user event happened.
	EventTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=event_time,json=eventTime,proto3" json:"event_time,omitempty"`
	// A list of identifiers for the independent experiment groups this user event
	// belongs to. This is used to distinguish between user events associated with
	// different experiment setups (e.g. using Retail API, using different
	// recommendation models).
	ExperimentIds []string `protobuf:"bytes,4,rep,name=experiment_ids,json=experimentIds,proto3" json:"experiment_ids,omitempty"`
	// Highly recommended for user events that are the result of
	// [PredictionService.Predict][google.cloud.retail.v2alpha.PredictionService.Predict].
	// This field enables accurate attribution of recommendation model
	// performance.
	//
	// The value must be a valid
	// [PredictResponse.attribution_token][google.cloud.retail.v2alpha.PredictResponse.attribution_token]
	// for user events that are the result of
	// [PredictionService.Predict][google.cloud.retail.v2alpha.PredictionService.Predict].
	//
	// This token enables us to accurately attribute page view or purchase back to
	// the event and the particular predict response containing this
	// clicked/purchased product. If user clicks on product K in the
	// recommendation results, pass
	// [PredictResponse.attribution_token][google.cloud.retail.v2alpha.PredictResponse.attribution_token]
	// as a URL parameter to product K's page. When recording events on product
	// K's page, log the
	// [PredictResponse.attribution_token][google.cloud.retail.v2alpha.PredictResponse.attribution_token]
	// to this field.
	AttributionToken string `protobuf:"bytes,5,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
	// The main product details related to the event.
	//
	// This field is required for the following event types:
	//
	// * `add-to-cart`
	// * `detail-page-view`
	// * `purchase-complete`
	//
	// In a `search` event, this field represents the products returned to the end
	// user on the current page (the end user may have not finished broswing the
	// whole page yet). When a new page is returned to the end user, after
	// pagination/filtering/ordering even for the same query, a new `search` event
	// with different
	// [product_details][google.cloud.retail.v2alpha.UserEvent.product_details] is
	// desired. The end user may have not finished broswing the whole page yet.
	ProductDetails []*ProductDetail `protobuf:"bytes,6,rep,name=product_details,json=productDetails,proto3" json:"product_details,omitempty"`
	// Extra user event features to include in the recommendation model.
	//
	// The key must be a UTF-8 encoded string with a length limit of 5,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// 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.
	Attributes map[string]*CustomAttribute `` /* 161-byte string literal not displayed */
	// The id or name of the associated shopping cart. This id is used
	// to associate multiple items added or present in the cart before purchase.
	//
	// This can only be set for `add-to-cart`, `purchase-complete`, or
	// `shopping-cart-page-view` events.
	CartId string `protobuf:"bytes,8,opt,name=cart_id,json=cartId,proto3" json:"cart_id,omitempty"`
	// A transaction represents the entire purchase transaction.
	//
	// Required for `purchase-complete` events. Other event types should not set
	// this field. Otherwise, an INVALID_ARGUMENT error is returned.
	PurchaseTransaction *PurchaseTransaction `protobuf:"bytes,9,opt,name=purchase_transaction,json=purchaseTransaction,proto3" json:"purchase_transaction,omitempty"`
	// The user's search query.
	//
	// The value must be a UTF-8 encoded string with a length limit of 5,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// Required for `search` events. Other event types should not set this field.
	// Otherwise, an INVALID_ARGUMENT error is returned.
	SearchQuery string `protobuf:"bytes,10,opt,name=search_query,json=searchQuery,proto3" json:"search_query,omitempty"`
	// The categories associated with a category page.
	//
	// To represent full path of category, use '>' sign to separate different
	// hierarchies. If '>' is part of the category name, please replace it with
	// other character(s).
	//
	// Category pages include special pages such as sales or promotions. For
	// instance, a special sale page may have the category hierarchy:
	// "pageCategories" : ["Sales > 2017 Black Friday Deals"].
	//
	// Required for `category-page-view` events. Other event types should not set
	// this field. Otherwise, an INVALID_ARGUMENT error is returned.
	PageCategories []string `protobuf:"bytes,11,rep,name=page_categories,json=pageCategories,proto3" json:"page_categories,omitempty"`
	// User information.
	UserInfo *UserInfo `protobuf:"bytes,12,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
	// Complete URL (window.location.href) of the user's current page.
	//
	// When using the client side event reporting with JavaScript pixel and Google
	// Tag Manager, this value is filled in automatically. Maximum length 5,000
	// characters.
	Uri string `protobuf:"bytes,13,opt,name=uri,proto3" json:"uri,omitempty"`
	// The referrer URL of the current page.
	//
	// When using the client side event reporting with JavaScript pixel and Google
	// Tag Manager, this value is filled in automatically.
	ReferrerUri string `protobuf:"bytes,14,opt,name=referrer_uri,json=referrerUri,proto3" json:"referrer_uri,omitempty"`
	// A unique id of a web page view.
	//
	// This should be kept the same for all user events triggered from the same
	// pageview. For example, an item detail page view could trigger multiple
	// events as the user is browsing the page. The `pageViewId` property should
	// be kept the same for all these events so that they can be grouped together
	// properly.
	//
	// When using the client side event reporting with JavaScript pixel and Google
	// Tag Manager, this value is filled in automatically.
	PageViewId string `protobuf:"bytes,15,opt,name=page_view_id,json=pageViewId,proto3" json:"page_view_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*UserEvent) Descriptor

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

Deprecated: Use UserEvent.ProtoReflect.Descriptor instead.

func (*UserEvent) GetAttributes

func (x *UserEvent) GetAttributes() map[string]*CustomAttribute

func (*UserEvent) GetAttributionToken

func (x *UserEvent) GetAttributionToken() string

func (*UserEvent) GetCartId

func (x *UserEvent) GetCartId() string

func (*UserEvent) GetEventTime

func (x *UserEvent) GetEventTime() *timestamppb.Timestamp

func (*UserEvent) GetEventType

func (x *UserEvent) GetEventType() string

func (*UserEvent) GetExperimentIds

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

func (*UserEvent) GetPageCategories

func (x *UserEvent) GetPageCategories() []string

func (*UserEvent) GetPageViewId

func (x *UserEvent) GetPageViewId() string

func (*UserEvent) GetProductDetails

func (x *UserEvent) GetProductDetails() []*ProductDetail

func (*UserEvent) GetPurchaseTransaction

func (x *UserEvent) GetPurchaseTransaction() *PurchaseTransaction

func (*UserEvent) GetReferrerUri

func (x *UserEvent) GetReferrerUri() string

func (*UserEvent) GetSearchQuery

func (x *UserEvent) GetSearchQuery() string

func (*UserEvent) GetUri

func (x *UserEvent) GetUri() string

func (*UserEvent) GetUserInfo

func (x *UserEvent) GetUserInfo() *UserInfo

func (*UserEvent) GetVisitorId

func (x *UserEvent) GetVisitorId() string

func (*UserEvent) ProtoMessage

func (*UserEvent) ProtoMessage()

func (*UserEvent) ProtoReflect

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

func (*UserEvent) Reset

func (x *UserEvent) Reset()

func (*UserEvent) String

func (x *UserEvent) String() string

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"`
	// contains filtered or unexported fields
}

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

func (*UserEventImportSummary) Descriptor

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

Deprecated: Use UserEventImportSummary.ProtoReflect.Descriptor instead.

func (*UserEventImportSummary) GetJoinedEventsCount

func (x *UserEventImportSummary) GetJoinedEventsCount() int64

func (*UserEventImportSummary) GetUnjoinedEventsCount

func (x *UserEventImportSummary) GetUnjoinedEventsCount() int64

func (*UserEventImportSummary) ProtoMessage

func (*UserEventImportSummary) ProtoMessage()

func (*UserEventImportSummary) ProtoReflect

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

func (*UserEventImportSummary) Reset

func (x *UserEventImportSummary) Reset()

func (*UserEventImportSummary) String

func (x *UserEventImportSummary) String() string

type UserEventInlineSource

type UserEventInlineSource struct {

	// Required. A list of user events to import. Recommended max of 10k items.
	UserEvents []*UserEvent `protobuf:"bytes,1,rep,name=user_events,json=userEvents,proto3" json:"user_events,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for ImportUserEvents method.

func (*UserEventInlineSource) Descriptor

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

Deprecated: Use UserEventInlineSource.ProtoReflect.Descriptor instead.

func (*UserEventInlineSource) GetUserEvents

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

func (*UserEventInlineSource) ProtoMessage

func (*UserEventInlineSource) ProtoMessage()

func (*UserEventInlineSource) ProtoReflect

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

func (*UserEventInlineSource) Reset

func (x *UserEventInlineSource) Reset()

func (*UserEventInlineSource) String

func (x *UserEventInlineSource) String() string

type UserEventInputConfig

type UserEventInputConfig struct {

	// The source of the input.
	//
	// Types that are assignable to Source:
	//	*UserEventInputConfig_UserEventInlineSource
	//	*UserEventInputConfig_GcsSource
	//	*UserEventInputConfig_BigQuerySource
	Source isUserEventInputConfig_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

The input config source for user events.

func (*UserEventInputConfig) Descriptor

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

Deprecated: Use UserEventInputConfig.ProtoReflect.Descriptor instead.

func (*UserEventInputConfig) GetBigQuerySource

func (x *UserEventInputConfig) GetBigQuerySource() *BigQuerySource

func (*UserEventInputConfig) GetGcsSource

func (x *UserEventInputConfig) GetGcsSource() *GcsSource

func (*UserEventInputConfig) GetSource

func (m *UserEventInputConfig) GetSource() isUserEventInputConfig_Source

func (*UserEventInputConfig) GetUserEventInlineSource

func (x *UserEventInputConfig) GetUserEventInlineSource() *UserEventInlineSource

func (*UserEventInputConfig) ProtoMessage

func (*UserEventInputConfig) ProtoMessage()

func (*UserEventInputConfig) ProtoReflect

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

func (*UserEventInputConfig) Reset

func (x *UserEventInputConfig) Reset()

func (*UserEventInputConfig) String

func (x *UserEventInputConfig) String() string

type UserEventInputConfig_BigQuerySource

type UserEventInputConfig_BigQuerySource struct {
	// Required. BigQuery input source.
	BigQuerySource *BigQuerySource `protobuf:"bytes,3,opt,name=big_query_source,json=bigQuerySource,proto3,oneof"`
}

type UserEventInputConfig_GcsSource

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

type UserEventInputConfig_UserEventInlineSource

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

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 Retail API JavaScript pixel and Google Tag
	// Manager. Users should not call this method directly.
	CollectUserEvent(ctx context.Context, in *CollectUserEventRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, 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)
	// Triggers a user event rejoin operation with latest product catalog. Events
	// will not be annotated with detailed product information if product is
	// missing from the catalog at the time the user event is ingested, and these
	// events are stored as unjoined events with a limited usage on training and
	// serving. This API can be used to trigger a 'join' operation on specified
	// events with latest version of product catalog. It can also be used to
	// correct events joined with wrong product catalog.
	RejoinUserEvents(ctx context.Context, in *RejoinUserEventsRequest, 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 Retail API JavaScript pixel and Google Tag
	// Manager. Users should not call this method directly.
	CollectUserEvent(context.Context, *CollectUserEventRequest) (*httpbody.HttpBody, 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)
	// Triggers a user event rejoin operation with latest product catalog. Events
	// will not be annotated with detailed product information if product is
	// missing from the catalog at the time the user event is ingested, and these
	// events are stored as unjoined events with a limited usage on training and
	// serving. This API can be used to trigger a 'join' operation on specified
	// events with latest version of product catalog. It can also be used to
	// correct events joined with wrong product catalog.
	RejoinUserEvents(context.Context, *RejoinUserEventsRequest) (*longrunning.Operation, error)
}

UserEventServiceServer is the server API for UserEventService service.

type UserInfo

type UserInfo struct {

	// Highly recommended for logged-in users. Unique identifier for logged-in
	// user, such as a user name.
	//
	// The field must be a UTF-8 encoded string with a length limit of 128
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// The end user's IP address. This field is used to extract location
	// information for personalization.
	//
	// This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
	// address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
	// INVALID_ARGUMENT error is returned.
	//
	// This should not be set when using the JavaScript tag in
	// [UserEventService.CollectUserEvent][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent]
	// or if
	// [direct_user_request][google.cloud.retail.v2alpha.UserInfo.direct_user_request]
	// is set.
	IpAddress string `protobuf:"bytes,2,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`
	// User agent as included in the HTTP header.
	//
	// The field must be a UTF-8 encoded string with a length limit of 1,000
	// characters. Otherwise, an INVALID_ARGUMENT error is returned.
	//
	// This should not be set when using the client side event reporting with
	// GTM or JavaScript tag in
	// [UserEventService.CollectUserEvent][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent]
	// or if
	// [direct_user_request][google.cloud.retail.v2alpha.UserInfo.direct_user_request]
	// is set.
	UserAgent string `protobuf:"bytes,3,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
	// True if the request is made directly from the end user, in which case the
	// [ip_address][google.cloud.retail.v2alpha.UserInfo.ip_address] and
	// [user_agent][google.cloud.retail.v2alpha.UserInfo.user_agent] can be
	// populated from the HTTP request. This flag should be set only if the API
	// request is made directly from the end user such as a mobile app (and not if
	// a gateway or a server is processing and pushing the user events).
	//
	// This should not be set when using the JavaScript tag in
	// [UserEventService.CollectUserEvent][google.cloud.retail.v2alpha.UserEventService.CollectUserEvent].
	DirectUserRequest bool `protobuf:"varint,4,opt,name=direct_user_request,json=directUserRequest,proto3" json:"direct_user_request,omitempty"`
	// contains filtered or unexported fields
}

Information of an end user.

func (*UserInfo) Descriptor

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

Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.

func (*UserInfo) GetDirectUserRequest

func (x *UserInfo) GetDirectUserRequest() bool

func (*UserInfo) GetIpAddress

func (x *UserInfo) GetIpAddress() string

func (*UserInfo) GetUserAgent

func (x *UserInfo) GetUserAgent() string

func (*UserInfo) GetUserId

func (x *UserInfo) GetUserId() string

func (*UserInfo) ProtoMessage

func (*UserInfo) ProtoMessage()

func (*UserInfo) ProtoReflect

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

func (*UserInfo) Reset

func (x *UserInfo) Reset()

func (*UserInfo) String

func (x *UserInfo) String() string

type WriteUserEventRequest

type WriteUserEventRequest struct {

	// Required. The parent catalog resource name, such as
	// "projects/1234/locations/global/catalogs/default_catalog".
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. User event to write.
	UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
	// contains filtered or unexported fields
}

Request message for WriteUserEvent method.

func (*WriteUserEventRequest) Descriptor

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

Deprecated: Use WriteUserEventRequest.ProtoReflect.Descriptor instead.

func (*WriteUserEventRequest) GetParent

func (x *WriteUserEventRequest) GetParent() string

func (*WriteUserEventRequest) GetUserEvent

func (x *WriteUserEventRequest) GetUserEvent() *UserEvent

func (*WriteUserEventRequest) ProtoMessage

func (*WriteUserEventRequest) ProtoMessage()

func (*WriteUserEventRequest) ProtoReflect

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

func (*WriteUserEventRequest) Reset

func (x *WriteUserEventRequest) Reset()

func (*WriteUserEventRequest) String

func (x *WriteUserEventRequest) String() string