Class UserEvent (0.37.0)

Version latest

• 0.37.0 (latest)
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.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.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class UserEvent extends GeneratedMessageV3 implements UserEventOrBuilder

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.

Protobuf type google.cloud.discoveryengine.v1.UserEvent

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > UserEvent

Implements

UserEventOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER

Field Value
Type	Description
int

ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER

Field Value
Type	Description
int

COMPLETION_INFO_FIELD_NUMBER

public static final int COMPLETION_INFO_FIELD_NUMBER

Field Value
Type	Description
int

DIRECT_USER_REQUEST_FIELD_NUMBER

public static final int DIRECT_USER_REQUEST_FIELD_NUMBER

Field Value
Type	Description
int

DOCUMENTS_FIELD_NUMBER

public static final int DOCUMENTS_FIELD_NUMBER

Field Value
Type	Description
int

EVENT_TIME_FIELD_NUMBER

public static final int EVENT_TIME_FIELD_NUMBER

Field Value
Type	Description
int

EVENT_TYPE_FIELD_NUMBER

public static final int EVENT_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

Field Value
Type	Description
int

MEDIA_INFO_FIELD_NUMBER

public static final int MEDIA_INFO_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_INFO_FIELD_NUMBER

public static final int PAGE_INFO_FIELD_NUMBER

Field Value
Type	Description
int

PANEL_FIELD_NUMBER

public static final int PANEL_FIELD_NUMBER

Field Value
Type	Description
int

PROMOTION_IDS_FIELD_NUMBER

public static final int PROMOTION_IDS_FIELD_NUMBER

Field Value
Type	Description
int

SEARCH_INFO_FIELD_NUMBER

public static final int SEARCH_INFO_FIELD_NUMBER

Field Value
Type	Description
int

SESSION_ID_FIELD_NUMBER

public static final int SESSION_ID_FIELD_NUMBER

Field Value
Type	Description
int

TAG_IDS_FIELD_NUMBER

public static final int TAG_IDS_FIELD_NUMBER

Field Value
Type	Description
int

TRANSACTION_INFO_FIELD_NUMBER

public static final int TRANSACTION_INFO_FIELD_NUMBER

Field Value
Type	Description
int

USER_INFO_FIELD_NUMBER

public static final int USER_INFO_FIELD_NUMBER

Field Value
Type	Description
int

USER_PSEUDO_ID_FIELD_NUMBER

public static final int USER_PSEUDO_ID_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static UserEvent getDefaultInstance()

Returns
Type	Description
UserEvent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static UserEvent.Builder newBuilder()

Returns
Type	Description
UserEvent.Builder

newBuilder(UserEvent prototype)

public static UserEvent.Builder newBuilder(UserEvent prototype)

Parameter
Name	Description
prototype	UserEvent

Returns
Type	Description
UserEvent.Builder

parseDelimitedFrom(InputStream input)

public static UserEvent parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
UserEvent

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserEvent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserEvent

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static UserEvent parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
UserEvent

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UserEvent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserEvent

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UserEvent parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
UserEvent

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UserEvent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserEvent

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UserEvent parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
UserEvent

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UserEvent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserEvent

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static UserEvent parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
UserEvent

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserEvent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserEvent

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static UserEvent parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
UserEvent

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UserEvent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserEvent

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<UserEvent> parser()

Returns
Type	Description
Parser<UserEvent>

Methods

containsAttributes(String key)

public boolean containsAttributes(String key)

Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings.

If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
• For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.

• For number attributes, at most 400 values are allowed.

  For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

map<string, .google.cloud.discoveryengine.v1.CustomAttribute> attributes = 17;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAttributes() (deprecated)

public Map<String,CustomAttribute> getAttributes()

Use #getAttributesMap() instead.

Returns
Type	Description
Map<String,CustomAttribute>

getAttributesCount()

public int getAttributesCount()

Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings.

If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
• For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.

• For number attributes, at most 400 values are allowed.

  For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

