Struct gapi_grpc::google::cloud::recommendationengine::v1beta1::EventDetail

pub struct EventDetail {
    pub uri: String,
    pub referrer_uri: String,
    pub page_view_id: String,
    pub experiment_ids: Vec<String>,
    pub recommendation_token: String,
    pub event_attributes: Option<FeatureMap>,
}

User event details shared by all recommendation types.

Fields

uri: String

Optional. Complete url (window.location.href) of the user’s current page. When using the JavaScript pixel, this value is filled in automatically. Maximum length 5KB.

referrer_uri: String

Optional. The referrer url of the current page. When using the JavaScript pixel, this value is filled in automatically.

page_view_id: String

Optional. 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. This pageViewId will be automatically generated if using the JavaScript pixel.

experiment_ids: Vec<String>

Optional. 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 Recommendation Engine system, using different recommendation models).

recommendation_token: String

Optional. Recommendation token included in the recommendation prediction response.

This field enables accurate attribution of recommendation model performance.

This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased item. If user clicks on product K in the recommendation results, pass the PredictResponse.recommendationToken property as a url parameter to product K’s page. When recording events on product K’s page, log the PredictResponse.recommendation_token to this field.

Optional, but highly encouraged for user events that are the result of a recommendation prediction query.

event_attributes: Option<FeatureMap>

Optional. Extra user event features to include in the recommendation model.

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.

Trait Implementations

impl Clone for EventDetail

fn clone(&self) -> EventDetail

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventDetail

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

Formats the value using the given formatter.

impl Default for EventDetail

fn default() -> EventDetail

Returns the “default value” for a type.

impl Message for EventDetail

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<EventDetail> for EventDetail

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

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

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

This method tests for !=.

impl StructuralPartialEq for EventDetail