Recommendations AI V1beta1 API - Class Google::Cloud::RecommendationEngine::V1beta1::EventDetail (v0.13.0)

Reference documentation and code samples for the Recommendations AI V1beta1 API class Google::Cloud::RecommendationEngine::V1beta1::EventDetail.

User event details shared by all recommendation types.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#event_attributes

def event_attributes() -> ::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap
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.

#event_attributes=

def event_attributes=(value) -> ::Google::Cloud::RecommendationEngine::V1beta1::FeatureMap
Parameter
  • value (::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.

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.

#experiment_ids

def experiment_ids() -> ::Array<::String>
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).

#experiment_ids=

def experiment_ids=(value) -> ::Array<::String>
Parameter
  • value (::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).
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).

#page_view_id

def page_view_id() -> ::String
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.

#page_view_id=

def page_view_id=(value) -> ::String
Parameter
  • value (::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.
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.

#recommendation_token

def recommendation_token() -> ::String
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.

#recommendation_token=

def recommendation_token=(value) -> ::String
Parameter
  • value (::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.

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.

#referrer_uri

def referrer_uri() -> ::String
Returns
  • (::String) — Optional. The referrer url of the current page. When using the JavaScript pixel, this value is filled in automatically.

#referrer_uri=

def referrer_uri=(value) -> ::String
Parameter
  • value (::String) — 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.

#uri

def uri() -> ::String
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.

#uri=

def uri=(value) -> ::String
Parameter
  • value (::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.
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.