Struct google_api_proto::google::cloud::recommendationengine::v1beta1::UserEvent

pub struct UserEvent {
    pub event_type: String,
    pub user_info: Option<UserInfo>,
    pub event_detail: Option<EventDetail>,
    pub product_event_detail: Option<ProductEventDetail>,
    pub event_time: Option<Timestamp>,
    pub event_source: i32,
}

UserEvent captures all metadata information recommendation engine 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.
• add-to-list Items being added to a list (shopping list, favorites etc).
• category-page-view Special pages such as sale or promotion pages viewed.
• checkout-start User starting a checkout process.
• detail-page-view Products detail page viewed.
• home-page-view Homepage viewed.
• page-visit Generic page visits not included in the event types above.
• purchase-complete User finishing a purchase.
• refund Purchased items being refunded or returned.
• remove-from-cart Products being removed from cart.
• remove-from-list Items being removed from a list.
• search Product search.
• shopping-cart-page-view User viewing a shopping cart.
• impression List of items displayed. Used by Google Tag Manager.

user_info: Option<UserInfo>

Required. User information.

event_detail: Option<EventDetail>

Optional. User event detailed information common across different recommendation types.

product_event_detail: Option<ProductEventDetail>

Optional. Retail product specific user event metadata.

This field is required for the following event types:

• add-to-cart
• add-to-list
• category-page-view
• checkout-start
• detail-page-view
• purchase-complete
• refund
• remove-from-cart
• remove-from-list
• search

This field is optional for the following event types:

• page-visit
• shopping-cart-page-view - note that ‘product_event_detail’ should be set for this unless the shopping cart is empty.

This field is not allowed for the following event types:

• home-page-view

event_time: Option<Timestamp>

Optional. Only required for ImportUserEvents method. Timestamp of user event created.

event_source: i32

Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to EVENT_SOURCE_UNSPECIFIED.

Implementations

impl UserEvent

pub fn event_source(&self) -> EventSource

Returns the enum value of event_source, or the default if the field is set to an invalid enum value.

pub fn set_event_source(&mut self, value: EventSource)

Sets event_source to the provided enum value.

Trait Implementations

impl Clone for UserEvent

fn clone(&self) -> UserEvent

Returns a copy of the value.

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() -> Self

Returns the “default value” for a type.

impl Message for UserEvent

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.

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

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UserEvent