map<string, .google.cloud.discoveryengine.v1.CustomAttribute> attributes = 17;

Returns
Type	Description
int

getAttributesMap()

public Map<String,CustomAttribute> getAttributesMap()

Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings.

If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
• For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.

• For number attributes, at most 400 values are allowed.

  For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

map<string, .google.cloud.discoveryengine.v1.CustomAttribute> attributes = 17;

Returns
Type	Description
Map<String,CustomAttribute>

getAttributesOrDefault(String key, CustomAttribute defaultValue)

public CustomAttribute getAttributesOrDefault(String key, CustomAttribute defaultValue)

Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings.

If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
• For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.

• For number attributes, at most 400 values are allowed.

  For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

map<string, .google.cloud.discoveryengine.v1.CustomAttribute> attributes = 17;

Parameters
Name	Description
key	String
defaultValue	CustomAttribute

Returns
Type	Description
CustomAttribute

getAttributesOrThrow(String key)

public CustomAttribute getAttributesOrThrow(String key)

Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings.

If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality.

This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

• The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
• For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.

• For number attributes, at most 400 values are allowed.

  For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

map<string, .google.cloud.discoveryengine.v1.CustomAttribute> attributes = 17;

Parameter
Name	Description
key	String

Returns
Type	Description
CustomAttribute

getAttributionToken()

public String getAttributionToken()

Token to attribute an API response to user action(s) to trigger the event.

Highly recommended for user events that are the result of [RecommendationService.Recommend][]. This field enables accurate attribution of recommendation model performance.

The value must be one of:

• [RecommendResponse.attribution_token][] for events that are the result of [RecommendationService.Recommend][].

• SearchResponse.attribution_token for events that are the result of SearchService.Search.

  This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass [RecommendResponse.attribution_token][] as a URL parameter to product K's page. When recording events on product K's page, log the [RecommendResponse.attribution_token][] to this field.

string attribution_token = 8;

Returns
Type	Description
String	The attributionToken.

getAttributionTokenBytes()

public ByteString getAttributionTokenBytes()

Token to attribute an API response to user action(s) to trigger the event.

Highly recommended for user events that are the result of [RecommendationService.Recommend][]. This field enables accurate attribution of recommendation model performance.

The value must be one of:

• [RecommendResponse.attribution_token][] for events that are the result of [RecommendationService.Recommend][].

• SearchResponse.attribution_token for events that are the result of SearchService.Search.

  This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass [RecommendResponse.attribution_token][] as a URL parameter to product K's page. When recording events on product K's page, log the [RecommendResponse.attribution_token][] to this field.

string attribution_token = 8;

Returns
Type	Description
ByteString	The bytes for attributionToken.

getCompletionInfo()

public CompletionInfo getCompletionInfo()

CompletionService.CompleteQuery details related to the event.

This field should be set for search event when autocomplete function is enabled and the user clicks a suggestion for search.

.google.cloud.discoveryengine.v1.CompletionInfo completion_info = 13;

Returns
Type	Description
CompletionInfo	The completionInfo.

getCompletionInfoOrBuilder()

public CompletionInfoOrBuilder getCompletionInfoOrBuilder()

CompletionService.CompleteQuery details related to the event.

This field should be set for search event when autocomplete function is enabled and the user clicks a suggestion for search.

.google.cloud.discoveryengine.v1.CompletionInfo completion_info = 13;

Returns
Type	Description
CompletionInfoOrBuilder

getDefaultInstanceForType()

public UserEvent getDefaultInstanceForType()

Returns
Type	Description
UserEvent

getDirectUserRequest()

public boolean getDirectUserRequest()

Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request.

This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).

This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.

bool direct_user_request = 5;

Returns
Type	Description
boolean	The directUserRequest.

getDocuments(int index)

public DocumentInfo getDocuments(int index)

List of Documents associated with this user event.

This field is optional except for the following event types:

