Struct gapi_grpc::google::cloud::retail::v2beta::UserEvent

pub struct UserEvent {
    pub event_type: String,
    pub visitor_id: String,
    pub event_time: Option<Timestamp>,
    pub experiment_ids: Vec<String>,
    pub attribution_token: String,
    pub product_details: Vec<ProductDetail>,
    pub attributes: HashMap<String, CustomAttribute>,
    pub cart_id: String,
    pub purchase_transaction: Option<PurchaseTransaction>,
    pub search_query: String,
    pub page_categories: Vec<String>,
    pub user_info: Option<UserInfo>,
    pub uri: String,
    pub referrer_uri: String,
    pub page_view_id: String,
}

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

Fields

event_type: String

Required. User event type. Allowed values are:

• add-to-cart: Products being added to cart.
• category-page-view: Special pages such as sale or promotion pages viewed.
• detail-page-view: Products detail page viewed.
• home-page-view: Homepage viewed.
• purchase-complete: User finishing a purchase.
• search: Product search.
• shopping-cart-page-view: User viewing a shopping cart.

visitor_id: String

Required. A unique identifier for tracking visitors.

For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

event_time: Option<Timestamp>

Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2beta.UserEventService.ImportUserEvents] method. Timestamp of when the user event happened.

experiment_ids: Vec<String>

A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models).

attribution_token: String

Highly recommended for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2beta.PredictionService.Predict]. This field enables accurate attribution of recommendation model performance.

The value must be a valid [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token] for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2beta.PredictionService.Predict].

This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token] as a URL parameter to product K’s page. When recording events on product K’s page, log the [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token] to this field.

product_details: Vec<ProductDetail>

The main product details related to the event.

This field is required for the following event types:

• add-to-cart
• detail-page-view
• purchase-complete

In a search event, this field represents the products returned to the end user on the current page (the end user may have not finished broswing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different [product_details][google.cloud.retail.v2beta.UserEvent.product_details] is desired. The end user may have not finished broswing the whole page yet.

attributes: HashMap<String, CustomAttribute>

Extra user event features to include in the recommendation model.

The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.

cart_id: String

The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase.

This can only be set for add-to-cart, purchase-complete, or shopping-cart-page-view events.

purchase_transaction: Option<PurchaseTransaction>

A transaction represents the entire purchase transaction.

Required for purchase-complete events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

search_query: String

The user’s search query.

The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

page_categories: Vec<String>

The categories associated with a category page.

To represent full path of category, use ‘>’ sign to separate different hierarchies. If ‘>’ is part of the category name, please replace it with other character(s).

Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: “pageCategories” : [“Sales > 2017 Black Friday Deals”].

Required for category-page-view events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

user_info: Option<UserInfo>

User information.

uri: String

Complete URL (window.location.href) of the user’s current page.

When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.

referrer_uri: String

The referrer URL of the current page.

When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.

page_view_id: String

A unique id of a web page view.

This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The pageViewId property should be kept the same for all these events so that they can be grouped together properly.

When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.

Trait Implementations

impl Clone for UserEvent

fn clone(&self) -> UserEvent

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UserEvent

fn default() -> UserEvent

Returns the “default value” for a type.

impl Message for UserEvent

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<UserEvent> for UserEvent

fn eq(&self, other: &UserEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UserEvent) -> bool

This method tests for !=.

impl StructuralPartialEq for UserEvent