protocol

package
v0.1.17 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 16, 2023 License: Apache-2.0 Imports: 5 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_byteplus_retail_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AckServerImpressionsRequest 

type AckServerImpressionsRequest struct {

	// Required.
	// This should be same as `PredictRequest.request_id`.
	PredictRequestId string `protobuf:"bytes,1,opt,name=predict_request_id,json=predictRequestId,proto3" json:"predict_request_id,omitempty"`
	// Required.
	// This should be same as `PredictRequest.user_id`.
	UserId string `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Required.
	// This should be the traffic source.
	// The accepted values are ["self", "byteplus", "other"].
	// Please refer to
	// [this](../docs/ways-to-improve-recommendation-performance#use-usereventrec_info-and-usereventtraffic_source) for more details.
	TrafficSource string `protobuf:"bytes,3,opt,name=traffic_source,json=trafficSource,proto3" json:"traffic_source,omitempty"`
	// Required.
	// The scene info.
	// Please make sure this is as close to UserEvent.scene as possible.
	Scene *UserEvent_Scene `protobuf:"bytes,4,opt,name=scene,proto3" json:"scene,omitempty"`
	// Required.
	// The list of altered products.
	AlteredProducts []*AckServerImpressionsRequest_AlteredProduct `protobuf:"bytes,5,rep,name=altered_products,json=alteredProducts,proto3" json:"altered_products,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

The request proto for AckServerImpressions call.

func (*AckServerImpressionsRequest) Descriptor deprecated 

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

Deprecated: Use AckServerImpressionsRequest.ProtoReflect.Descriptor instead.

func (*AckServerImpressionsRequest) GetAlteredProducts 

func (x *AckServerImpressionsRequest) GetAlteredProducts() []*AckServerImpressionsRequest_AlteredProduct

func (*AckServerImpressionsRequest) GetExtra added in v0.1.15 

func (x *AckServerImpressionsRequest) GetExtra() map[string]string

func (*AckServerImpressionsRequest) GetPredictRequestId 

func (x *AckServerImpressionsRequest) GetPredictRequestId() string

func (*AckServerImpressionsRequest) GetScene 

func (x *AckServerImpressionsRequest) GetScene() *UserEvent_Scene

func (*AckServerImpressionsRequest) GetTrafficSource 

func (x *AckServerImpressionsRequest) GetTrafficSource() string

func (*AckServerImpressionsRequest) GetUserId 

func (x *AckServerImpressionsRequest) GetUserId() string

func (*AckServerImpressionsRequest) ProtoMessage 

func (*AckServerImpressionsRequest) ProtoMessage()

func (*AckServerImpressionsRequest) ProtoReflect 

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

func (*AckServerImpressionsRequest) Reset 

func (x *AckServerImpressionsRequest) Reset()

func (*AckServerImpressionsRequest) String 

func (x *AckServerImpressionsRequest) String() string

type AckServerImpressionsRequest_AlteredProduct 

type AckServerImpressionsRequest_AlteredProduct struct {

	// Required.
	// This is same as `Product.product_id`.
	ProductId string `protobuf:"bytes,1,opt,name=product_id,json=productId,proto3" json:"product_id,omitempty"`
	// Required.
	// The final state of the product.
	// The acceptable values are "kept", "filtered", "inserted".
	// kept     : The product was kept as is.
	// filtered : The product is filtered by the caller's own logic.
	// inserted : The product is inserted by the caller's own logic.
	AlteredReason string `protobuf:"bytes,2,opt,name=altered_reason,json=alteredReason,proto3" json:"altered_reason,omitempty"`
	// Required.
	// The final rank.
	// If this is unset (or 0), we assume it is filtered in actual impression.
	Rank int32 `protobuf:"varint,3,opt,name=rank,proto3" json:"rank,omitempty"`
	// Internal
	// If `product_id` is a number, `product_id_hash` equals to `product_id`
	// If `product_id` is not a number, `product_id_hash` equals to `fnv(product_id)`
	ProductIdHash int64 `protobuf:"varint,100,opt,name=product_id_hash,json=productIdHash,proto3" json:"product_id_hash,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

The product that was altered.

func (*AckServerImpressionsRequest_AlteredProduct) Descriptor deprecated 

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

Deprecated: Use AckServerImpressionsRequest_AlteredProduct.ProtoReflect.Descriptor instead.

func (*AckServerImpressionsRequest_AlteredProduct) GetAlteredReason 

func (x *AckServerImpressionsRequest_AlteredProduct) GetAlteredReason() string

func (*AckServerImpressionsRequest_AlteredProduct) GetExtra added in v0.1.14 

func (x *AckServerImpressionsRequest_AlteredProduct) GetExtra() map[string]string

func (*AckServerImpressionsRequest_AlteredProduct) GetProductId 

func (x *AckServerImpressionsRequest_AlteredProduct) GetProductId() string

func (*AckServerImpressionsRequest_AlteredProduct) GetProductIdHash added in v0.1.15 

func (x *AckServerImpressionsRequest_AlteredProduct) GetProductIdHash() int64

func (*AckServerImpressionsRequest_AlteredProduct) GetRank 

func (x *AckServerImpressionsRequest_AlteredProduct) GetRank() int32

func (*AckServerImpressionsRequest_AlteredProduct) ProtoMessage 

func (*AckServerImpressionsRequest_AlteredProduct) ProtoMessage()

func (*AckServerImpressionsRequest_AlteredProduct) ProtoReflect 

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

func (*AckServerImpressionsRequest_AlteredProduct) Reset 

func (x *AckServerImpressionsRequest_AlteredProduct) Reset()

func (*AckServerImpressionsRequest_AlteredProduct) String 

func (x *AckServerImpressionsRequest_AlteredProduct) String() string

type AckServerImpressionsResponse 

type AckServerImpressionsResponse struct {

	// Output only.
	// The status of this response.
	Status *protocol.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

The response message for AckServerImpressions.

func (*AckServerImpressionsResponse) Descriptor deprecated 

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

Deprecated: Use AckServerImpressionsResponse.ProtoReflect.Descriptor instead.

func (*AckServerImpressionsResponse) GetStatus 

func (x *AckServerImpressionsResponse) GetStatus() *protocol.Status

func (*AckServerImpressionsResponse) ProtoMessage 

func (*AckServerImpressionsResponse) ProtoMessage()

func (*AckServerImpressionsResponse) ProtoReflect 

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

func (*AckServerImpressionsResponse) Reset 

func (x *AckServerImpressionsResponse) Reset()

func (*AckServerImpressionsResponse) String 

func (x *AckServerImpressionsResponse) String() string

type DateConfig 

type DateConfig struct {

	// Required.
	// This should be the same as all dates from `XXXInputConfig`
	// Any violation will result in a standard 400 error.
	// The value of date should to be formatted like this:
	// " yyyy-mm-dd ", for example, "2021-06-10"
	Date string `protobuf:"bytes,2,opt,name=date,proto3" json:"date,omitempty"`
	// Optional.
	// If true, this means the transmission of the data on `date` is 100% done.
	// If not called or delayed, an email alert is fired.
	// Note: This has a significant impact on the performance, so please make sure
	// you call this correctly (timely and accurately).
	// Once a `date` is finalized, any new data with this `date` will be rejected.
	// There, please make sure `is_end` is sent when all the data of the `date`
	// is done transmitting. You could do this by sending the last request as an
	// empty request with only `is_end` being true after all the previous requests
	// done transmitting.
	IsEnd bool `protobuf:"varint,3,opt,name=is_end,json=isEnd,proto3" json:"is_end,omitempty"`
	// contains filtered or unexported fields
}

The config proto for the date.

func (*DateConfig) Descriptor deprecated 

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

Deprecated: Use DateConfig.ProtoReflect.Descriptor instead.

func (*DateConfig) GetDate 

func (x *DateConfig) GetDate() string

func (*DateConfig) GetIsEnd 

func (x *DateConfig) GetIsEnd() bool

func (*DateConfig) ProtoMessage 

func (*DateConfig) ProtoMessage()

func (*DateConfig) ProtoReflect 

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

func (*DateConfig) Reset 

func (x *DateConfig) Reset()

func (*DateConfig) String 

func (x *DateConfig) String() string

type ImportErrorsConfig 

type ImportErrorsConfig struct {

	// Required.
	// Errors destination. Currently only default to inline.
	//
	// Types that are assignable to Destination:
	//	*ImportErrorsConfig_EmptyDestination
	Destination isImportErrorsConfig_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

Configuration of destination for Import related errors.

func (*ImportErrorsConfig) Descriptor deprecated 

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

Deprecated: Use ImportErrorsConfig.ProtoReflect.Descriptor instead.

func (*ImportErrorsConfig) GetDestination 

func (m *ImportErrorsConfig) GetDestination() isImportErrorsConfig_Destination

func (*ImportErrorsConfig) GetEmptyDestination 

func (x *ImportErrorsConfig) GetEmptyDestination() 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_EmptyDestination 

type ImportErrorsConfig_EmptyDestination struct {
	// This is just a placeholder.
	EmptyDestination string `protobuf:"bytes,1,opt,name=empty_destination,json=emptyDestination,proto3,oneof"`
}

type ImportProductsRequest 

type ImportProductsRequest struct {

	// Required.
	// The desired input config of the data.
	InputConfig *ProductsInputConfig `protobuf:"bytes,1,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// Required.
	// The desired date config of the data.
	DateConfig *DateConfig `protobuf:"bytes,2,opt,name=date_config,json=dateConfig,proto3" json:"date_config,omitempty"`
	// Optional.
	// The desired config of errors incurred during the Import.
	ErrorsConfig *ImportErrorsConfig `protobuf:"bytes,3,opt,name=errors_config,json=errorsConfig,proto3" json:"errors_config,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request proto for the ImportProducts request.

func (*ImportProductsRequest) Descriptor deprecated 

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

Deprecated: Use ImportProductsRequest.ProtoReflect.Descriptor instead.

func (*ImportProductsRequest) GetDateConfig 

func (x *ImportProductsRequest) GetDateConfig() *DateConfig

func (*ImportProductsRequest) GetErrorsConfig 

func (x *ImportProductsRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportProductsRequest) GetExtra 

func (x *ImportProductsRequest) GetExtra() map[string]string

func (*ImportProductsRequest) GetInputConfig 

func (x *ImportProductsRequest) GetInputConfig() *ProductsInputConfig

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 {

	// Output only.
	// The status of the import call.
	// When `status.code` is 0, all payload are successfully imported.
	// If `status.code` is 1001, `error_samples` is populated.
	// Other non-zero values indicate all payload failed.
	Status *protocol.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Output only.
	// This field is populated when `status.code` is 1001.
	// When populated, this field contains the error samples.
	ErrorSamples []*ProductError `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// contains filtered or unexported fields
}

The response proto for ImportProducts call.

func (*ImportProductsResponse) Descriptor deprecated 

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

Deprecated: Use ImportProductsResponse.ProtoReflect.Descriptor instead.

func (*ImportProductsResponse) GetErrorSamples 

func (x *ImportProductsResponse) GetErrorSamples() []*ProductError

func (*ImportProductsResponse) GetStatus 

func (x *ImportProductsResponse) GetStatus() *protocol.Status

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.
	// The desired input location of the data.
	InputConfig *UserEventsInputConfig `protobuf:"bytes,1,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// Required.
	// The desired date config of the data.
	DateConfig *DateConfig `protobuf:"bytes,2,opt,name=date_config,json=dateConfig,proto3" json:"date_config,omitempty"`
	// Optional.
	// 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"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request proto for the ImportUserEvents request.

func (*ImportUserEventsRequest) Descriptor deprecated 

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

Deprecated: Use ImportUserEventsRequest.ProtoReflect.Descriptor instead.

func (*ImportUserEventsRequest) GetDateConfig 

func (x *ImportUserEventsRequest) GetDateConfig() *DateConfig

func (*ImportUserEventsRequest) GetErrorsConfig 

func (x *ImportUserEventsRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportUserEventsRequest) GetExtra 

func (x *ImportUserEventsRequest) GetExtra() map[string]string

func (*ImportUserEventsRequest) GetInputConfig 

func (x *ImportUserEventsRequest) GetInputConfig() *UserEventsInputConfig

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 {

	// Output only.
	// When `status.code` is 0, all payload are successfully written.
	// If `status.code` is 1001, `error_samples` is populated.
	// Other non-zero values indicate all payload failed.
	Status *protocol.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Output only.
	// This field is populated when `status.code` is 1001.
	// When populated, this field contains the error samples.
	ErrorSamples []*UserEventError `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// contains filtered or unexported fields
}

