Class GoogleCloudRecommendationengineV1beta1UserEvent

UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.

Inheritance
object
GoogleCloudRecommendationengineV1beta1UserEvent
Implements
Inherited Members
Namespace: Google.Apis.RecommendationsAI.v1beta1.Data
Assembly: Google.Apis.RecommendationsAI.v1beta1.dll
Syntax
public class GoogleCloudRecommendationengineV1beta1UserEvent : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EventDetail

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

Declaration
[JsonProperty("eventDetail")]
public virtual GoogleCloudRecommendationengineV1beta1EventDetail EventDetail { get; set; }
Property Value
Type Description
GoogleCloudRecommendationengineV1beta1EventDetail

EventSource

Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to EVENT_SOURCE_UNSPECIFIED.

Declaration
[JsonProperty("eventSource")]
public virtual string EventSource { get; set; }
Property Value
Type Description
string

EventTime

object representation of EventTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EventTimeDateTimeOffset instead.")]
public virtual object EventTime { get; set; }
Property Value
Type Description
object

EventTimeDateTimeOffset

DateTimeOffset representation of EventTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EventTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EventTimeRaw

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

Declaration
[JsonProperty("eventTime")]
public virtual string EventTimeRaw { get; set; }
Property Value
Type Description
string

EventType

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.

Declaration
[JsonProperty("eventType")]
public virtual string EventType { get; set; }
Property Value
Type Description
string

ProductEventDetail

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
Declaration
[JsonProperty("productEventDetail")]
public virtual GoogleCloudRecommendationengineV1beta1ProductEventDetail ProductEventDetail { get; set; }
Property Value
Type Description
GoogleCloudRecommendationengineV1beta1ProductEventDetail

UserInfo

Required. User information.

Declaration
[JsonProperty("userInfo")]
public virtual GoogleCloudRecommendationengineV1beta1UserInfo UserInfo { get; set; }
Property Value
Type Description
GoogleCloudRecommendationengineV1beta1UserInfo

Implements