Class: Google::Cloud::RecommendationEngine::V1beta1::EventDetail

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

User event details shared by all recommendation types.

Instance Attribute Summary collapse

Instance Attribute Details

#event_attributes ⇒ ::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap

Returns Optional. Extra user event features to include in the recommendation model.

For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.

Returns:

  • (::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap) —

    Optional. Extra user event features to include in the recommendation model.

    For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.



200
201
202
203
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 200

class EventDetail
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#experiment_ids ⇒ ::Array<::String>

Returns Optional. A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Recommendation Engine system, using different recommendation models).

Returns:

  • (::Array<::String>) —

    Optional. A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Recommendation Engine system, using different recommendation models).



200
201
202
203
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 200

class EventDetail
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_view_id ⇒ ::String

Returns Optional. A unique id of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The pageViewId property should be kept the same for all these events so that they can be grouped together properly. This pageViewId will be automatically generated if using the JavaScript pixel.

Returns:

  • (::String) —

    Optional. A unique id of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The pageViewId property should be kept the same for all these events so that they can be grouped together properly. This pageViewId will be automatically generated if using the JavaScript pixel.



200
201
202
203
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 200

class EventDetail
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#recommendation_token ⇒ ::String

Returns Optional. Recommendation token included in the recommendation prediction response.

This field enables accurate attribution of recommendation model performance.

This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased item. If user clicks on product K in the recommendation results, pass the PredictResponse.recommendationToken property as a url parameter to product K's page. When recording events on product K's page, log the PredictResponse.recommendation_token to this field.

Optional, but highly encouraged for user events that are the result of a recommendation prediction query.

Returns:

  • (::String) —

    Optional. Recommendation token included in the recommendation prediction response.

    This field enables accurate attribution of recommendation model performance.

    This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased item. If user clicks on product K in the recommendation results, pass the PredictResponse.recommendationToken property as a url parameter to product K's page. When recording events on product K's page, log the PredictResponse.recommendation_token to this field.

    Optional, but highly encouraged for user events that are the result of a recommendation prediction query.



200
201
202
203
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 200

class EventDetail
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#referrer_uri ⇒ ::String

Returns Optional. The referrer url of the current page. When using the JavaScript pixel, this value is filled in automatically.

Returns:

  • (::String) —

    Optional. The referrer url of the current page. When using the JavaScript pixel, this value is filled in automatically.



200
201
202
203
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 200

class EventDetail
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#uri ⇒ ::String

Returns Optional. Complete url (window.location.href) of the user's current page. When using the JavaScript pixel, this value is filled in automatically. Maximum length 5KB.

Returns:

  • (::String) —

    Optional. Complete url (window.location.href) of the user's current page. When using the JavaScript pixel, this value is filled in automatically. Maximum length 5KB.



200
201
202
203
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 200

class EventDetail
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end