The response for the ImportUserEvents call.

func (*ImportUserEventsResponse) Descriptor deprecated 

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

Deprecated: Use ImportUserEventsResponse.ProtoReflect.Descriptor instead.

func (*ImportUserEventsResponse) GetErrorSamples 

func (x *ImportUserEventsResponse) GetErrorSamples() []*UserEventError

func (*ImportUserEventsResponse) GetStatus 

func (x *ImportUserEventsResponse) GetStatus() *protocol.Status

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 ImportUsersRequest 

type ImportUsersRequest struct {

	// Required.
	// The desired input config of the data.
	InputConfig *UsersInputConfig `protobuf:"bytes,1,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// Required.
	// The desired date config of the data.
	DateConfig *DateConfig `protobuf:"bytes,2,opt,name=date_config,json=dateConfig,proto3" json:"date_config,omitempty"`
	// Optional.
	// 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"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request proto for the ImportUsers request.

func (*ImportUsersRequest) Descriptor deprecated 

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

Deprecated: Use ImportUsersRequest.ProtoReflect.Descriptor instead.

func (*ImportUsersRequest) GetDateConfig 

func (x *ImportUsersRequest) GetDateConfig() *DateConfig

func (*ImportUsersRequest) GetErrorsConfig 

func (x *ImportUsersRequest) GetErrorsConfig() *ImportErrorsConfig

func (*ImportUsersRequest) GetExtra 

func (x *ImportUsersRequest) GetExtra() map[string]string

func (*ImportUsersRequest) GetInputConfig 

func (x *ImportUsersRequest) GetInputConfig() *UsersInputConfig

func (*ImportUsersRequest) ProtoMessage 

func (*ImportUsersRequest) ProtoMessage()

func (*ImportUsersRequest) ProtoReflect 

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

func (*ImportUsersRequest) Reset 

func (x *ImportUsersRequest) Reset()

func (*ImportUsersRequest) String 

func (x *ImportUsersRequest) String() string

type ImportUsersResponse 

type ImportUsersResponse struct {

	// Output only.
	// The status of the import call.
	// When `status.code` is 0, all payload are successfully imported.
	// If `status.code` is 1001, `error_samples` is populated.
	// Other non-zero values indicate all payload failed.
	Status *protocol.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Output only.
	// This field is populated when `status.code` is 1001.
	// When populated, this field contains the error samples.
	ErrorSamples []*UserError `protobuf:"bytes,2,rep,name=error_samples,json=errorSamples,proto3" json:"error_samples,omitempty"`
	// contains filtered or unexported fields
}

The response proto for ImportUsers call.

func (*ImportUsersResponse) Descriptor deprecated 

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

Deprecated: Use ImportUsersResponse.ProtoReflect.Descriptor instead.

func (*ImportUsersResponse) GetErrorSamples 

func (x *ImportUsersResponse) GetErrorSamples() []*UserError

func (*ImportUsersResponse) GetStatus 

func (x *ImportUsersResponse) GetStatus() *protocol.Status

func (*ImportUsersResponse) ProtoMessage 

func (*ImportUsersResponse) ProtoMessage()

func (*ImportUsersResponse) ProtoReflect 

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

func (*ImportUsersResponse) Reset 

func (x *ImportUsersResponse) Reset()

func (*ImportUsersResponse) String 

func (x *ImportUsersResponse) String() string

type PredictRequest 

type PredictRequest struct {

	// Required.
	// This is same as `User.user_id`.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Required.
	// The maximum number of products returned.
	// The actual # of products returned is the min of:
	// `size`
	// length(`context.candidates_product_ids`)
	// total # of products with `is_recommendable=True`
	Size int32 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`
	// Required.
	// The scene for the recommendation.
	Scene *UserEvent_Scene `protobuf:"bytes,3,opt,name=scene,proto3" json:"scene,omitempty"`
	// Optional.
	// The context of this request.
	Context *PredictRequest_Context `protobuf:"bytes,4,opt,name=context,proto3" json:"context,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

The request proto for `Predict` call.

func (*PredictRequest) Descriptor deprecated 

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

Deprecated: Use PredictRequest.ProtoReflect.Descriptor instead.

func (*PredictRequest) GetContext 

func (x *PredictRequest) GetContext() *PredictRequest_Context

func (*PredictRequest) GetExtra 

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

func (*PredictRequest) GetScene 

func (x *PredictRequest) GetScene() *UserEvent_Scene

func (*PredictRequest) GetSize 

func (x *PredictRequest) GetSize() int32

func (*PredictRequest) GetUserId 

func (x *PredictRequest) GetUserId() string

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 PredictRequest_Context 

type PredictRequest_Context struct {

	// Optional.
	// This is only required for product details page.
	RootProduct *Product `protobuf:"bytes,1,opt,name=root_product,json=rootProduct,proto3" json:"root_product,omitempty"`
	// Optional.
	// Make sure this is as close to `UserEvent.device` as possible.
	Device *UserEvent_Device `protobuf:"bytes,2,opt,name=device,proto3" json:"device,omitempty"`
	// Optional.
	// The list of candidates for the recommendation.
	// If this is empty, all products are the candidates.
	CandidateProductIds []string `protobuf:"bytes,3,rep,name=candidate_product_ids,json=candidateProductIds,proto3" json:"candidate_product_ids,omitempty"`
	// contains filtered or unexported fields
}

The context of this request.

func (*PredictRequest_Context) Descriptor deprecated 

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

Deprecated: Use PredictRequest_Context.ProtoReflect.Descriptor instead.

func (*PredictRequest_Context) GetCandidateProductIds 

func (x *PredictRequest_Context) GetCandidateProductIds() []string

func (*PredictRequest_Context) GetDevice 

func (x *PredictRequest_Context) GetDevice() *UserEvent_Device

func (*PredictRequest_Context) GetRootProduct 

func (x *PredictRequest_Context) GetRootProduct() *Product

func (*PredictRequest_Context) ProtoMessage 

func (*PredictRequest_Context) ProtoMessage()

func (*PredictRequest_Context) ProtoReflect 

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

func (*PredictRequest_Context) Reset 

func (x *PredictRequest_Context) Reset()

func (*PredictRequest_Context) String 

func (x *PredictRequest_Context) String() string

type PredictResponse 

type PredictResponse struct {

	// Output only.
	// The status of the call.
	Status *protocol.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Output only.
	// This is same as the request id of request.
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Output only.
	// This is only populated when `PredictResponse.status.code` is not 0.
	Value *PredictResult `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

The response proto the predict call.

func (*PredictResponse) Descriptor deprecated 

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

Deprecated: Use PredictResponse.ProtoReflect.Descriptor instead.

func (*PredictResponse) GetRequestId 

func (x *PredictResponse) GetRequestId() string

func (*PredictResponse) GetStatus 

func (x *PredictResponse) GetStatus() *protocol.Status

func (*PredictResponse) GetValue 

func (x *PredictResponse) GetValue() *PredictResult

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 PredictResult 

type PredictResult struct {

	// Output only.
	// The list of predicted products.
	ResponseProducts []*PredictResult_ResponseProduct `protobuf:"bytes,1,rep,name=response_products,json=responseProducts,proto3" json:"response_products,omitempty"`
	// Output only.
	// Extra debug info.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

A single predict call result.

func (*PredictResult) Descriptor deprecated 

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

Deprecated: Use PredictResult.ProtoReflect.Descriptor instead.

func (*PredictResult) GetExtra 

func (x *PredictResult) GetExtra() map[string]string

func (*PredictResult) GetResponseProducts 

func (x *PredictResult) GetResponseProducts() []*PredictResult_ResponseProduct

func (*PredictResult) ProtoMessage 

func (*PredictResult) ProtoMessage()

func (*PredictResult) ProtoReflect 

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

func (*PredictResult) Reset 

func (x *PredictResult) Reset()

func (*PredictResult) String 

func (x *PredictResult) String() string

type PredictResult_ResponseProduct 

type PredictResult_ResponseProduct struct {

	// Output only.
	// The product id.
	// This is consistent with `Product.product_id`.
	ProductId string `protobuf:"bytes,1,opt,name=product_id,json=productId,proto3" json:"product_id,omitempty"`
	// Output only.
	// This is the 1-based ranking of the product.
	Rank int32 `protobuf:"varint,2,opt,name=rank,proto3" json:"rank,omitempty"`
	// Output only.
	// The is the predicted CTR.
	Pctr float64 `protobuf:"fixed64,3,opt,name=pctr,proto3" json:"pctr,omitempty"`
	// Output only.
	// This is the predicted CVR.
	Pcvr float64 `protobuf:"fixed64,4,opt,name=pcvr,proto3" json:"pcvr,omitempty"`
	// Output only.
	// The strategy used for this particular recommendation result.
	// Please refer to [this](../docs/ways-to-improve-recommendation-performance#use-usereventrec_info-and-usereventtraffic_source) for more details.
	RecInfo string `protobuf:"bytes,5,opt,name=rec_info,json=recInfo,proto3" json:"rec_info,omitempty"`
	// Output only.
	// All the extra info here.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

The response of a product.

func (*PredictResult_ResponseProduct) Descriptor deprecated 

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

Deprecated: Use PredictResult_ResponseProduct.ProtoReflect.Descriptor instead.

func (*PredictResult_ResponseProduct) GetExtra 

func (x *PredictResult_ResponseProduct) GetExtra() map[string]string

func (*PredictResult_ResponseProduct) GetPctr 

func (x *PredictResult_ResponseProduct) GetPctr() float64

func (*PredictResult_ResponseProduct) GetPcvr 

func (x *PredictResult_ResponseProduct) GetPcvr() float64

func (*PredictResult_ResponseProduct) GetProductId 

func (x *PredictResult_ResponseProduct) GetProductId() string

func (*PredictResult_ResponseProduct) GetRank 

func (x *PredictResult_ResponseProduct) GetRank() int32

func (*PredictResult_ResponseProduct) GetRecInfo 

func (x *PredictResult_ResponseProduct) GetRecInfo() string

func (*PredictResult_ResponseProduct) ProtoMessage 

func (*PredictResult_ResponseProduct) ProtoMessage()

func (*PredictResult_ResponseProduct) ProtoReflect 

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

func (*PredictResult_ResponseProduct) Reset 

func (x *PredictResult_ResponseProduct) Reset()

func (*PredictResult_ResponseProduct) String 

func (x *PredictResult_ResponseProduct) String() string

type Product 

type Product struct {

	// Required.
	// The unique identifier for the product.
	// [link to best practices on deciding product ids](./ways-to-improve-recommendation-performance)
	ProductId string `protobuf:"bytes,1,opt,name=product_id,json=productId,proto3" json:"product_id,omitempty"`
	// Required.
	// The categorical information of the product.
	// Missing this will significantly hurt the performance.
	// For example, if a product has "Shoes -> Men's Shoes -> Basketball Shoes"
	// This should be:
	// [
	//   {"category_depth":1,
	//    "category_nodes": [{"id_or_name":"Shoes"}] },
	//   {"category_depth":2,
	//    "category_nodes": [{"id_or_name":"Men's Shoes"}] },
	//   {"category_depth":3,
	//    "category_nodes": [{"id_or_name":"Basketball Shoes"}] },
	// ]
	// If a product belongs to 2 different categories,
	// "Shoes -> Men's shoes" and "Sports -> Basketball"
	// then
	//
	// [
	//   {"category_depth":1,
	//    "category_nodes": [{"id_or_name":"Shoes"},
	//                       {"id_or_name":"Sports"}] },
	//   {"category_depth":2,
	//    "category_nodes": [{"id_or_name":"Men's shoes"},
	//                       {"id_or_name":"Basketball"}] },
	// ]
	Categories []*Product_Category `protobuf:"bytes,2,rep,name=categories,proto3" json:"categories,omitempty"`
	// Required.
	// Missing this will significantly hurt the performance.
	// The order should be asending on depth.
	// For example, if a product belongs to "Adidas -> Yeezy",
	// this field should be:
	// [
	//   {"brand_depth": 1, "id_or_name":"Adidas"},
	//   {"brand_depth": 2, "id_or_name":"Yeezy"},
	// ]
	Brands []*Product_Brand `protobuf:"bytes,3,rep,name=brands,proto3" json:"brands,omitempty"`
	// Required.
	// The product price info.
	// Please make sure the accuracy and recency.
	// Please refer to
	// [this](../docs/ways-to-improve-recommendation-performance#data-recency) for more details.
	Price *Product_Price `protobuf:"bytes,4,opt,name=price,proto3" json:"price,omitempty"`
	// Required.
	// True if the product is recommendable (result in `Predict` call).
	// Note: Any change of this takes up to 1 hour to take effect.
	// Note: Even if a product isn't recommendable, please still send this to us.
	// This is because that users might interact with such products historically,
	// therefore it provides reasonably strong signals.
	IsRecommendable bool `protobuf:"varint,5,opt,name=is_recommendable,json=isRecommendable,proto3" json:"is_recommendable,omitempty"`
	// Required.
	// The product title.
	Title string `protobuf:"bytes,6,opt,name=title,proto3" json:"title,omitempty"`
	// Optional.
	// The product quality score.
	// Note: this is different than user ratings.
	// It is normally computed as a composite score considering many factors,
	// including sales, customer feedback, information completeness, etc.
	// This score should be normalized to [1.0, 5.0]
	QualityScore float64 `protobuf:"fixed64,7,opt,name=quality_score,json=qualityScore,proto3" json:"quality_score,omitempty"`
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	Tags []string `protobuf:"bytes,8,rep,name=tags,proto3" json:"tags,omitempty"`
	// Optional.
	// The display information of the product.
	Display *Product_Display `protobuf:"bytes,9,opt,name=display,proto3" json:"display,omitempty"`
	// Optional.
	// The product specs.
	ProductSpec *Product_ProductSpec `protobuf:"bytes,10,opt,name=product_spec,json=productSpec,proto3" json:"product_spec,omitempty"`
	// Optional.
	// The seller proto.
	Seller *Product_Seller `protobuf:"bytes,11,opt,name=seller,proto3" json:"seller,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

The product proto.

func (*Product) Descriptor deprecated 

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

Deprecated: Use Product.ProtoReflect.Descriptor instead.

func (*Product) GetBrands 

func (x *Product) GetBrands() []*Product_Brand

func (*Product) GetCategories 

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

func (*Product) GetDisplay 

func (x *Product) GetDisplay() *Product_Display

func (*Product) GetExtra 

func (x *Product) GetExtra() map[string]string

func (*Product) GetIsRecommendable 

func (x *Product) GetIsRecommendable() bool

func (*Product) GetPrice 

func (x *Product) GetPrice() *Product_Price

func (*Product) GetProductId 

func (x *Product) GetProductId() string

func (*Product) GetProductSpec 

func (x *Product) GetProductSpec() *Product_ProductSpec

func (*Product) GetQualityScore 

func (x *Product) GetQualityScore() float64

func (*Product) GetSeller 

func (x *Product) GetSeller() *Product_Seller

func (*Product) GetTags 

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

func (*Product) GetTitle 

func (x *Product) GetTitle() 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 ProductError 

type ProductError struct {

	// Output only.
	// The detailed error message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// Output only.
	// The product that failed.
	Product *Product `protobuf:"bytes,2,opt,name=product,proto3" json:"product,omitempty"`
	// contains filtered or unexported fields
}

The product error.

func (*ProductError) Descriptor deprecated 

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

Deprecated: Use ProductError.ProtoReflect.Descriptor instead.

func (*ProductError) GetMessage 

func (x *ProductError) GetMessage() string

func (*ProductError) GetProduct 

func (x *ProductError) GetProduct() *Product

func (*ProductError) ProtoMessage 

func (*ProductError) ProtoMessage()

func (*ProductError) ProtoReflect 

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

func (*ProductError) Reset 

func (x *ProductError) Reset()

func (*ProductError) String 

func (x *ProductError) String() string

type Product_Brand 

type Product_Brand struct {

	// Required.
	// The brand depth. This is consecutive (1-based) and ascending.
	BrandDepth int32 `protobuf:"varint,1,opt,name=brand_depth,json=brandDepth,proto3" json:"brand_depth,omitempty"`
	// Required.
	// The id or name of the brand at this depth.
	IdOrName string `protobuf:"bytes,2,opt,name=id_or_name,json=idOrName,proto3" json:"id_or_name,omitempty"`
	// contains filtered or unexported fields
}

The brand proto.

func (*Product_Brand) Descriptor deprecated 

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

Deprecated: Use Product_Brand.ProtoReflect.Descriptor instead.

func (*Product_Brand) GetBrandDepth 

func (x *Product_Brand) GetBrandDepth() int32

func (*Product_Brand) GetIdOrName 

func (x *Product_Brand) GetIdOrName() string

func (*Product_Brand) ProtoMessage 

func (*Product_Brand) ProtoMessage()

func (*Product_Brand) ProtoReflect 

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

func (*Product_Brand) Reset 

func (x *Product_Brand) Reset()

func (*Product_Brand) String 

func (x *Product_Brand) String() string

type Product_Category 

type Product_Category struct {

	// Required.
	// The depth of the category.
	// This is consecutive (1-based) and ascending.
	CategoryDepth int32 `protobuf:"varint,1,opt,name=category_depth,json=categoryDepth,proto3" json:"category_depth,omitempty"`
	// Required.
	// The category nodes belong to the same depth.
	CategoryNodes []*Product_Category_CategoryNode `protobuf:"bytes,2,rep,name=category_nodes,json=categoryNodes,proto3" json:"category_nodes,omitempty"`
	// contains filtered or unexported fields
}

The category proto.

func (*Product_Category) Descriptor deprecated 

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

Deprecated: Use Product_Category.ProtoReflect.Descriptor instead.

func (*Product_Category) GetCategoryDepth 

func (x *Product_Category) GetCategoryDepth() int32

func (*Product_Category) GetCategoryNodes 

func (x *Product_Category) GetCategoryNodes() []*Product_Category_CategoryNode

func (*Product_Category) ProtoMessage 

func (*Product_Category) ProtoMessage()

func (*Product_Category) ProtoReflect 

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

func (*Product_Category) Reset 

func (x *Product_Category) Reset()

func (*Product_Category) String 

func (x *Product_Category) String() string

type Product_Category_CategoryNode 

type Product_Category_CategoryNode struct {
	IdOrName string `protobuf:"bytes,1,opt,name=id_or_name,json=idOrName,proto3" json:"id_or_name,omitempty"`
	// contains filtered or unexported fields
}

The single node of the category.

func (*Product_Category_CategoryNode) Descriptor deprecated 

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

Deprecated: Use Product_Category_CategoryNode.ProtoReflect.Descriptor instead.

func (*Product_Category_CategoryNode) GetIdOrName 

func (x *Product_Category_CategoryNode) GetIdOrName() string

func (*Product_Category_CategoryNode) ProtoMessage 

func (*Product_Category_CategoryNode) ProtoMessage()

func (*Product_Category_CategoryNode) ProtoReflect 

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

func (*Product_Category_CategoryNode) Reset 

func (x *Product_Category_CategoryNode) Reset()

func (*Product_Category_CategoryNode) String 

func (x *Product_Category_CategoryNode) String() string

type Product_Display 

type Product_Display struct {

	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	ListingPageDisplayTags []string `` /* 131-byte string literal not displayed */
	// Optional.
	// The tags visible in the details page.
	// Please fill as much as possible.
	// Sample values are: "free shipping", "1 year guarantee", etc
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	DetailPageDisplayTags []string `` /* 128-byte string literal not displayed */
	// Optional.
	// The product display media type in ths listing page.
	// The only acceptable values are ["image", "video", "other"].
	ListingPageDisplayType string `` /* 131-byte string literal not displayed */
	// Optional.
	// When `listing_page_display_type` is one of the multi-media types,
	// put the url here.
	CoverMultimediaUrl string `protobuf:"bytes,4,opt,name=cover_multimedia_url,json=coverMultimediaUrl,proto3" json:"cover_multimedia_url,omitempty"`
	// contains filtered or unexported fields
}

The product display information.

func (*Product_Display) Descriptor deprecated 

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

Deprecated: Use Product_Display.ProtoReflect.Descriptor instead.

func (*Product_Display) GetCoverMultimediaUrl 

func (x *Product_Display) GetCoverMultimediaUrl() string

func (*Product_Display) GetDetailPageDisplayTags 

func (x *Product_Display) GetDetailPageDisplayTags() []string

func (*Product_Display) GetListingPageDisplayTags 

func (x *Product_Display) GetListingPageDisplayTags() []string

func (*Product_Display) GetListingPageDisplayType 

func (x *Product_Display) GetListingPageDisplayType() string

func (*Product_Display) ProtoMessage 

func (*Product_Display) ProtoMessage()

func (*Product_Display) ProtoReflect 

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

func (*Product_Display) Reset 

func (x *Product_Display) Reset()

func (*Product_Display) String 

func (x *Product_Display) String() string

type Product_Price 

type Product_Price struct {

	// Required.
	// The current price in cents.
	// e.g. $100.12 should be 10012 here.
	CurrentPrice int64 `protobuf:"varint,1,opt,name=current_price,json=currentPrice,proto3" json:"current_price,omitempty"`
	// Required.
	// The original price in cents.
	// e.g. $100.12 should be 10012 here.
	OriginPrice int64 `protobuf:"varint,2,opt,name=origin_price,json=originPrice,proto3" json:"origin_price,omitempty"`
	// contains filtered or unexported fields
}

The price proto. Please make sure the products that need to be ranked together have the same currency.

func (*Product_Price) Descriptor deprecated 

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

Deprecated: Use Product_Price.ProtoReflect.Descriptor instead.

func (*Product_Price) GetCurrentPrice 

func (x *Product_Price) GetCurrentPrice() int64

func (*Product_Price) GetOriginPrice 

func (x *Product_Price) GetOriginPrice() int64

func (*Product_Price) ProtoMessage 

func (*Product_Price) ProtoMessage()

func (*Product_Price) ProtoReflect 

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

func (*Product_Price) Reset 

func (x *Product_Price) Reset()

func (*Product_Price) String 

func (x *Product_Price) String() string

type Product_ProductSpec 

type Product_ProductSpec struct {

	// Required.
	// The product group id.
	// For example, the beer (same brand) might have 6-pack, 12-pack, etc,
	// each has a different `product_id`, then they should have the
	// `same product_group_id`
	ProductGroupId string `protobuf:"bytes,1,opt,name=product_group_id,json=productGroupId,proto3" json:"product_group_id,omitempty"`
	// Optional.
	// The rating given by the users.
	// The value is normalized to [0.0, 5.0].
	UserRating float64 `protobuf:"fixed64,2,opt,name=user_rating,json=userRating,proto3" json:"user_rating,omitempty"`
	// Optional.
	// The # of comments for this product.
	CommentCount int32 `protobuf:"varint,3,opt,name=comment_count,json=commentCount,proto3" json:"comment_count,omitempty"`
	// Optional.
	// The source of the product.
	// The accepted values are ["self", "thirdparty", "other"].
	Source string `protobuf:"bytes,4,opt,name=source,proto3" json:"source,omitempty"`
	// Optional.
	// The time that the product is on sales.
	PublishTimestamp int64 `protobuf:"varint,5,opt,name=publish_timestamp,json=publishTimestamp,proto3" json:"publish_timestamp,omitempty"`
	// contains filtered or unexported fields
}

The detailed product specs.

func (*Product_ProductSpec) Descriptor deprecated 

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

Deprecated: Use Product_ProductSpec.ProtoReflect.Descriptor instead.

func (*Product_ProductSpec) GetCommentCount 

func (x *Product_ProductSpec) GetCommentCount() int32

func (*Product_ProductSpec) GetProductGroupId 

func (x *Product_ProductSpec) GetProductGroupId() string

func (*Product_ProductSpec) GetPublishTimestamp 

func (x *Product_ProductSpec) GetPublishTimestamp() int64

func (*Product_ProductSpec) GetSource 

func (x *Product_ProductSpec) GetSource() string

func (*Product_ProductSpec) GetUserRating 

func (x *Product_ProductSpec) GetUserRating() float64

func (*Product_ProductSpec) ProtoMessage 

func (*Product_ProductSpec) ProtoMessage()

func (*Product_ProductSpec) ProtoReflect 

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

func (*Product_ProductSpec) Reset 

func (x *Product_ProductSpec) Reset()

func (*Product_ProductSpec) String 

func (x *Product_ProductSpec) String() string

type Product_Seller 

type Product_Seller struct {

	// Required.
	// The id for the seller.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Optional.
	// The seller's level.
	// The sample values are "gold", "silver", etc.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	SellerLevel string `protobuf:"bytes,2,opt,name=seller_level,json=sellerLevel,proto3" json:"seller_level,omitempty"`
	// Optional.
	// The seller's rating.
	// Normalized to [0.0, 5.0].
	SellerRating float64 `protobuf:"fixed64,3,opt,name=seller_rating,json=sellerRating,proto3" json:"seller_rating,omitempty"`
	// contains filtered or unexported fields
}

Seller info.

func (*Product_Seller) Descriptor deprecated 

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

Deprecated: Use Product_Seller.ProtoReflect.Descriptor instead.

func (*Product_Seller) GetId 

func (x *Product_Seller) GetId() string

func (*Product_Seller) GetSellerLevel 

func (x *Product_Seller) GetSellerLevel() string

func (*Product_Seller) GetSellerRating 

func (x *Product_Seller) GetSellerRating() float64

func (*Product_Seller) ProtoMessage 

func (*Product_Seller) ProtoMessage()

func (*Product_Seller) ProtoReflect 

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

func (*Product_Seller) Reset 

func (x *Product_Seller) Reset()

func (*Product_Seller) String 

func (x *Product_Seller) String() string

type ProductsInlineSource 

type ProductsInlineSource struct {

	// Optional.
	// A list of products to import.
	// The max # of items allowed is 2k.
	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 (*ProductsInlineSource) Descriptor deprecated 

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

Deprecated: Use ProductsInlineSource.ProtoReflect.Descriptor instead.

func (*ProductsInlineSource) GetProducts 

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

func (*ProductsInlineSource) ProtoMessage 

func (*ProductsInlineSource) ProtoMessage()

func (*ProductsInlineSource) ProtoReflect 

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

func (*ProductsInlineSource) Reset 

func (x *ProductsInlineSource) Reset()

func (*ProductsInlineSource) String 

func (x *ProductsInlineSource) String() string

type ProductsInputConfig 

type ProductsInputConfig struct {

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

The input config source.

func (*ProductsInputConfig) Descriptor deprecated 

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

Deprecated: Use ProductsInputConfig.ProtoReflect.Descriptor instead.

func (*ProductsInputConfig) GetProductsInlineSource 

func (x *ProductsInputConfig) GetProductsInlineSource() *ProductsInlineSource

func (*ProductsInputConfig) GetSource 

func (m *ProductsInputConfig) GetSource() isProductsInputConfig_Source

func (*ProductsInputConfig) ProtoMessage 

func (*ProductsInputConfig) ProtoMessage()

func (*ProductsInputConfig) ProtoReflect 

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

func (*ProductsInputConfig) Reset 

func (x *ProductsInputConfig) Reset()

func (*ProductsInputConfig) String 

func (x *ProductsInputConfig) String() string

type ProductsInputConfig_ProductsInlineSource 

type ProductsInputConfig_ProductsInlineSource struct {
	// The Inline source for the input content for products.
	ProductsInlineSource *ProductsInlineSource `protobuf:"bytes,1,opt,name=products_inline_source,json=productsInlineSource,proto3,oneof"`
}

type User 

type User struct {

	// Required.
	// The unique user identifier.
	// The consistency is required (for the same user) among different
	// UserEvents, PredictRequest, or any other places.
	// Device ID or member ID is often used as user_id here.
	//
	// Note: If you want to encrypt the id and used the hashed value here,
	// please do the consistent encryption for all its appearances,
	// including UserEvents and Predict Requests.
	//
	// Note: If your users often switch between login/logout status
	// (In web or mobile application), you might get inconsistent IDs
	// (member v.s. visitor) for the same user.
	// To avoid this, we suggested that you can use consistent ID like device ID.
	// Sample values are "1234567", "359938082141597",
	// "665DEA957EBFB34D41B1F1D80E4B5F89"
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#stable-user-identifier) for more details.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Optional.
	// The gender of the given user.
	// The accepted values are: "male", "female", and "other".
	Gender string `protobuf:"bytes,2,opt,name=gender,proto3" json:"gender,omitempty"`
	// Optional.
	// The age of the given user.
	// It can be the an (estimate) single value, or a range.
	// e.g. "23", "18-25", "0-15", "50-100", etc
	Age string `protobuf:"bytes,3,opt,name=age,proto3" json:"age,omitempty"`
	// Optional.
	// The tags for the given user.
	// Please send as many tags as possible here, even it might be a bit
	// inaccurate or has low coverage.
	// Some sample values are "new users", "high buying power", etc.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	Tags []string `protobuf:"bytes,4,rep,name=tags,proto3" json:"tags,omitempty"`
	// Optional.
	// The channel where the given user is acquired.
	// Some sample values are "AppStore", "GoogleAds", "FacebookAds", etc.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	ActivationChannel string `protobuf:"bytes,5,opt,name=activation_channel,json=activationChannel,proto3" json:"activation_channel,omitempty"`
	// Optional.
	// The level of the membership.
	// Some sample values are "silver", "elite", "4", "5", etc.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	MembershipLevel string `protobuf:"bytes,6,opt,name=membership_level,json=membershipLevel,proto3" json:"membership_level,omitempty"`
	// Optional.
	// The timestamp when the given user activated or registered.
	RegistrationTimestamp int64 `protobuf:"varint,7,opt,name=registration_timestamp,json=registrationTimestamp,proto3" json:"registration_timestamp,omitempty"`
	// Optional.
	// The user location info.
	// If the user has multiple locations, please make sure you update it with the
	// most recent one.
	// Please refer to
	// [this](../docs/ways-to-improve-recommendation-performance#data-recency) for more details.
	Location *User_Location `protobuf:"bytes,8,opt,name=location,proto3" json:"location,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

The user proto.

func (*User) Descriptor deprecated 

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

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetActivationChannel 

func (x *User) GetActivationChannel() string

func (*User) GetAge 

func (x *User) GetAge() string

func (*User) GetExtra 

func (x *User) GetExtra() map[string]string

func (*User) GetGender 

func (x *User) GetGender() string

func (*User) GetLocation 

func (x *User) GetLocation() *User_Location

func (*User) GetMembershipLevel 

func (x *User) GetMembershipLevel() string

func (*User) GetRegistrationTimestamp 

func (x *User) GetRegistrationTimestamp() int64

func (*User) GetTags 

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

func (*User) GetUserId 

func (x *User) GetUserId() string

func (*User) ProtoMessage 

func (*User) ProtoMessage()

func (*User) ProtoReflect 

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

func (*User) Reset 

func (x *User) Reset()

func (*User) String 

func (x *User) String() string

type UserError 

type UserError struct {

	// Output only.
	// The detailed error message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// Output only.
	// This is the exact same user proto that was passed in the request.
	User *User `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

The error proto for a single user.

func (*UserError) Descriptor deprecated 

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

Deprecated: Use UserError.ProtoReflect.Descriptor instead.

func (*UserError) GetMessage 

func (x *UserError) GetMessage() string

func (*UserError) GetUser 

func (x *UserError) GetUser() *User

func (*UserError) ProtoMessage 

func (*UserError) ProtoMessage()

func (*UserError) ProtoReflect 

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

func (*UserError) Reset 

func (x *UserError) Reset()

func (*UserError) String 

func (x *UserError) String() string

type UserEvent 

type UserEvent struct {

	// Required.
	// The unique user identifier.
	// Please refer to `User.user_id` for the details.
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Required.
	// The user event type.
	// The acceptable values are:
	// "impression", "click", "add-to-cart", "remove-from-cart",
	// "add-to-favorites", "remove-from-favorites", "purchase", "search",
	// "stay-detail-page"
	//
	// Here are the definitions:
	//
	// impression: The product is shown to the user.
	//             It can be server-side impression or (prefered) client-side.
	//             Note: product_id must be non-empty.
	//
	// click     : The user clicked into the product details page.
	//             Note: product_id must be non-empty.
	//
	// add-to-cart : The user added the product in the shopping cart.
	//             Note: product_id must be non-empty.
	//
	// remove-from-cart : The user removed the product from the shopping cart.
	//             Note: product_id must be non-empty.
	//
	// add-to-favorites : The user added the product to favorites.
	//             Note: product_id must be non-empty.
	//
	// remove-from-favorites : The user removed the product from favorites.
	//             Note: product_id must be non-empty.
	//
	// purchase  : The user finished the purchase.
	//             Note: If one order contains multiple products, please use
	//             more than one user event to transmit. If one order contains
	//             the same product multiple times, use `this.purchase_count`.
	//
	// search    : The user search event.
	//           : Note: `this.Context.query` must be non-empty.
	//
	// stay-detail-page: The user leave product details page, report the user stay
	//             time on product details page.
	//             Note: product_id must be non-empty.
	//
	// Note: This field is only for the event type, the actual scene is kept
	// separately.
	EventType string `protobuf:"bytes,2,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
	// Required.
	// The time when the event happened.
	EventTimestamp int64 `protobuf:"varint,3,opt,name=event_timestamp,json=eventTimestamp,proto3" json:"event_timestamp,omitempty"`
	// Optional.
	// If `event_type` is impression or click, this is required.
	// If `event type` is cart/favorite/purchase, this is optional.
	Scene *UserEvent_Scene `protobuf:"bytes,4,opt,name=scene,proto3" json:"scene,omitempty"`
	// Optional.
	// When event_type is search, this field should be empty.
	// Otherwise it is required.
	ProductId string `protobuf:"bytes,5,opt,name=product_id,json=productId,proto3" json:"product_id,omitempty"`
	// Required.
	// The device info.
	Device *UserEvent_Device `protobuf:"bytes,6,opt,name=device,proto3" json:"device,omitempty"`
	// Optional.
	// The context for this event.
	Context *UserEvent_Context `protobuf:"bytes,7,opt,name=context,proto3" json:"context,omitempty"`
	// Optional.
	// This is strongly recommended to hook all the relevant events towards
	// purchase.
	AttributionToken string `protobuf:"bytes,8,opt,name=attribution_token,json=attributionToken,proto3" json:"attribution_token,omitempty"`
	// Optional.
	// This contains the strategy info from BytePlus.
	// Please refer to
	// [this](../docs/ways-to-improve-recommendation-performance#use-usereventrec_info-and-usereventtraffic_source) for more details.
	/// 可选字段，只需要对来自Byteplus的推荐结果填充此字段，获取Byteplus推荐结果时，可选保存PredictResult.ResponseProduct.rec_info字段值到此字段，并透传到后续曝光点击转化等用户行为中，用户辅助Byteplus提升推荐效果。参照 link PredictResult.ResponseProduct.rec_info
	RecInfo string `protobuf:"bytes,9,opt,name=rec_info,json=recInfo,proto3" json:"rec_info,omitempty"`
	// Optional.
	// The source strategy for this user event.
	// Acceptable values are "self", "byteplus", "other".
	// self   :  came from caller's own engine.
	// byteplus:  came from byteplus's engine.
	// other  :  came from the third-party engine.
	// Please refer to
	// [this](../docs/ways-to-improve-recommendation-performance#use-usereventrec_info-and-usereventtraffic_source) for more details.
	TrafficSource string `protobuf:"bytes,10,opt,name=traffic_source,json=trafficSource,proto3" json:"traffic_source,omitempty"`
	// Optional.
	// When event_type is purchase, this field must be non-zero.
	PurchaseCount int32 `protobuf:"varint,11,opt,name=purchase_count,json=purchaseCount,proto3" json:"purchase_count,omitempty"`
	// Optional.
	// The stay time(in seconds) on detail page.
	// When event_type is stay-detail-page, this field must be non-zero.
	DetailPageStayTime int32 `protobuf:"varint,12,opt,name=detail_page_stay_time,json=detailPageStayTime,proto3" json:"detail_page_stay_time,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

The proto that represents an user event.

func (*UserEvent) Descriptor deprecated 

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

Deprecated: Use UserEvent.ProtoReflect.Descriptor instead.

func (*UserEvent) GetAttributionToken 

func (x *UserEvent) GetAttributionToken() string

func (*UserEvent) GetContext 

func (x *UserEvent) GetContext() *UserEvent_Context

func (*UserEvent) GetDetailPageStayTime 

func (x *UserEvent) GetDetailPageStayTime() int32

func (*UserEvent) GetDevice 

func (x *UserEvent) GetDevice() *UserEvent_Device

func (*UserEvent) GetEventTimestamp 

func (x *UserEvent) GetEventTimestamp() int64

func (*UserEvent) GetEventType 

func (x *UserEvent) GetEventType() string

func (*UserEvent) GetExtra 

func (x *UserEvent) GetExtra() map[string]string

func (*UserEvent) GetProductId 

func (x *UserEvent) GetProductId() string

func (*UserEvent) GetPurchaseCount 

func (x *UserEvent) GetPurchaseCount() int32

func (*UserEvent) GetRecInfo 

func (x *UserEvent) GetRecInfo() string

func (*UserEvent) GetScene 

func (x *UserEvent) GetScene() *UserEvent_Scene

func (*UserEvent) GetTrafficSource 

func (x *UserEvent) GetTrafficSource() string

func (*UserEvent) GetUserId 

func (x *UserEvent) GetUserId() 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 UserEventError 

type UserEventError struct {

	// Output only.
	// The detailed error message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// Output only.
	// This is the exact same user proto that was passed in the request.
	UserEvent *UserEvent `protobuf:"bytes,2,opt,name=user_event,json=userEvent,proto3" json:"user_event,omitempty"`
	// contains filtered or unexported fields
}

The error detail for a single user event.

func (*UserEventError) Descriptor deprecated 

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

Deprecated: Use UserEventError.ProtoReflect.Descriptor instead.

func (*UserEventError) GetMessage 

func (x *UserEventError) GetMessage() string

func (*UserEventError) GetUserEvent 

func (x *UserEventError) GetUserEvent() *UserEvent

func (*UserEventError) ProtoMessage 

func (*UserEventError) ProtoMessage()

func (*UserEventError) ProtoReflect 

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

func (*UserEventError) Reset 

func (x *UserEventError) Reset()

func (*UserEventError) String 

func (x *UserEventError) String() string

type UserEvent_Context 

type UserEvent_Context struct {

	// Optional.
	// This is required for the search event.
	// Please also provide this when the purchase/impression event follows the search event.
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Optional.
	// The main product id on the "related to this product" page.
	RootProductId string `protobuf:"bytes,2,opt,name=root_product_id,json=rootProductId,proto3" json:"root_product_id,omitempty"`
	// contains filtered or unexported fields
}

The context for this event.

func (*UserEvent_Context) Descriptor deprecated 

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

Deprecated: Use UserEvent_Context.ProtoReflect.Descriptor instead.

func (*UserEvent_Context) GetQuery 

func (x *UserEvent_Context) GetQuery() string

func (*UserEvent_Context) GetRootProductId 

func (x *UserEvent_Context) GetRootProductId() string

func (*UserEvent_Context) ProtoMessage 

func (*UserEvent_Context) ProtoMessage()

func (*UserEvent_Context) ProtoReflect 

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

func (*UserEvent_Context) Reset 

func (x *UserEvent_Context) Reset()

func (*UserEvent_Context) String 

func (x *UserEvent_Context) String() string

type UserEvent_Device 

type UserEvent_Device struct {

	// Required.
	// The platform used by the user.
	// The acceptable values are "app", "desktop-web", "mobile-web", "other".
	// app: user use APP
	// desktop-web: user use desktop web
	// mobile-web: user use mobile web
	Platform string `protobuf:"bytes,1,opt,name=platform,proto3" json:"platform,omitempty"`
	// Optional.
	// The platform used by the user.
	// The acceptable values are "android", "ios", "windows", "other"
	// and "other".
	OsType string `protobuf:"bytes,2,opt,name=os_type,json=osType,proto3" json:"os_type,omitempty"`
	// Optional.
	// Your application version.
	// e.g. V9.0.8.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	AppVersion string `protobuf:"bytes,3,opt,name=app_version,json=appVersion,proto3" json:"app_version,omitempty"`
	// Optional.
	// The device model.
	// e.g. "iPhone10", "Pixel 4".
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	DeviceModel string `protobuf:"bytes,4,opt,name=device_model,json=deviceModel,proto3" json:"device_model,omitempty"`
	// Optional.
	// The brand of the device.
	// e.g. "Samsung"
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	DeviceBrand string `protobuf:"bytes,5,opt,name=device_brand,json=deviceBrand,proto3" json:"device_brand,omitempty"`
	// Optional.
	// The operating system version.
	// e.g. "14.4.2"
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	OsVersion string `protobuf:"bytes,6,opt,name=os_version,json=osVersion,proto3" json:"os_version,omitempty"`
	// Optional.
	// The type of the browser.
	// e.g. "chrome", "firefox", etc.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	BrowserType string `protobuf:"bytes,7,opt,name=browser_type,json=browserType,proto3" json:"browser_type,omitempty"`
	// Optional.
	// The UserAgent for the browser.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	UserAgent string `protobuf:"bytes,8,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
	// Optional.
	// The network used.
	// The acceptable values are "2g", "3g", "4g", "5g", "wifi", "other".
	Network string `protobuf:"bytes,9,opt,name=network,proto3" json:"network,omitempty"`
	// contains filtered or unexported fields
}

The device proto.

func (*UserEvent_Device) Descriptor deprecated 

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

Deprecated: Use UserEvent_Device.ProtoReflect.Descriptor instead.

func (*UserEvent_Device) GetAppVersion 

func (x *UserEvent_Device) GetAppVersion() string

func (*UserEvent_Device) GetBrowserType 

func (x *UserEvent_Device) GetBrowserType() string

func (*UserEvent_Device) GetDeviceBrand 

func (x *UserEvent_Device) GetDeviceBrand() string

func (*UserEvent_Device) GetDeviceModel 

func (x *UserEvent_Device) GetDeviceModel() string

func (*UserEvent_Device) GetNetwork 

func (x *UserEvent_Device) GetNetwork() string

func (*UserEvent_Device) GetOsType 

func (x *UserEvent_Device) GetOsType() string

func (*UserEvent_Device) GetOsVersion 

func (x *UserEvent_Device) GetOsVersion() string

func (*UserEvent_Device) GetPlatform 

func (x *UserEvent_Device) GetPlatform() string

func (*UserEvent_Device) GetUserAgent 

func (x *UserEvent_Device) GetUserAgent() string

func (*UserEvent_Device) ProtoMessage 

func (*UserEvent_Device) ProtoMessage()

func (*UserEvent_Device) ProtoReflect 

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

func (*UserEvent_Device) Reset 

func (x *UserEvent_Device) Reset()

func (*UserEvent_Device) String 

func (x *UserEvent_Device) String() string

type UserEvent_Scene 

type UserEvent_Scene struct {

	// Required.
	// The unique identifier for the scene.
	// It can be Home page, Search page, Details page, etc.
	// It is strongly recommended that you split the scene if possible.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	SceneName string `protobuf:"bytes,1,opt,name=scene_name,json=sceneName,proto3" json:"scene_name,omitempty"`
	// Optional.
	// The page number.
	// It can be:
	// 1. Users swipe the screen for X times then see the product.
	// 2. Users go to page X and see the product.
	// In this case, X is the page number.
	//
	// This should default to be 0. That means everything fits into 1 page.
	PageNumber int32 `protobuf:"varint,2,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
	// Optional.
	// The offset (1-based) within the page above.
	Offset int32 `protobuf:"varint,3,opt,name=offset,proto3" json:"offset,omitempty"`
	// contains filtered or unexported fields
}

The scene where the event happened.

func (*UserEvent_Scene) Descriptor deprecated 

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

Deprecated: Use UserEvent_Scene.ProtoReflect.Descriptor instead.

func (*UserEvent_Scene) GetOffset 

func (x *UserEvent_Scene) GetOffset() int32

func (*UserEvent_Scene) GetPageNumber 

func (x *UserEvent_Scene) GetPageNumber() int32

func (*UserEvent_Scene) GetSceneName 

func (x *UserEvent_Scene) GetSceneName() string

func (*UserEvent_Scene) ProtoMessage 

func (*UserEvent_Scene) ProtoMessage()

func (*UserEvent_Scene) ProtoReflect 

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

func (*UserEvent_Scene) Reset 

func (x *UserEvent_Scene) Reset()

func (*UserEvent_Scene) String 

func (x *UserEvent_Scene) String() string

type UserEventsInlineSource 

type UserEventsInlineSource struct {

	// Optional.
	// A list of user events to import.
	// The max # of items allowed is 2k.
	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 (*UserEventsInlineSource) Descriptor deprecated 

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

Deprecated: Use UserEventsInlineSource.ProtoReflect.Descriptor instead.

func (*UserEventsInlineSource) GetUserEvents 

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

func (*UserEventsInlineSource) ProtoMessage 

func (*UserEventsInlineSource) ProtoMessage()

func (*UserEventsInlineSource) ProtoReflect 

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

func (*UserEventsInlineSource) Reset 

func (x *UserEventsInlineSource) Reset()

func (*UserEventsInlineSource) String 

func (x *UserEventsInlineSource) String() string

type UserEventsInputConfig 

type UserEventsInputConfig struct {

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

The input config source.

func (*UserEventsInputConfig) Descriptor deprecated 

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

Deprecated: Use UserEventsInputConfig.ProtoReflect.Descriptor instead.

func (*UserEventsInputConfig) GetSource 

func (m *UserEventsInputConfig) GetSource() isUserEventsInputConfig_Source

func (*UserEventsInputConfig) GetUserEventsInlineSource 

func (x *UserEventsInputConfig) GetUserEventsInlineSource() *UserEventsInlineSource

func (*UserEventsInputConfig) ProtoMessage 

func (*UserEventsInputConfig) ProtoMessage()

func (*UserEventsInputConfig) ProtoReflect 

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

func (*UserEventsInputConfig) Reset 

func (x *UserEventsInputConfig) Reset()

func (*UserEventsInputConfig) String 

func (x *UserEventsInputConfig) String() string

type UserEventsInputConfig_UserEventsInlineSource 

type UserEventsInputConfig_UserEventsInlineSource struct {
	// The Inline source for the input content for UserEvents.
	UserEventsInlineSource *UserEventsInlineSource `protobuf:"bytes,1,opt,name=user_events_inline_source,json=userEventsInlineSource,proto3,oneof"`
}

type User_Location 

type User_Location struct {

	// Optional.
	// Country name.
	// Some sample values are "USA", "UK", etc.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	Country string `protobuf:"bytes,1,opt,name=country,proto3" json:"country,omitempty"`
	// Optional.
	// City name.
	// Some sample values are "San Jose", "Chicago", "NYC", etc.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	City string `protobuf:"bytes,2,opt,name=city,proto3" json:"city,omitempty"`
	// Optional.
	// The more fine grained district or area.
	// Some sample values are "king county", "santa monica county", etc.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	DistrictOrArea string `protobuf:"bytes,3,opt,name=district_or_area,json=districtOrArea,proto3" json:"district_or_area,omitempty"`
	// Optional.
	// Postal code of the address. Not all countries use or require postal codes
	// to be present.
	Postcode string `protobuf:"bytes,4,opt,name=postcode,proto3" json:"postcode,omitempty"`
	// contains filtered or unexported fields
}

Optional. The location info.

func (*User_Location) Descriptor deprecated 

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

Deprecated: Use User_Location.ProtoReflect.Descriptor instead.

func (*User_Location) GetCity 

func (x *User_Location) GetCity() string

func (*User_Location) GetCountry 

func (x *User_Location) GetCountry() string

func (*User_Location) GetDistrictOrArea 

func (x *User_Location) GetDistrictOrArea() string

func (*User_Location) GetPostcode 

func (x *User_Location) GetPostcode() string

func (*User_Location) ProtoMessage 

func (*User_Location) ProtoMessage()

func (*User_Location) ProtoReflect 

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

func (*User_Location) Reset 

func (x *User_Location) Reset()

func (*User_Location) String 

func (x *User_Location) String() string

type UsersInlineSource 

type UsersInlineSource struct {

	// Optional.
	// A list of users to import. The max # of items supported is 2k.
	Users []*User `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"`
	// contains filtered or unexported fields
}

The inline source for the input config for ImportUsers method.

func (*UsersInlineSource) Descriptor deprecated 

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

Deprecated: Use UsersInlineSource.ProtoReflect.Descriptor instead.

func (*UsersInlineSource) GetUsers 

func (x *UsersInlineSource) GetUsers() []*User

func (*UsersInlineSource) ProtoMessage 

func (*UsersInlineSource) ProtoMessage()

func (*UsersInlineSource) ProtoReflect 

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

func (*UsersInlineSource) Reset 

func (x *UsersInlineSource) Reset()

func (*UsersInlineSource) String 

func (x *UsersInlineSource) String() string

type UsersInputConfig 

type UsersInputConfig struct {

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

The input config for the source data.

func (*UsersInputConfig) Descriptor deprecated 

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

Deprecated: Use UsersInputConfig.ProtoReflect.Descriptor instead.

func (*UsersInputConfig) GetSource 

func (m *UsersInputConfig) GetSource() isUsersInputConfig_Source

func (*UsersInputConfig) GetUsersInlineSource 

func (x *UsersInputConfig) GetUsersInlineSource() *UsersInlineSource

func (*UsersInputConfig) ProtoMessage 

func (*UsersInputConfig) ProtoMessage()

func (*UsersInputConfig) ProtoReflect 

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

func (*UsersInputConfig) Reset 

func (x *UsersInputConfig) Reset()

func (*UsersInputConfig) String 

func (x *UsersInputConfig) String() string

type UsersInputConfig_UsersInlineSource 

type UsersInputConfig_UsersInlineSource struct {
	// The Inline source for the input content for users.
	UsersInlineSource *UsersInlineSource `protobuf:"bytes,1,opt,name=users_inline_source,json=usersInlineSource,proto3,oneof"`
}

type WriteProductsRequest 

type WriteProductsRequest struct {

	// Required.
	// A list of product to write. The max is 2000 items.
	Products []*Product `protobuf:"bytes,1,rep,name=products,proto3" json:"products,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request proto for WriteProduct method.

func (*WriteProductsRequest) Descriptor deprecated 

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

Deprecated: Use WriteProductsRequest.ProtoReflect.Descriptor instead.

func (*WriteProductsRequest) GetExtra 

func (x *WriteProductsRequest) GetExtra() map[string]string

func (*WriteProductsRequest) GetProducts 

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

func (*WriteProductsRequest) ProtoMessage 

func (*WriteProductsRequest) ProtoMessage()

func (*WriteProductsRequest) ProtoReflect 

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

func (*WriteProductsRequest) Reset 

func (x *WriteProductsRequest) Reset()

func (*WriteProductsRequest) String 

func (x *WriteProductsRequest) String() string

type WriteProductsResponse 

type WriteProductsResponse struct {

	// Output only.
	// When `status.code` is 0, all payload are successfully written.
	// If `status.code` is 1001, `errors` is populated.
	// Other non-zero values indicate all payload failed.
	Status *protocol.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Output only.
	// This field is populated when `status.code` is 1001.
	// When populated, this field contains the errors.
	Errors []*ProductError `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

The response for the WriteProduct call.

func (*WriteProductsResponse) Descriptor deprecated 

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

Deprecated: Use WriteProductsResponse.ProtoReflect.Descriptor instead.

func (*WriteProductsResponse) GetErrors 

func (x *WriteProductsResponse) GetErrors() []*ProductError

func (*WriteProductsResponse) GetStatus 

func (x *WriteProductsResponse) GetStatus() *protocol.Status

func (*WriteProductsResponse) ProtoMessage 

func (*WriteProductsResponse) ProtoMessage()

func (*WriteProductsResponse) ProtoReflect 

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

func (*WriteProductsResponse) Reset 

func (x *WriteProductsResponse) Reset()

func (*WriteProductsResponse) String 

func (x *WriteProductsResponse) String() string

type WriteUserEventsRequest 

type WriteUserEventsRequest struct {

	// Required. A list of user events to write.
	// The max # of events allowed is 2000.
	UserEvents []*UserEvent `protobuf:"bytes,1,rep,name=user_events,json=userEvents,proto3" json:"user_events,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request proto for WriteUserEvent method.

func (*WriteUserEventsRequest) Descriptor deprecated 

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

Deprecated: Use WriteUserEventsRequest.ProtoReflect.Descriptor instead.

func (*WriteUserEventsRequest) GetExtra 

func (x *WriteUserEventsRequest) GetExtra() map[string]string

func (*WriteUserEventsRequest) GetUserEvents 

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

func (*WriteUserEventsRequest) ProtoMessage 

func (*WriteUserEventsRequest) ProtoMessage()

func (*WriteUserEventsRequest) ProtoReflect 

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

func (*WriteUserEventsRequest) Reset 

func (x *WriteUserEventsRequest) Reset()

func (*WriteUserEventsRequest) String 

func (x *WriteUserEventsRequest) String() string

type WriteUserEventsResponse 

type WriteUserEventsResponse struct {

	// Output only.
	// When `status.code` is 0, all payload are successfully written.
	// If `status.code` is 1001, `errors` is populated.
	// Other non-zero values indicate all payload failed.
	Status *protocol.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Output only.
	// This field is populated when `status.code` is 1001.
	// When populated, this field contains the errors.
	Errors []*UserEventError `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

The response proto for WriteUserEvents.

func (*WriteUserEventsResponse) Descriptor deprecated 

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

Deprecated: Use WriteUserEventsResponse.ProtoReflect.Descriptor instead.

func (*WriteUserEventsResponse) GetErrors 

func (x *WriteUserEventsResponse) GetErrors() []*UserEventError

func (*WriteUserEventsResponse) GetStatus 

func (x *WriteUserEventsResponse) GetStatus() *protocol.Status

func (*WriteUserEventsResponse) ProtoMessage 

func (*WriteUserEventsResponse) ProtoMessage()

func (*WriteUserEventsResponse) ProtoReflect 

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

func (*WriteUserEventsResponse) Reset 

func (x *WriteUserEventsResponse) Reset()

func (*WriteUserEventsResponse) String 

func (x *WriteUserEventsResponse) String() string

type WriteUsersRequest 

type WriteUsersRequest struct {

	// Required.
	// A list of users to write.
	// The max # of users allowed is 2000, otherwise a standard 400 error is
	// returned.
	Users []*User `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"`
	// Optional.
	// This is a catch-all field to pass all the additional information.
	// Please provide as much information as possible.
	Extra map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request proto for WriteUsers method.

func (*WriteUsersRequest) Descriptor deprecated 

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

Deprecated: Use WriteUsersRequest.ProtoReflect.Descriptor instead.

func (*WriteUsersRequest) GetExtra 

func (x *WriteUsersRequest) GetExtra() map[string]string

func (*WriteUsersRequest) GetUsers 

func (x *WriteUsersRequest) GetUsers() []*User

func (*WriteUsersRequest) ProtoMessage 

func (*WriteUsersRequest) ProtoMessage()

func (*WriteUsersRequest) ProtoReflect 

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

func (*WriteUsersRequest) Reset 

func (x *WriteUsersRequest) Reset()

func (*WriteUsersRequest) String 

func (x *WriteUsersRequest) String() string

type WriteUsersResponse 

type WriteUsersResponse struct {

	// Output only.
	// When `status.code` is 0, all payload are successfully written.
	// If `status.code` is 1001, `errors` is populated.
	// Other non-zero values indicate all payload failed.
	Status *protocol.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Output only.
	// This field is populated when `status.code` is 1001.
	// When populated, this field contains the errors.
	Errors []*UserError `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

The response proto for WriteUsers call.

func (*WriteUsersResponse) Descriptor deprecated 

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

Deprecated: Use WriteUsersResponse.ProtoReflect.Descriptor instead.

func (*WriteUsersResponse) GetErrors 

func (x *WriteUsersResponse) GetErrors() []*UserError

func (*WriteUsersResponse) GetStatus 

func (x *WriteUsersResponse) GetStatus() *protocol.Status

func (*WriteUsersResponse) ProtoMessage 

func (*WriteUsersResponse) ProtoMessage()

func (*WriteUsersResponse) ProtoReflect 

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

func (*WriteUsersResponse) Reset 

func (x *WriteUsersResponse) Reset()

func (*WriteUsersResponse) String 

func (x *WriteUsersResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.