Class EventDetail.Builder (0.41.0)

Version 0.41.0

• 0.60.0 (latest)
• 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 static final class EventDetail.Builder extends GeneratedMessageV3.Builder<EventDetail.Builder> implements EventDetailOrBuilder

User event details shared by all recommendation types.

Protobuf type google.cloud.recommendationengine.v1beta1.EventDetail

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EventDetail.Builder

Implements

EventDetailOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllExperimentIds(Iterable<String> values)

public EventDetail.Builder addAllExperimentIds(Iterable<String> values)

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
values	Iterable<String> The experimentIds to add.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

addExperimentIds(String value)

public EventDetail.Builder addExperimentIds(String value)

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
value	String The experimentIds to add.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

addExperimentIdsBytes(ByteString value)

public EventDetail.Builder addExperimentIdsBytes(ByteString value)

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
value	ByteString The bytes of the experimentIds to add.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EventDetail.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
EventDetail.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public EventDetail build()

Returns
Type	Description
EventDetail

buildPartial()

public EventDetail buildPartial()

Returns
Type	Description
EventDetail

clear()

public EventDetail.Builder clear()

Returns
Type	Description
EventDetail.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearEventAttributes()

public EventDetail.Builder clearEventAttributes()

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
EventDetail.Builder

clearExperimentIds()

public EventDetail.Builder clearExperimentIds()

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
EventDetail.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public EventDetail.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
EventDetail.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public EventDetail.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
EventDetail.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPageViewId()

public EventDetail.Builder clearPageViewId()

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
EventDetail.Builder	This builder for chaining.

clearRecommendationToken()

public EventDetail.Builder clearRecommendationToken()

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
EventDetail.Builder	This builder for chaining.

clearReferrerUri()

public EventDetail.Builder clearReferrerUri()

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
EventDetail.Builder	This builder for chaining.

clearUri()

public EventDetail.Builder clearUri()

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
EventDetail.Builder	This builder for chaining.

clone()

public EventDetail.Builder clone()

Returns
Type	Description
EventDetail.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public EventDetail getDefaultInstanceForType()

Returns
Type	Description
EventDetail

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getEventAttributesBuilder()

public FeatureMap.Builder getEventAttributesBuilder()

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

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];

Returns
Type	Description
FeatureMapOrBuilder

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];

Returns
Type	Description
ProtocolStringList	A list containing the experimentIds.

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.

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeEventAttributes(FeatureMap value)

public EventDetail.Builder mergeEventAttributes(FeatureMap value)

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];

Parameter
Name	Description
value	FeatureMap

Returns
Type	Description
EventDetail.Builder

mergeFrom(EventDetail other)

public EventDetail.Builder mergeFrom(EventDetail other)

Parameter
Name	Description
other	EventDetail

Returns
Type	Description
EventDetail.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EventDetail.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EventDetail.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public EventDetail.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
EventDetail.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EventDetail.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
EventDetail.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setEventAttributes(FeatureMap value)

public EventDetail.Builder setEventAttributes(FeatureMap value)

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];

Parameter
Name	Description
value	FeatureMap

Returns
Type	Description
EventDetail.Builder

setEventAttributes(FeatureMap.Builder builderForValue)

public EventDetail.Builder setEventAttributes(FeatureMap.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	FeatureMap.Builder

Returns
Type	Description
EventDetail.Builder

setExperimentIds(int index, String value)

public EventDetail.Builder setExperimentIds(int index, String value)

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];

Parameters
Name	Description
index	int The index to set the value at.
value	String The experimentIds to set.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public EventDetail.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
EventDetail.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setPageViewId(String value)

public EventDetail.Builder setPageViewId(String value)

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];

Parameter
Name	Description
value	String The pageViewId to set.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

setPageViewIdBytes(ByteString value)

public EventDetail.Builder setPageViewIdBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for pageViewId to set.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

setRecommendationToken(String value)

public EventDetail.Builder setRecommendationToken(String value)

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];

Parameter
Name	Description
value	String The recommendationToken to set.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

setRecommendationTokenBytes(ByteString value)

public EventDetail.Builder setRecommendationTokenBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for recommendationToken to set.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

setReferrerUri(String value)

public EventDetail.Builder setReferrerUri(String value)

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];

Parameter
Name	Description
value	String The referrerUri to set.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

setReferrerUriBytes(ByteString value)

public EventDetail.Builder setReferrerUriBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for referrerUri to set.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public EventDetail.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
EventDetail.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final EventDetail.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
EventDetail.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUri(String value)

public EventDetail.Builder setUri(String value)

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];

Parameter
Name	Description
value	String The uri to set.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.

setUriBytes(ByteString value)

public EventDetail.Builder setUriBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for uri to set.

Returns
Type	Description
EventDetail.Builder	This builder for chaining.