• view-item
• add-to-cart
• purchase
• media-play

• media-complete

  In a search event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different UserEvent.documents is desired.

repeated .google.cloud.discoveryengine.v1.DocumentInfo documents = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
DocumentInfo

getDocumentsCount()

public int getDocumentsCount()

List of Documents associated with this user event.

This field is optional except for the following event types:

• view-item
• add-to-cart
• purchase
• media-play

• media-complete

  In a search event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different UserEvent.documents is desired.

repeated .google.cloud.discoveryengine.v1.DocumentInfo documents = 10;

Returns
Type	Description
int

getDocumentsList()

public List<DocumentInfo> getDocumentsList()

List of Documents associated with this user event.

This field is optional except for the following event types:

• view-item
• add-to-cart
• purchase
• media-play

• media-complete

  In a search event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different UserEvent.documents is desired.

repeated .google.cloud.discoveryengine.v1.DocumentInfo documents = 10;

Returns
Type	Description
List<DocumentInfo>

getDocumentsOrBuilder(int index)

public DocumentInfoOrBuilder getDocumentsOrBuilder(int index)

List of Documents associated with this user event.

This field is optional except for the following event types:

• view-item
• add-to-cart
• purchase
• media-play

• media-complete

  In a search event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different UserEvent.documents is desired.

repeated .google.cloud.discoveryengine.v1.DocumentInfo documents = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
DocumentInfoOrBuilder

getDocumentsOrBuilderList()

public List<? extends DocumentInfoOrBuilder> getDocumentsOrBuilderList()

List of Documents associated with this user event.

This field is optional except for the following event types:

• view-item
• add-to-cart
• purchase
• media-play

• media-complete

  In a search event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different UserEvent.documents is desired.

repeated .google.cloud.discoveryengine.v1.DocumentInfo documents = 10;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.DocumentInfoOrBuilder>

getEventTime()

public Timestamp getEventTime()

Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Returns
Type	Description
Timestamp	The eventTime.

getEventTimeOrBuilder()

public TimestampOrBuilder getEventTimeOrBuilder()

Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Returns
Type	Description
TimestampOrBuilder

getEventType()

public String getEventType()

Required. User event type. Allowed values are:

Generic values:

• search: Search for Documents.
• view-item: Detailed page view of a Document.
• view-item-list: View of a panel or ordered list of Documents.
• view-home-page: View of the home page.

• view-category-page: View of a category page, e.g. Home > Men > Jeans

  Retail-related values:

• add-to-cart: Add an item(s) to cart, e.g. in Retail online shopping

• purchase: Purchase an item(s)

  Media-related values:

• media-play: Start/resume watching a video, playing a song, etc.

• media-complete: Finished or stopped midway through a video, song, etc.

string event_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The eventType.

getEventTypeBytes()

public ByteString getEventTypeBytes()

Required. User event type. Allowed values are:

Generic values:

• search: Search for Documents.
• view-item: Detailed page view of a Document.
• view-item-list: View of a panel or ordered list of Documents.
• view-home-page: View of the home page.

• view-category-page: View of a category page, e.g. Home > Men > Jeans

  Retail-related values:

• add-to-cart: Add an item(s) to cart, e.g. in Retail online shopping

• purchase: Purchase an item(s)

  Media-related values:

• media-play: Start/resume watching a video, playing a song, etc.

• media-complete: Finished or stopped midway through a video, song, etc.

string event_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for eventType.

getFilter()

public String getFilter()

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.

One example is for search events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering.

Similarly, for view-item-list events that are generated from a [RecommendRequest][], this field may be populated directly from [RecommendRequest.filter][] conforming to https://google.aip.dev/160#filtering.

The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string filter = 9;

Returns
Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.

One example is for search events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering.

Similarly, for view-item-list events that are generated from a [RecommendRequest][], this field may be populated directly from [RecommendRequest.filter][] conforming to https://google.aip.dev/160#filtering.

