Class UserEvent (0.6.1)

UserEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

Name	Description
event_type	`str` 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.
user_info	`google.cloud.recommendationengine_v1beta1.types.UserInfo` Required. User information.
event_detail	`google.cloud.recommendationengine_v1beta1.types.EventDetail` Optional. User event detailed information common across different recommendation types.
product_event_detail	`google.cloud.recommendationengine_v1beta1.types.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``
event_time	`google.protobuf.timestamp_pb2.Timestamp` Optional. Only required for ImportUserEvents method. Timestamp of user event created.
event_source	`google.cloud.recommendationengine_v1beta1.types.UserEvent.EventSource` Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to ``EVENT_SOURCE_UNSPECIFIED``.

Inheritance

builtins.object > proto.message.Message > UserEvent

Classes

EventSource

EventSource(value)

User event source.