Class: Google::Cloud::RecommendationEngine::V1beta1::UserEvent

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb

Overview

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

Defined Under Namespace

Modules: EventSource

Instance Attribute Summary collapse

Instance Attribute Details

#event_detail ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::EventDetail

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

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 87

class UserEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User event source.
  module EventSource
    # Unspecified event source.
    EVENT_SOURCE_UNSPECIFIED = 0

    # The event is ingested via a javascript pixel or Recommendations AI Tag
    # through automl datalayer or JS Macros.
    AUTOML = 1

    # The event is ingested via Recommendations AI Tag through Enhanced
    # Ecommerce datalayer.
    ECOMMERCE = 2

    # The event is ingested via Import user events API.
    BATCH_UPLOAD = 3
  end
end

#event_source ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::UserEvent::EventSource

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

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 87

class UserEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User event source.
  module EventSource
    # Unspecified event source.
    EVENT_SOURCE_UNSPECIFIED = 0

    # The event is ingested via a javascript pixel or Recommendations AI Tag
    # through automl datalayer or JS Macros.
    AUTOML = 1

    # The event is ingested via Recommendations AI Tag through Enhanced
    # Ecommerce datalayer.
    ECOMMERCE = 2

    # The event is ingested via Import user events API.
    BATCH_UPLOAD = 3
  end
end

#event_time ⇒ ::Google::Protobuf::Timestamp

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

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 87

class UserEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User event source.
  module EventSource
    # Unspecified event source.
    EVENT_SOURCE_UNSPECIFIED = 0

    # The event is ingested via a javascript pixel or Recommendations AI Tag
    # through automl datalayer or JS Macros.
    AUTOML = 1

    # The event is ingested via Recommendations AI Tag through Enhanced
    # Ecommerce datalayer.
    ECOMMERCE = 2

    # The event is ingested via Import user events API.
    BATCH_UPLOAD = 3
  end
end

#event_type ⇒ ::String

Returns 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.

Returns:

  • (::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.


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 87

class UserEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User event source.
  module EventSource
    # Unspecified event source.
    EVENT_SOURCE_UNSPECIFIED = 0

    # The event is ingested via a javascript pixel or Recommendations AI Tag
    # through automl datalayer or JS Macros.
    AUTOML = 1

    # The event is ingested via Recommendations AI Tag through Enhanced
    # Ecommerce datalayer.
    ECOMMERCE = 2

    # The event is ingested via Import user events API.
    BATCH_UPLOAD = 3
  end
end

#product_event_detail ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::ProductEventDetail

Returns 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.

Returns:

  • (::Google::Cloud::RecommendationEngine::V1beta1::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


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 87

class UserEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User event source.
  module EventSource
    # Unspecified event source.
    EVENT_SOURCE_UNSPECIFIED = 0

    # The event is ingested via a javascript pixel or Recommendations AI Tag
    # through automl datalayer or JS Macros.
    AUTOML = 1

    # The event is ingested via Recommendations AI Tag through Enhanced
    # Ecommerce datalayer.
    ECOMMERCE = 2

    # The event is ingested via Import user events API.
    BATCH_UPLOAD = 3
  end
end

#user_info ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::UserInfo

Returns Required. User information.

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 87

class UserEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User event source.
  module EventSource
    # Unspecified event source.
    EVENT_SOURCE_UNSPECIFIED = 0

    # The event is ingested via a javascript pixel or Recommendations AI Tag
    # through automl datalayer or JS Macros.
    AUTOML = 1

    # The event is ingested via Recommendations AI Tag through Enhanced
    # Ecommerce datalayer.
    ECOMMERCE = 2

    # The event is ingested via Import user events API.
    BATCH_UPLOAD = 3
  end
end