UserEvent (proto-google-cloud-discoveryengine-v1beta 0.29.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.discoveryengine.v1beta.UserEvent

All Implemented Interfaces:

UserEventOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class UserEvent
extends com.google.protobuf.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.v1beta.UserEvent
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UserEvent.Builder` UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ATTRIBUTES_FIELD_NUMBER`
`static int`	`ATTRIBUTION_TOKEN_FIELD_NUMBER`
`static int`	`COMPLETION_INFO_FIELD_NUMBER`
`static int`	`DIRECT_USER_REQUEST_FIELD_NUMBER`
`static int`	`DOCUMENTS_FIELD_NUMBER`
`static int`	`EVENT_TIME_FIELD_NUMBER`
`static int`	`EVENT_TYPE_FIELD_NUMBER`
`static int`	`FILTER_FIELD_NUMBER`
`static int`	`MEDIA_INFO_FIELD_NUMBER`
`static int`	`PAGE_INFO_FIELD_NUMBER`
`static int`	`PANEL_FIELD_NUMBER`
`static int`	`PROMOTION_IDS_FIELD_NUMBER`
`static int`	`SEARCH_INFO_FIELD_NUMBER`
`static int`	`SESSION_ID_FIELD_NUMBER`
`static int`	`TAG_IDS_FIELD_NUMBER`
`static int`	`TRANSACTION_INFO_FIELD_NUMBER`
`static int`	`USER_INFO_FIELD_NUMBER`
`static int`	`USER_PSEUDO_ID_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsAttributes(String key)` Extra user event features to include in the recommendation model.
`boolean`	`equals(Object obj)`
`Map<String,CustomAttribute>`	`getAttributes()` Deprecated.
`int`	`getAttributesCount()` Extra user event features to include in the recommendation model.
`Map<String,CustomAttribute>`	`getAttributesMap()` Extra user event features to include in the recommendation model.
`CustomAttribute`	`getAttributesOrDefault(String key, CustomAttribute defaultValue)` Extra user event features to include in the recommendation model.
`CustomAttribute`	`getAttributesOrThrow(String key)` Extra user event features to include in the recommendation model.
`String`	`getAttributionToken()` Token to attribute an API response to user action(s) to trigger the event.
`com.google.protobuf.ByteString`	`getAttributionTokenBytes()` Token to attribute an API response to user action(s) to trigger the event.
`CompletionInfo`	`getCompletionInfo()` [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] details related to the event.
`CompletionInfoOrBuilder`	`getCompletionInfoOrBuilder()` [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] details related to the event.
`static UserEvent`	`getDefaultInstance()`
`UserEvent`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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][google.cloud.discoveryengine.v1beta.UserInfo.user_agent] can be populated from the HTTP request.
`DocumentInfo`	`getDocuments(int index)` List of [Document][google.cloud.discoveryengine.v1beta.Document]s associated with this user event.
`int`	`getDocumentsCount()` List of [Document][google.cloud.discoveryengine.v1beta.Document]s associated with this user event.
`List<DocumentInfo>`	`getDocumentsList()` List of [Document][google.cloud.discoveryengine.v1beta.Document]s associated with this user event.
`DocumentInfoOrBuilder`	`getDocumentsOrBuilder(int index)` List of [Document][google.cloud.discoveryengine.v1beta.Document]s associated with this user event.
`List<? extends DocumentInfoOrBuilder>`	`getDocumentsOrBuilderList()` List of [Document][google.cloud.discoveryengine.v1beta.Document]s associated with this user event.
`com.google.protobuf.Timestamp`	`getEventTime()` Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents] method.
`com.google.protobuf.TimestampOrBuilder`	`getEventTimeOrBuilder()` Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents] method.
`String`	`getEventType()` Required.
`com.google.protobuf.ByteString`	`getEventTypeBytes()` Required.
`String`	`getFilter()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`com.google.protobuf.ByteString`	`getFilterBytes()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`MediaInfo`	`getMediaInfo()` Media-specific info.
`MediaInfoOrBuilder`	`getMediaInfoOrBuilder()` Media-specific info.
`PageInfo`	`getPageInfo()` Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`PageInfoOrBuilder`	`getPageInfoOrBuilder()` Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`PanelInfo`	`getPanel()` Panel metadata associated with this user event.
`PanelInfoOrBuilder`	`getPanelOrBuilder()` Panel metadata associated with this user event.
`com.google.protobuf.Parser<UserEvent>`	`getParserForType()`
`String`	`getPromotionIds(int index)` The promotion IDs if this is an event associated with promotions.
`com.google.protobuf.ByteString`	`getPromotionIdsBytes(int index)` The promotion IDs if this is an event associated with promotions.
`int`	`getPromotionIdsCount()` The promotion IDs if this is an event associated with promotions.
`com.google.protobuf.ProtocolStringList`	`getPromotionIdsList()` The promotion IDs if this is an event associated with promotions.
`SearchInfo`	`getSearchInfo()` [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] details related to the event.
`SearchInfoOrBuilder`	`getSearchInfoOrBuilder()` [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] details related to the event.
`int`	`getSerializedSize()`
`String`	`getSessionId()` A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`com.google.protobuf.ByteString`	`getSessionIdBytes()` A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`String`	`getTagIds(int index)` A list of identifiers for the independent experiment groups this user event belongs to.
`com.google.protobuf.ByteString`	`getTagIdsBytes(int index)` A list of identifiers for the independent experiment groups this user event belongs to.
`int`	`getTagIdsCount()` A list of identifiers for the independent experiment groups this user event belongs to.
`com.google.protobuf.ProtocolStringList`	`getTagIdsList()` A list of identifiers for the independent experiment groups this user event belongs to.
`TransactionInfo`	`getTransactionInfo()` The transaction metadata (if any) associated with this user event.
`TransactionInfoOrBuilder`	`getTransactionInfoOrBuilder()` The transaction metadata (if any) associated with this user event.
`UserInfo`	`getUserInfo()` Information about the end user.
`UserInfoOrBuilder`	`getUserInfoOrBuilder()` Information about the end user.
`String`	`getUserPseudoId()` Required.
`com.google.protobuf.ByteString`	`getUserPseudoIdBytes()` Required.
`boolean`	`hasCompletionInfo()` [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] details related to the event.
`boolean`	`hasEventTime()` Only required for [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents] method.
`int`	`hashCode()`
`boolean`	`hasMediaInfo()` Media-specific info.
`boolean`	`hasPageInfo()` Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`boolean`	`hasPanel()` Panel metadata associated with this user event.
`boolean`	`hasSearchInfo()` [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] details related to the event.
`boolean`	`hasTransactionInfo()` The transaction metadata (if any) associated with this user event.
`boolean`	`hasUserInfo()` Information about the end user.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static UserEvent.Builder`	`newBuilder()`
`static UserEvent.Builder`	`newBuilder(UserEvent prototype)`
`UserEvent.Builder`	`newBuilderForType()`
`protected UserEvent.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static UserEvent`	`parseDelimitedFrom(InputStream input)`
`static UserEvent`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UserEvent`	`parseFrom(byte[] data)`
`static UserEvent`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UserEvent`	`parseFrom(ByteBuffer data)`
`static UserEvent`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UserEvent`	`parseFrom(com.google.protobuf.ByteString data)`
`static UserEvent`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UserEvent`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static UserEvent`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static UserEvent`	`parseFrom(InputStream input)`
`static UserEvent`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<UserEvent>`	`parser()`
`UserEvent.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- EVENT_TYPE_FIELD_NUMBER
```
public static final int EVENT_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_PSEUDO_ID_FIELD_NUMBER
```
public static final int USER_PSEUDO_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EVENT_TIME_FIELD_NUMBER
```
public static final int EVENT_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_INFO_FIELD_NUMBER
```
public static final int USER_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DIRECT_USER_REQUEST_FIELD_NUMBER
```
public static final int DIRECT_USER_REQUEST_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SESSION_ID_FIELD_NUMBER
```
public static final int SESSION_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_INFO_FIELD_NUMBER
```
public static final int PAGE_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ATTRIBUTION_TOKEN_FIELD_NUMBER
```
public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FILTER_FIELD_NUMBER
```
public static final int FILTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DOCUMENTS_FIELD_NUMBER
```
public static final int DOCUMENTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PANEL_FIELD_NUMBER
```
public static final int PANEL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SEARCH_INFO_FIELD_NUMBER
```
public static final int SEARCH_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- COMPLETION_INFO_FIELD_NUMBER
```
public static final int COMPLETION_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRANSACTION_INFO_FIELD_NUMBER
```
public static final int TRANSACTION_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TAG_IDS_FIELD_NUMBER
```
public static final int TAG_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PROMOTION_IDS_FIELD_NUMBER
```
public static final int PROMOTION_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ATTRIBUTES_FIELD_NUMBER
```
public static final int ATTRIBUTES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MEDIA_INFO_FIELD_NUMBER
```
public static final int MEDIA_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

Specified by:: getEventType in interface UserEventOrBuilder
Returns:: The eventType.

getEventTypeBytes

public com.google.protobuf.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];

Specified by:: getEventTypeBytes in interface UserEventOrBuilder
Returns:: The bytes for eventType.

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](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 for this field.

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

Specified by:: getUserPseudoId in interface UserEventOrBuilder
Returns:: The userPseudoId.

getUserPseudoIdBytes

public com.google.protobuf.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](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 for this field.

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

Specified by:: getUserPseudoIdBytes in interface UserEventOrBuilder
Returns:: The bytes for userPseudoId.

hasEventTime

public boolean hasEventTime()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Specified by:: hasEventTime in interface UserEventOrBuilder
Returns:: Whether the eventTime field is set.

getEventTime

public com.google.protobuf.Timestamp getEventTime()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Specified by:: getEventTime in interface UserEventOrBuilder
Returns:: The eventTime.

getEventTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.discoveryengine.v1beta.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Specified by:: getEventTimeOrBuilder in interface UserEventOrBuilder

hasUserInfo
```
public boolean hasUserInfo()
```
```
 Information about the end user.
 
