Struct UserEvent 

#[non_exhaustive]
pub struct UserEvent {

    pub event_type: String,
    pub conversion_type: String,
    pub user_pseudo_id: String,
    pub engine: String,
    pub data_store: String,
    pub event_time: Option<Timestamp>,
    pub user_info: Option<UserInfo>,
    pub direct_user_request: bool,
    pub session_id: String,
    pub page_info: Option<PageInfo>,
    pub attribution_token: String,
    pub filter: String,
    pub documents: Vec<DocumentInfo>,
    pub panel: Option<PanelInfo>,
    pub search_info: Option<SearchInfo>,
    pub completion_info: Option<CompletionInfo>,
    pub transaction_info: Option<TransactionInfo>,
    pub tag_ids: Vec<String>,
    pub promotion_ids: Vec<String>,
    pub attributes: HashMap<String, CustomAttribute>,
    pub media_info: Option<MediaInfo>,
    pub panels: Vec<PanelInfo>,
    /* private fields */
}

Available on crate features recommendation-service or user-event-service only.

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

event_type: String

Required. User event type. Allowed values are:

Generic values:

• search: Search for Documents.
• view-item: Detailed page view of a Document.
• view-item-list: View of a panel or ordered list of Documents.
• view-home-page: View of the home page.
• view-category-page: View of a category page, e.g. Home > Men > Jeans
• add-feedback: Add a user feedback.

Retail-related values:

• add-to-cart: Add an item(s) to cart, e.g. in Retail online shopping
• purchase: Purchase an item(s)

Media-related values:

• media-play: Start/resume watching a video, playing a song, etc.
• media-complete: Finished or stopped midway through a video, song, etc.

Custom conversion value:

• conversion: Customer defined conversion event.

conversion_type: String

Optional. Conversion type.

Required if UserEvent.event_type is conversion. This is a customer-defined conversion name in lowercase letters or numbers separated by “-”, such as “watch”, “good-visit” etc.

Do not set the field if UserEvent.event_type is not conversion. This mixes the custom conversion event with predefined events like search, view-item etc.

user_pseudo_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.

Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality.

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

The field should not contain PII or user-data. We recommend to use Google Analytics Client ID for this field.

engine: String

The Engine resource name, in the form of projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Optional. Only required for Engine produced user events. For example, user events from blended search.

data_store: String

The DataStore resource full name, of the form projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Optional. Only required for user events whose data store can’t by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.

event_time: Option<Timestamp>

Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.

user_info: Option<UserInfo>

Information about the end user.

direct_user_request: bool

Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request.

This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).

This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.

session_id: String

A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span.

A general guideline to populate the session_id:

1. If user has no activity for 30 min, a new session_id should be assigned.
2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.

page_info: Option<PageInfo>

Page metadata such as categories and other critical information for certain event types such as view-category-page.

attribution_token: String

Token to attribute an API response to user action(s) to trigger the event.

Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance.

The value must be one of:

• RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend.
• SearchResponse.attribution_token for events that are the result of SearchService.Search.

This token enables us to accurately attribute page view or conversion completion 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 RecommendResponse.attribution_token as a URL parameter to product K’s page. When recording events on product K’s page, log the RecommendResponse.attribution_token to this field.

filter: String

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.

One example is for search events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering.

Similarly, for view-item-list events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering.

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

documents: Vec<DocumentInfo>

List of Documents associated with this user event.

This field is optional except for the following event types:

• view-item
• add-to-cart
• purchase
• media-play
• media-complete

In a search event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing 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 UserEvent.documents is desired.

panel: Option<PanelInfo>

Panel metadata associated with this user event.

search_info: Option<SearchInfo>

SearchService.Search details related to the event.

This field should be set for search event.

completion_info: Option<CompletionInfo>

CompletionService.CompleteQuery details related to the event.

This field should be set for search event when autocomplete function is enabled and the user clicks a suggestion for search.

transaction_info: Option<TransactionInfo>

The transaction metadata (if any) associated with this user event.

tag_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.

promotion_ids: Vec<String>

The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.

attributes: HashMap<String, CustomAttribute>

Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings.

If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
• For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.
• For number attributes, at most 400 values are allowed.

For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

