public final class EventDetail extends GeneratedMessageV3 implements EventDetailOrBuilder
User event details shared by all recommendation types.
Protobuf type google.cloud.recommendationengine.v1beta1.EventDetail
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
EVENT_ATTRIBUTES_FIELD_NUMBER
public static final int EVENT_ATTRIBUTES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXPERIMENT_IDS_FIELD_NUMBER
public static final int EXPERIMENT_IDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_VIEW_ID_FIELD_NUMBER
public static final int PAGE_VIEW_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RECOMMENDATION_TOKEN_FIELD_NUMBER
public static final int RECOMMENDATION_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REFERRER_URI_FIELD_NUMBER
public static final int REFERRER_URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
URI_FIELD_NUMBER
public static final int URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static EventDetail getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static EventDetail.Builder newBuilder()
newBuilder(EventDetail prototype)
public static EventDetail.Builder newBuilder(EventDetail prototype)
public static EventDetail parseDelimitedFrom(InputStream input)
public static EventDetail parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static EventDetail parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EventDetail parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static EventDetail parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EventDetail parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EventDetail parseFrom(CodedInputStream input)
public static EventDetail parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EventDetail parseFrom(InputStream input)
public static EventDetail parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static EventDetail parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EventDetail parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<EventDetail> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public EventDetail getDefaultInstanceForType()
getEventAttributes()
public 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 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];
getExperimentIds(int index)
public 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 | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The experimentIds at the given index.
|
getExperimentIdsBytes(int index)
public 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 | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the experimentIds at the given index.
|
getExperimentIdsCount()
public 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 ProtocolStringList 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];
getPageViewId()
public 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 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.
|
getParserForType()
public Parser<EventDetail> getParserForType()
Overrides
getRecommendationToken()
public 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 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 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 ByteString getReferrerUriBytes()
Optional. The referrer url of the curr