```
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 4;
Specified by:

hasUserInfo in interface UserEventOrBuilder

Returns:

Whether the userInfo field is set.

getUserInfo
```
public UserInfo getUserInfo()
```
```
 Information about the end user.
 
```
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 4;
Specified by:

getUserInfo in interface UserEventOrBuilder

Returns:

The userInfo.

getUserInfoOrBuilder
```
public UserInfoOrBuilder getUserInfoOrBuilder()
```
```
 Information about the end user.
 
```
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 4;
Specified by:

getUserInfoOrBuilder in interface UserEventOrBuilder

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][google.cloud.discoveryengine.v1beta.UserInfo.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][google.cloud.discoveryengine.v1beta.UserEventService.CollectUserEvent].

bool direct_user_request = 5;

Specified by:: getDirectUserRequest in interface UserEventOrBuilder
Returns:: The directUserRequest.

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][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 as prefix.

string session_id = 6;

Specified by:: getSessionId in interface UserEventOrBuilder
Returns:: The sessionId.

getSessionIdBytes

public com.google.protobuf.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][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 as prefix.

string session_id = 6;

Specified by:: getSessionIdBytes in interface UserEventOrBuilder
Returns:: The bytes for sessionId.

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.v1beta.PageInfo page_info = 7;
Specified by:

hasPageInfo in interface UserEventOrBuilder

Returns:

Whether the pageInfo field is set.

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.v1beta.PageInfo page_info = 7;

Specified by:: getPageInfo in interface UserEventOrBuilder
Returns:: 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.v1beta.PageInfo page_info = 7;

Specified by:: getPageInfoOrBuilder in interface UserEventOrBuilder

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][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
 This field enables accurate attribution of recommendation model
 performance.

 The value must be one of:

 * [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token] for events that are the result of
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
 * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] for events that are the result of
 [SearchService.Search][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token]
 to this field.

string attribution_token = 8;

Specified by:: getAttributionToken in interface UserEventOrBuilder
Returns:: The attributionToken.

getAttributionTokenBytes

public com.google.protobuf.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][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
 This field enables accurate attribution of recommendation model
 performance.

 The value must be one of:

 * [RecommendResponse.attribution_token][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token] for events that are the result of
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
 * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] for events that are the result of
 [SearchService.Search][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.RecommendResponse.attribution_token]
 to this field.

string attribution_token = 8;

Specified by:: getAttributionTokenBytes in interface UserEventOrBuilder
Returns:: The bytes for attributionToken.

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][google.cloud.discoveryengine.v1beta.SearchRequest] may
 contain a filter expression in
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 conforming to https://google.aip.dev/160#filtering.

 Similarly, for `view-item-list` events that are generated from a
 [RecommendationService.RecommendRequest][], this field may be populated
 directly from [RecommendationService.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;

Specified by:: getFilter in interface UserEventOrBuilder
Returns:: The filter.

getFilterBytes

public com.google.protobuf.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][google.cloud.discoveryengine.v1beta.SearchRequest] may
 contain a filter expression in
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
 conforming to https://google.aip.dev/160#filtering.

 Similarly, for `view-item-list` events that are generated from a
 [RecommendationService.RecommendRequest][], this field may be populated
 directly from [RecommendationService.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;

Specified by:: getFilterBytes in interface UserEventOrBuilder
Returns:: The bytes for filter.