Show / Hide Table of Contents

Class GoogleCloudRecommendationengineV1beta1EventDetail

User event details shared by all recommendation types.

Inheritance
object
GoogleCloudRecommendationengineV1beta1EventDetail
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.RecommendationsAI.v1beta1.Data
Assembly: Google.Apis.RecommendationsAI.v1beta1.dll
Syntax
public class GoogleCloudRecommendationengineV1beta1EventDetail : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EventAttributes

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.

Declaration
[JsonProperty("eventAttributes")]
public virtual GoogleCloudRecommendationengineV1beta1FeatureMap EventAttributes { get; set; }
Property Value
Type Description
GoogleCloudRecommendationengineV1beta1FeatureMap

ExperimentIds

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

Declaration
[JsonProperty("experimentIds")]
public virtual IList<string> ExperimentIds { get; set; }
Property Value
Type Description
IList<string>

PageViewId

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.

Declaration
[JsonProperty("pageViewId")]
public virtual string PageViewId { get; set; }
Property Value
Type Description
string

RecommendationToken

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.

Declaration
[JsonProperty("recommendationToken")]
public virtual string RecommendationToken { get; set; }
Property Value
Type Description
string

ReferrerUri

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

Declaration
[JsonProperty("referrerUri")]
public virtual string ReferrerUri { get; set; }
Property Value
Type Description
string

Uri

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.

Declaration
[JsonProperty("uri")]
public virtual string Uri { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX