- 0.62.0 (latest)
- 0.61.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.4
- 0.8.10
public interface EventDetailOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getEventAttributes()
public abstract FeatureMap getEventAttributes()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.
.google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureMap | The eventAttributes. |
getEventAttributesOrBuilder()
public abstract FeatureMapOrBuilder getEventAttributesOrBuilder()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.
.google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureMapOrBuilder | |
getExperimentIds(int index)
public abstract String getExperimentIds(int index)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).
repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The experimentIds at the given index. |
getExperimentIdsBytes(int index)
public abstract ByteString getExperimentIdsBytes(int index)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).
repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the experimentIds at the given index. |
getExperimentIdsCount()
public abstract int getExperimentIdsCount()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).
repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | The count of experimentIds. |
getExperimentIdsList()
public abstract List<String> getExperimentIdsList()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).
repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the experimentIds. |
getPageViewId()
public abstract String getPageViewId() 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.
string page_view_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The pageViewId. |
getPageViewIdBytes()
public abstract ByteString getPageViewIdBytes() 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.
string page_view_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for pageViewId. |
getRecommendationToken()
public abstract String getRecommendationToken()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.
string recommendation_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The recommendationToken. |
getRecommendationTokenBytes()
public abstract ByteString getRecommendationTokenBytes()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.
string recommendation_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for recommendationToken. |
getReferrerUri()
public abstract String getReferrerUri()Optional. The referrer url of the current page. When using the JavaScript pixel, this value is filled in automatically.
string referrer_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The referrerUri. |
getReferrerUriBytes()
public abstract ByteString getReferrerUriBytes()Optional. The referrer url of the current page. When using the JavaScript pixel, this value is filled in automatically.
string referrer_uri = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for referrerUri. |
getUri()
public abstract String getUri()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.
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The uri. |
getUriBytes()
public abstract ByteString getUriBytes()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.
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for uri. |
hasEventAttributes()
public abstract boolean hasEventAttributes()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.
.google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the eventAttributes field is set. |