class Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserEvent
UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.
Attributes
User event details shared by all recommendation types. Corresponds to the JSON property `eventDetail` @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1EventDetail]
Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to `EVENT_SOURCE_UNSPECIFIED`. Corresponds to the JSON property `eventSource` @return [String]
Optional. Only required for ImportUserEvents method. Timestamp of user event created. Corresponds to the JSON property `eventTime` @return [String]
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. Corresponds to the JSON property `eventType` @return [String]
ProductEventDetail captures user event information specific to retail products. Corresponds to the JSON property `productEventDetail` @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ProductEventDetail]
Information of end users. Corresponds to the JSON property `userInfo` @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserInfo]
Public Class Methods
# File lib/google/apis/recommendationengine_v1beta1/classes.rb, line 1674 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/recommendationengine_v1beta1/classes.rb, line 1679 def update!(**args) @event_detail = args[:event_detail] if args.key?(:event_detail) @event_source = args[:event_source] if args.key?(:event_source) @event_time = args[:event_time] if args.key?(:event_time) @event_type = args[:event_type] if args.key?(:event_type) @product_event_detail = args[:product_event_detail] if args.key?(:product_event_detail) @user_info = args[:user_info] if args.key?(:user_info) end