GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1UserEvent (google_api_recommendation_engine v0.4.5) View Source
UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.
Attributes
-
eventDetail
(type:GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1EventDetail.t
, default:nil
) - Optional. User event detailed information common across different recommendation types. -
eventSource
(type:String.t
, default:nil
) - Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults toEVENT_SOURCE_UNSPECIFIED
. -
eventTime
(type:DateTime.t
, default:nil
) - Optional. Only required for ImportUserEvents method. Timestamp of user event created. -
eventType
(type:String.t
, default:nil
) - 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. -
productEventDetail
(type:GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1ProductEventDetail.t
, default:nil
) - 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
-
userInfo
(type:GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1UserInfo.t
, default:nil
) - Required. User information.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Specs
t() :: %GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1UserEvent{ eventDetail: GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1EventDetail.t() | nil, eventSource: String.t() | nil, eventTime: DateTime.t() | nil, eventType: String.t() | nil, productEventDetail: GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1ProductEventDetail.t() | nil, userInfo: GoogleApi.RecommendationEngine.V1beta1.Model.GoogleCloudRecommendationengineV1beta1UserInfo.t() | nil }
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.