media_info: Option<MediaInfo>

Media-specific info.

panels: Vec<PanelInfo>

Optional. List of panels associated with this event. Used for page-level impression data.

Implementations

impl UserEvent

pub fn new() -> Self

pub fn set_event_type<T: Into<String>>(self, v: T) -> Self

Sets the value of event_type.

Example

let x = UserEvent::new().set_event_type("example");

pub fn set_conversion_type<T: Into<String>>(self, v: T) -> Self

Sets the value of conversion_type.

Example

let x = UserEvent::new().set_conversion_type("example");

pub fn set_user_pseudo_id<T: Into<String>>(self, v: T) -> Self

Sets the value of user_pseudo_id.

Example

let x = UserEvent::new().set_user_pseudo_id("example");

pub fn set_engine<T: Into<String>>(self, v: T) -> Self

Sets the value of engine.

Example

let x = UserEvent::new().set_engine("example");

pub fn set_data_store<T: Into<String>>(self, v: T) -> Self

Sets the value of data_store.

Example

let x = UserEvent::new().set_data_store("example");

pub fn set_event_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of event_time.

Example

use wkt::Timestamp;
let x = UserEvent::new().set_event_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_event_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of event_time.

Example

use wkt::Timestamp;
let x = UserEvent::new().set_or_clear_event_time(Some(Timestamp::default()/* use setters */));
let x = UserEvent::new().set_or_clear_event_time(None::<Timestamp>);

pub fn set_user_info<T>(self, v: T) -> Self

where T: Into<UserInfo>,

Sets the value of user_info.

Example

use google_cloud_discoveryengine_v1::model::UserInfo;
let x = UserEvent::new().set_user_info(UserInfo::default()/* use setters */);

pub fn set_or_clear_user_info<T>(self, v: Option<T>) -> Self

where T: Into<UserInfo>,

Sets or clears the value of user_info.

Example

use google_cloud_discoveryengine_v1::model::UserInfo;
let x = UserEvent::new().set_or_clear_user_info(Some(UserInfo::default()/* use setters */));
let x = UserEvent::new().set_or_clear_user_info(None::<UserInfo>);

pub fn set_direct_user_request<T: Into<bool>>(self, v: T) -> Self

Sets the value of direct_user_request.

Example

let x = UserEvent::new().set_direct_user_request(true);

pub fn set_session_id<T: Into<String>>(self, v: T) -> Self

Sets the value of session_id.

Example

let x = UserEvent::new().set_session_id("example");

pub fn set_page_info<T>(self, v: T) -> Self

where T: Into<PageInfo>,

Sets the value of page_info.

Example

use google_cloud_discoveryengine_v1::model::PageInfo;
let x = UserEvent::new().set_page_info(PageInfo::default()/* use setters */);

pub fn set_or_clear_page_info<T>(self, v: Option<T>) -> Self

where T: Into<PageInfo>,

Sets or clears the value of page_info.

Example

use google_cloud_discoveryengine_v1::model::PageInfo;
let x = UserEvent::new().set_or_clear_page_info(Some(PageInfo::default()/* use setters */));
let x = UserEvent::new().set_or_clear_page_info(None::<PageInfo>);

pub fn set_attribution_token<T: Into<String>>(self, v: T) -> Self

Sets the value of attribution_token.

Example

let x = UserEvent::new().set_attribution_token("example");

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = UserEvent::new().set_filter("example");

pub fn set_documents<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<DocumentInfo>,

Sets the value of documents.

Example

use google_cloud_discoveryengine_v1::model::DocumentInfo;
let x = UserEvent::new()
    .set_documents([
        DocumentInfo::default()/* use setters */,
        DocumentInfo::default()/* use (different) setters */,
    ]);

pub fn set_panel<T>(self, v: T) -> Self

where T: Into<PanelInfo>,

Sets the value of panel.

Example

use google_cloud_discoveryengine_v1::model::PanelInfo;
let x = UserEvent::new().set_panel(PanelInfo::default()/* use setters */);

pub fn set_or_clear_panel<T>(self, v: Option<T>) -> Self

where T: Into<PanelInfo>,

Sets or clears the value of panel.

Example

