Recommendations AI v1beta1 API - Class UserEvent (2.0.0-beta02)

Stay organized with collections Save and categorize content based on your preferences.
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.

Inheritance

Object > UserEvent

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

UserEvent()

public UserEvent()

UserEvent(UserEvent)

public UserEvent(UserEvent other)
Parameter
NameDescription
otherUserEvent

Properties

EventDetail

public EventDetail EventDetail { get; set; }

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

Property Value
TypeDescription
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
TypeDescription
UserEvent.Types.EventSource

EventTime

public Timestamp EventTime { get; set; }

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

Property Value
TypeDescription
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
TypeDescription
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
TypeDescription
ProductEventDetail

UserInfo

public UserInfo UserInfo { get; set; }

Required. User information.

Property Value
TypeDescription
UserInfo