The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string filter = 9;

Returns
Type	Description
ByteString	The bytes for filter.

getMediaInfo()

public MediaInfo getMediaInfo()

Media-specific info.

.google.cloud.discoveryengine.v1.MediaInfo media_info = 18;

Returns
Type	Description
MediaInfo	The mediaInfo.

getMediaInfoOrBuilder()

public MediaInfoOrBuilder getMediaInfoOrBuilder()

Media-specific info.

.google.cloud.discoveryengine.v1.MediaInfo media_info = 18;

Returns
Type	Description
MediaInfoOrBuilder

getPageInfo()

public PageInfo getPageInfo()

Page metadata such as categories and other critical information for certain event types such as view-category-page.

.google.cloud.discoveryengine.v1.PageInfo page_info = 7;

Returns
Type	Description
PageInfo	The pageInfo.

getPageInfoOrBuilder()

public PageInfoOrBuilder getPageInfoOrBuilder()

Page metadata such as categories and other critical information for certain event types such as view-category-page.

.google.cloud.discoveryengine.v1.PageInfo page_info = 7;

Returns
Type	Description
PageInfoOrBuilder

getPanel()

public PanelInfo getPanel()

Panel metadata associated with this user event.

.google.cloud.discoveryengine.v1.PanelInfo panel = 11;

Returns
Type	Description
PanelInfo	The panel.

getPanelOrBuilder()

public PanelInfoOrBuilder getPanelOrBuilder()

Panel metadata associated with this user event.

.google.cloud.discoveryengine.v1.PanelInfo panel = 11;

Returns
Type	Description
PanelInfoOrBuilder

getParserForType()

public Parser<UserEvent> getParserForType()

Returns
Type	Description
Parser<UserEvent>

Overrides

GeneratedMessageV3.getParserForType()

getPromotionIds(int index)

public String getPromotionIds(int index)

The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 16;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The promotionIds at the given index.

getPromotionIdsBytes(int index)

public ByteString getPromotionIdsBytes(int index)

The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 16;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the promotionIds at the given index.

getPromotionIdsCount()

public int getPromotionIdsCount()

The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 16;

Returns
Type	Description
int	The count of promotionIds.

getPromotionIdsList()

public ProtocolStringList getPromotionIdsList()

The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 16;

Returns
Type	Description
ProtocolStringList	A list containing the promotionIds.

getSearchInfo()

public SearchInfo getSearchInfo()

SearchService.Search details related to the event.

This field should be set for search event.

.google.cloud.discoveryengine.v1.SearchInfo search_info = 12;

Returns
Type	Description
SearchInfo	The searchInfo.

getSearchInfoOrBuilder()

public SearchInfoOrBuilder getSearchInfoOrBuilder()

SearchService.Search details related to the event.

This field should be set for search event.

.google.cloud.discoveryengine.v1.SearchInfo search_info = 12;

Returns
Type	Description
SearchInfoOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSessionId()

public String getSessionId()

A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span.

A general guideline to populate the session_id:

1. If user has no activity for 30 min, a new session_id should be assigned.
2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.

string session_id = 6;

Returns
Type	Description
String	The sessionId.

getSessionIdBytes()

public ByteString getSessionIdBytes()

A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span.

A general guideline to populate the session_id:

1. If user has no activity for 30 min, a new session_id should be assigned.
2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.

string session_id = 6;

Returns
Type	Description
ByteString	The bytes for sessionId.

getTagIds(int index)

public String getTagIds(int index)

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 on the customer end.

repeated string tag_ids = 15;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The tagIds at the given index.

getTagIdsBytes(int index)

public ByteString getTagIdsBytes(int index)

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 on the customer end.

repeated string tag_ids = 15;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the tagIds at the given index.

getTagIdsCount()

public int getTagIdsCount()

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 on the customer end.

repeated string tag_ids = 15;

Returns
Type	Description
int	The count of tagIds.

getTagIdsList()