use google_cloud_discoveryengine_v1::model::PanelInfo;
let x = UserEvent::new().set_or_clear_panel(Some(PanelInfo::default()/* use setters */));
let x = UserEvent::new().set_or_clear_panel(None::<PanelInfo>);

pub fn set_search_info<T>(self, v: T) -> Self

where T: Into<SearchInfo>,

Sets the value of search_info.

Example

use google_cloud_discoveryengine_v1::model::SearchInfo;
let x = UserEvent::new().set_search_info(SearchInfo::default()/* use setters */);

pub fn set_or_clear_search_info<T>(self, v: Option<T>) -> Self

where T: Into<SearchInfo>,

Sets or clears the value of search_info.

Example

use google_cloud_discoveryengine_v1::model::SearchInfo;
let x = UserEvent::new().set_or_clear_search_info(Some(SearchInfo::default()/* use setters */));
let x = UserEvent::new().set_or_clear_search_info(None::<SearchInfo>);

pub fn set_completion_info<T>(self, v: T) -> Self

where T: Into<CompletionInfo>,

Sets the value of completion_info.

Example

use google_cloud_discoveryengine_v1::model::CompletionInfo;
let x = UserEvent::new().set_completion_info(CompletionInfo::default()/* use setters */);

pub fn set_or_clear_completion_info<T>(self, v: Option<T>) -> Self

where T: Into<CompletionInfo>,

Sets or clears the value of completion_info.

Example

use google_cloud_discoveryengine_v1::model::CompletionInfo;
let x = UserEvent::new().set_or_clear_completion_info(Some(CompletionInfo::default()/* use setters */));
let x = UserEvent::new().set_or_clear_completion_info(None::<CompletionInfo>);

pub fn set_transaction_info<T>(self, v: T) -> Self

where T: Into<TransactionInfo>,

Sets the value of transaction_info.

Example

use google_cloud_discoveryengine_v1::model::TransactionInfo;
let x = UserEvent::new().set_transaction_info(TransactionInfo::default()/* use setters */);

pub fn set_or_clear_transaction_info<T>(self, v: Option<T>) -> Self

where T: Into<TransactionInfo>,

Sets or clears the value of transaction_info.

Example

use google_cloud_discoveryengine_v1::model::TransactionInfo;
let x = UserEvent::new().set_or_clear_transaction_info(Some(TransactionInfo::default()/* use setters */));
let x = UserEvent::new().set_or_clear_transaction_info(None::<TransactionInfo>);

pub fn set_tag_ids<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of tag_ids.

Example

let x = UserEvent::new().set_tag_ids(["a", "b", "c"]);

pub fn set_promotion_ids<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of promotion_ids.

Example

let x = UserEvent::new().set_promotion_ids(["a", "b", "c"]);

pub fn set_attributes<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<CustomAttribute>,

Sets the value of attributes.

Example

use google_cloud_discoveryengine_v1::model::CustomAttribute;
let x = UserEvent::new().set_attributes([
    ("key0", CustomAttribute::default()/* use setters */),
    ("key1", CustomAttribute::default()/* use (different) setters */),
]);

pub fn set_media_info<T>(self, v: T) -> Self

where T: Into<MediaInfo>,

Sets the value of media_info.

Example

use google_cloud_discoveryengine_v1::model::MediaInfo;
let x = UserEvent::new().set_media_info(MediaInfo::default()/* use setters */);

pub fn set_or_clear_media_info<T>(self, v: Option<T>) -> Self

where T: Into<MediaInfo>,

Sets or clears the value of media_info.

Example

use google_cloud_discoveryengine_v1::model::MediaInfo;
let x = UserEvent::new().set_or_clear_media_info(Some(MediaInfo::default()/* use setters */));
let x = UserEvent::new().set_or_clear_media_info(None::<MediaInfo>);

pub fn set_panels<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<PanelInfo>,

Sets the value of panels.

Example

use google_cloud_discoveryengine_v1::model::PanelInfo;
let x = UserEvent::new()
    .set_panels([
        PanelInfo::default()/* use setters */,
        PanelInfo::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for UserEvent

fn clone(&self) -> UserEvent

Returns a duplicate 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() -> UserEvent

Returns the “default value” for a type.

impl Message for UserEvent

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UserEvent

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for UserEvent