public sealed class UserEvent : IMessage<UserEvent>, IEquatable<UserEvent>, IDeepCloneable<UserEvent>, IBufferMessage, IMessage
Reference documentation and code samples for the Recommendations AI v1beta1 API class UserEvent.
UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.
Implements
IMessage<UserEvent>, IEquatable<UserEvent>, IDeepCloneable<UserEvent>, IBufferMessage, IMessageNamespace
Google.Cloud.RecommendationEngine.V1Beta1Assembly
Google.Cloud.RecommendationEngine.V1Beta1.dll
Constructors
UserEvent()
public UserEvent()
UserEvent(UserEvent)
public UserEvent(UserEvent other)
Parameter | |
---|---|
Name | Description |
other | UserEvent |
Properties
EventDetail
public EventDetail EventDetail { get; set; }
Optional. User event detailed information common across different recommendation types.
Property Value | |
---|---|
Type | Description |
EventDetail |
EventSource
public UserEvent.Types.EventSource EventSource { get; set; }
Optional. This field should not be set when using JavaScript pixel
or the Recommendations AI Tag. Defaults to EVENT_SOURCE_UNSPECIFIED
.
Property Value | |
---|---|
Type | Description |
UserEvent.Types.EventSource |
EventTime
public Timestamp EventTime { get; set; }
Optional. Only required for ImportUserEvents method. Timestamp of user event created.
Property Value | |
---|---|
Type | Description |
Timestamp |
EventType
public string EventType { get; set; }
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.
Property Value | |
---|---|
Type | Description |
String |
ProductEventDetail
public ProductEventDetail ProductEventDetail { get; set; }
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
Property Value | |
---|---|
Type | Description |
ProductEventDetail |
UserInfo
public UserInfo UserInfo { get; set; }
Required. User information.
Property Value | |
---|---|
Type | Description |
UserInfo |