protocol

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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":"Men's shoes"}] },
	//   {"category_depth":2,
	//    "category_nodes": [{"id_or_name":"Sports"},
	//                       {"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
}

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
}

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
}

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
}

type Product_Category_CategoryNode struct {

	// Required.
	// The unique identifier of the category.
	// Please refer to
	// [this](../docs/effective-and-efficient-data-synchronization#requirements-for-free-format-string-fields) for more details.
	/// 该字段是取值无关的 link guide 2.5.2 取值无关
	IdOrName string `protobuf:"bytes,1,opt,name=id_or_name,json=idOrName,proto3" json:"id_or_name,omitempty"`
	// contains filtered or unexported fields
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}