public ProtocolStringList getTagIdsList()

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 on the customer end.

repeated string tag_ids = 15;

Returns
Type	Description
ProtocolStringList	A list containing the tagIds.

getTransactionInfo()

public TransactionInfo getTransactionInfo()

The transaction metadata (if any) associated with this user event.

.google.cloud.discoveryengine.v1.TransactionInfo transaction_info = 14;

Returns
Type	Description
TransactionInfo	The transactionInfo.

getTransactionInfoOrBuilder()

public TransactionInfoOrBuilder getTransactionInfoOrBuilder()

The transaction metadata (if any) associated with this user event.

.google.cloud.discoveryengine.v1.TransactionInfo transaction_info = 14;

Returns
Type	Description
TransactionInfoOrBuilder

getUserInfo()

public UserInfo getUserInfo()

Information about the end user.

.google.cloud.discoveryengine.v1.UserInfo user_info = 4;

Returns
Type	Description
UserInfo	The userInfo.

getUserInfoOrBuilder()

public UserInfoOrBuilder getUserInfoOrBuilder()

Information about the end user.

.google.cloud.discoveryengine.v1.UserInfo user_info = 4;

Returns
Type	Description
UserInfoOrBuilder

getUserPseudoId()

public String getUserPseudoId()

Required. A unique identifier for tracking visitors.

For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website.

Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

The field should not contain PII or user-data. We recommend to use Google Analytics Client ID for this field.

string user_pseudo_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The userPseudoId.

getUserPseudoIdBytes()

public ByteString getUserPseudoIdBytes()

Required. A unique identifier for tracking visitors.

For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website.

Do not set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

The field should not contain PII or user-data. We recommend to use Google Analytics Client ID for this field.

string user_pseudo_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for userPseudoId.

hasCompletionInfo()

public boolean hasCompletionInfo()

CompletionService.CompleteQuery details related to the event.

This field should be set for search event when autocomplete function is enabled and the user clicks a suggestion for search.

.google.cloud.discoveryengine.v1.CompletionInfo completion_info = 13;

Returns
Type	Description
boolean	Whether the completionInfo field is set.

hasEventTime()

public boolean hasEventTime()

Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Returns
Type	Description
boolean	Whether the eventTime field is set.

hasMediaInfo()

public boolean hasMediaInfo()

Media-specific info.

.google.cloud.discoveryengine.v1.MediaInfo media_info = 18;

Returns
Type	Description
boolean	Whether the mediaInfo field is set.

hasPageInfo()

public boolean hasPageInfo()

Page metadata such as categories and other critical information for certain event types such as view-category-page.

.google.cloud.discoveryengine.v1.PageInfo page_info = 7;

Returns
Type	Description
boolean	Whether the pageInfo field is set.

hasPanel()

public boolean hasPanel()

Panel metadata associated with this user event.

.google.cloud.discoveryengine.v1.PanelInfo panel = 11;

Returns
Type	Description
boolean	Whether the panel field is set.

hasSearchInfo()

public boolean hasSearchInfo()

SearchService.Search details related to the event.

This field should be set for search event.

.google.cloud.discoveryengine.v1.SearchInfo search_info = 12;

Returns
Type	Description
boolean	Whether the searchInfo field is set.

hasTransactionInfo()

public boolean hasTransactionInfo()

The transaction metadata (if any) associated with this user event.

.google.cloud.discoveryengine.v1.TransactionInfo transaction_info = 14;

Returns
Type	Description
boolean	Whether the transactionInfo field is set.

hasUserInfo()

public boolean hasUserInfo()

Information about the end user.

.google.cloud.discoveryengine.v1.UserInfo user_info = 4;

Returns
Type	Description
boolean	Whether the userInfo field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

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

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public UserEvent.Builder newBuilderForType()

Returns
Type	Description
UserEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UserEvent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
UserEvent.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public UserEvent.Builder toBuilder()

Returns
Type	Description
UserEvent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException