Discovery Engine v1 API - Class UserEvent (1.3.0) 

public sealed class UserEvent : IMessage<UserEvent>, IEquatable<UserEvent>, IDeepCloneable<UserEvent>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class UserEvent.

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

Inheritance

object > UserEvent

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

UserEvent()

public UserEvent()

UserEvent(UserEvent)

public UserEvent(UserEvent other)
Parameter
Name Description
other UserEvent

Properties

Attributes

public MapField<string, CustomAttribute> Attributes { get; }

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.

Property Value
Type Description
MapFieldstringCustomAttribute

AttributionToken

public string AttributionToken { get; set; }

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][google.cloud.discoveryengine.v1.RecommendationService.Recommend]. This field enables accurate attribution of recommendation model performance.

The value must be one of:

  • [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1.RecommendResponse.attribution_token] for events that are the result of [RecommendationService.Recommend][google.cloud.discoveryengine.v1.RecommendationService.Recommend].
  • [SearchResponse.attribution_token][google.cloud.discoveryengine.v1.SearchResponse.attribution_token] for events that are the result of [SearchService.Search][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.RecommendResponse.attribution_token] to this field.

Property Value
Type Description
string

CompletionInfo

public CompletionInfo CompletionInfo { get; set; }

[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.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.

Property Value
Type Description
CompletionInfo

DataStore

public string DataStore { get; set; }

The [DataStore][google.cloud.discoveryengine.v1.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][google.cloud.discoveryengine.v1.UserEvent.engine] or [UserEvent.documents][google.cloud.discoveryengine.v1.UserEvent.documents]. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.

Property Value
Type Description
string

DataStoreAsDataStoreName

public DataStoreName DataStoreAsDataStoreName { get; set; }

DataStoreName-typed view over the DataStore resource name property.

Property Value
Type Description
DataStoreName

DirectUserRequest

public bool DirectUserRequest { get; set; }

Should set to true if the request is made directly from the end user, in which case the [UserEvent.user_info.user_agent][google.cloud.discoveryengine.v1.UserInfo.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][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent].

Property Value
Type Description
bool

Documents

public RepeatedField<DocumentInfo> Documents { get; }

List of [Document][google.cloud.discoveryengine.v1.Document]s 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][google.cloud.discoveryengine.v1.UserEvent.documents] is desired.

Property Value
Type Description
RepeatedFieldDocumentInfo

Engine

public string Engine { get; set; }

The [Engine][google.cloud.discoveryengine.v1.Engine] resource name, in the form of projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Optional. Only required for [Engine][google.cloud.discoveryengine.v1.Engine] produced user events. For example, user events from blended search.

Property Value
Type Description
string

EngineAsEngineName

public EngineName EngineAsEngineName { get; set; }

EngineName-typed view over the Engine resource name property.

Property Value
Type Description
EngineName

EventTime

public Timestamp EventTime { get; set; }

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

Property Value
Type Description
Timestamp

EventType

public string EventType { get; set; }

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

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.
Property Value
Type Description
string

Filter

public string Filter { get; set; }

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][google.cloud.discoveryengine.v1.SearchRequest] may contain a filter expression in [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter] conforming to https://google.aip.dev/160#filtering.

Similarly, for view-item-list events that are generated from a [RecommendRequest][google.cloud.discoveryengine.v1.RecommendRequest], this field may be populated directly from [RecommendRequest.filter][google.cloud.discoveryengine.v1.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.

Property Value
Type Description
string

MediaInfo

public MediaInfo MediaInfo { get; set; }

Media-specific info.

Property Value
Type Description
MediaInfo

PageInfo

public PageInfo PageInfo { get; set; }

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

Property Value
Type Description
PageInfo

Panel

public PanelInfo Panel { get; set; }

Panel metadata associated with this user event.

Property Value
Type Description
PanelInfo

PromotionIds

public RepeatedField<string> PromotionIds { get; }

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

Property Value
Type Description
RepeatedFieldstring

SearchInfo

public SearchInfo SearchInfo { get; set; }

[SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] details related to the event.

This field should be set for search event.

Property Value
Type Description
SearchInfo

SessionId

public string SessionId { get; set; }

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][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id] as prefix.
Property Value
Type Description
string

TagIds

public RepeatedField<string> TagIds { get; }

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.

Property Value
Type Description
RepeatedFieldstring

TransactionInfo

public TransactionInfo TransactionInfo { get; set; }

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

Property Value
Type Description
TransactionInfo

UserInfo

public UserInfo UserInfo { get; set; }

Information about the end user.

Property Value
Type Description
UserInfo

UserPseudoId

public string UserPseudoId { get; set; }

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.

Property Value
Type Description
string