UserEvent (proto-google-cloud-retail-v2beta 2.35.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.retail.v2beta.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 Retail API needs to know about
 how end users interact with customers' website.
 
```
Protobuf type google.cloud.retail.v2beta.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 Retail 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`	`CART_ID_FIELD_NUMBER`
`static int`	`COMPLETION_DETAIL_FIELD_NUMBER`
`static int`	`ENTITY_FIELD_NUMBER`
`static int`	`EVENT_TIME_FIELD_NUMBER`
`static int`	`EVENT_TYPE_FIELD_NUMBER`
`static int`	`EXPERIMENT_IDS_FIELD_NUMBER`
`static int`	`FILTER_FIELD_NUMBER`
`static int`	`OFFSET_FIELD_NUMBER`
`static int`	`ORDER_BY_FIELD_NUMBER`
`static int`	`PAGE_CATEGORIES_FIELD_NUMBER`
`static int`	`PAGE_VIEW_ID_FIELD_NUMBER`
`static int`	`PRODUCT_DETAILS_FIELD_NUMBER`
`static int`	`PURCHASE_TRANSACTION_FIELD_NUMBER`
`static int`	`REFERRER_URI_FIELD_NUMBER`
`static int`	`SEARCH_QUERY_FIELD_NUMBER`
`static int`	`SESSION_ID_FIELD_NUMBER`
`static int`	`URI_FIELD_NUMBER`
`static int`	`USER_INFO_FIELD_NUMBER`
`static int`	`VISITOR_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()` Highly recommended for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2beta.PredictionService.Predict].
`com.google.protobuf.ByteString`	`getAttributionTokenBytes()` Highly recommended for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2beta.PredictionService.Predict].
`String`	`getCartId()` The ID or name of the associated shopping cart.
`com.google.protobuf.ByteString`	`getCartIdBytes()` The ID or name of the associated shopping cart.
`CompletionDetail`	`getCompletionDetail()` The main auto-completion details related to the event.
`CompletionDetailOrBuilder`	`getCompletionDetailOrBuilder()` The main auto-completion details related to the event.
`static UserEvent`	`getDefaultInstance()`
`UserEvent`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getEntity()` The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.
`com.google.protobuf.ByteString`	`getEntityBytes()` The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.
`com.google.protobuf.Timestamp`	`getEventTime()` Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2beta.UserEventService.ImportUserEvents] method.
`com.google.protobuf.TimestampOrBuilder`	`getEventTimeOrBuilder()` Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2beta.UserEventService.ImportUserEvents] method.
`String`	`getEventType()` Required.
`com.google.protobuf.ByteString`	`getEventTypeBytes()` Required.
`String`	`getExperimentIds(int index)` A list of identifiers for the independent experiment groups this user event belongs to.
`com.google.protobuf.ByteString`	`getExperimentIdsBytes(int index)` A list of identifiers for the independent experiment groups this user event belongs to.
`int`	`getExperimentIdsCount()` A list of identifiers for the independent experiment groups this user event belongs to.
`com.google.protobuf.ProtocolStringList`	`getExperimentIdsList()` A list of identifiers for the independent experiment groups this user event belongs to.
`String`	`getFilter()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products 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 products being filtered.
`int`	`getOffset()` An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
`String`	`getOrderBy()` The order in which products are returned.
`com.google.protobuf.ByteString`	`getOrderByBytes()` The order in which products are returned.
`String`	`getPageCategories(int index)` The categories associated with a category page.
`com.google.protobuf.ByteString`	`getPageCategoriesBytes(int index)` The categories associated with a category page.
`int`	`getPageCategoriesCount()` The categories associated with a category page.
`com.google.protobuf.ProtocolStringList`	`getPageCategoriesList()` The categories associated with a category page.
`String`	`getPageViewId()` A unique ID of a web page view.
`com.google.protobuf.ByteString`	`getPageViewIdBytes()` A unique ID of a web page view.
`com.google.protobuf.Parser<UserEvent>`	`getParserForType()`
`ProductDetail`	`getProductDetails(int index)` The main product details related to the event.
`int`	`getProductDetailsCount()` The main product details related to the event.
`List<ProductDetail>`	`getProductDetailsList()` The main product details related to the event.
`ProductDetailOrBuilder`	`getProductDetailsOrBuilder(int index)` The main product details related to the event.
`List<? extends ProductDetailOrBuilder>`	`getProductDetailsOrBuilderList()` The main product details related to the event.
`PurchaseTransaction`	`getPurchaseTransaction()` A transaction represents the entire purchase transaction.
`PurchaseTransactionOrBuilder`	`getPurchaseTransactionOrBuilder()` A transaction represents the entire purchase transaction.
`String`	`getReferrerUri()` The referrer URL of the current page.
`com.google.protobuf.ByteString`	`getReferrerUriBytes()` The referrer URL of the current page.
`String`	`getSearchQuery()` The user's search query.
`com.google.protobuf.ByteString`	`getSearchQueryBytes()` The user's search query.
`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`	`getUri()` Complete URL (window.location.href) of the user's current page.
`com.google.protobuf.ByteString`	`getUriBytes()` Complete URL (window.location.href) of the user's current page.
`UserInfo`	`getUserInfo()` User information.
`UserInfoOrBuilder`	`getUserInfoOrBuilder()` User information.
`String`	`getVisitorId()` Required.
`com.google.protobuf.ByteString`	`getVisitorIdBytes()` Required.
`boolean`	`hasCompletionDetail()` The main auto-completion details related to the event.
`boolean`	`hasEventTime()` Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2beta.UserEventService.ImportUserEvents] method.
`int`	`hashCode()`
`boolean`	`hasPurchaseTransaction()` A transaction represents the entire purchase transaction.
`boolean`	`hasUserInfo()` User information.
`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
- VISITOR_ID_FIELD_NUMBER
```
public static final int VISITOR_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SESSION_ID_FIELD_NUMBER
```
public static final int SESSION_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
- EXPERIMENT_IDS_FIELD_NUMBER
```
public static final int EXPERIMENT_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ATTRIBUTION_TOKEN_FIELD_NUMBER
```
public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PRODUCT_DETAILS_FIELD_NUMBER
```
public static final int PRODUCT_DETAILS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- COMPLETION_DETAIL_FIELD_NUMBER
```
public static final int COMPLETION_DETAIL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ATTRIBUTES_FIELD_NUMBER
```
public static final int ATTRIBUTES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CART_ID_FIELD_NUMBER
```
public static final int CART_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PURCHASE_TRANSACTION_FIELD_NUMBER
```
public static final int PURCHASE_TRANSACTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SEARCH_QUERY_FIELD_NUMBER
```
public static final int SEARCH_QUERY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FILTER_FIELD_NUMBER
```
public static final int FILTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ORDER_BY_FIELD_NUMBER
```
public static final int ORDER_BY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OFFSET_FIELD_NUMBER
```
public static final int OFFSET_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_CATEGORIES_FIELD_NUMBER
```
public static final int PAGE_CATEGORIES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_INFO_FIELD_NUMBER
```
public static final int USER_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- URI_FIELD_NUMBER
```
public static final int URI_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REFERRER_URI_FIELD_NUMBER
```
public static final int REFERRER_URI_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_VIEW_ID_FIELD_NUMBER
```
public static final int PAGE_VIEW_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENTITY_FIELD_NUMBER
```
public static final int ENTITY_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:

 * `add-to-cart`: Products being added to cart.
 * `category-page-view`: Special pages such as sale or promotion pages
   viewed.
 * `detail-page-view`: Products detail page viewed.
 * `home-page-view`: Homepage viewed.
 * `promotion-offered`: Promotion is offered to a user.
 * `promotion-not-offered`: Promotion is not offered to a user.
 * `purchase-complete`: User finishing a purchase.
 * `search`: Product search.
 * `shopping-cart-page-view`: User viewing a shopping cart.

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:

 * `add-to-cart`: Products being added to cart.
 * `category-page-view`: Special pages such as sale or promotion pages
   viewed.
 * `detail-page-view`: Products detail page viewed.
 * `home-page-view`: Homepage viewed.
 * `promotion-offered`: Promotion is offered to a user.
 * `promotion-not-offered`: Promotion is not offered to a user.
 * `purchase-complete`: User finishing a purchase.
 * `search`: Product search.
 * `shopping-cart-page-view`: User viewing a shopping cart.

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

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

getVisitorId

public String getVisitorId()

 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.

 Don't 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 visitor_id = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getVisitorId in interface UserEventOrBuilder
Returns:: The visitorId.

getVisitorIdBytes

public com.google.protobuf.ByteString getVisitorIdBytes()

 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.

 Don't 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 visitor_id = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getVisitorIdBytes in interface UserEventOrBuilder
Returns:: The bytes for visitorId.

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 sesion_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
 visitor_id as prefix.

string session_id = 21;

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 sesion_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
 visitor_id as prefix.

string session_id = 21;

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

hasEventTime

public boolean hasEventTime()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.retail.v2beta.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.retail.v2beta.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.retail.v2beta.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Specified by:: getEventTimeOrBuilder in interface UserEventOrBuilder

getExperimentIdsList

public com.google.protobuf.ProtocolStringList getExperimentIdsList()

 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 Retail API, using different
 recommendation models).

repeated string experiment_ids = 4;

Specified by:: getExperimentIdsList in interface UserEventOrBuilder
Returns:: A list containing the experimentIds.

getExperimentIdsCount

public int getExperimentIdsCount()

 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 Retail API, using different
 recommendation models).

repeated string experiment_ids = 4;

Specified by:: getExperimentIdsCount in interface UserEventOrBuilder
Returns:: The count of experimentIds.

getExperimentIds

public String getExperimentIds(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 (e.g. using Retail API, using different
 recommendation models).

repeated string experiment_ids = 4;

Specified by:: getExperimentIds in interface UserEventOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The experimentIds at the given index.

getExperimentIdsBytes

public com.google.protobuf.ByteString getExperimentIdsBytes(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 (e.g. using Retail API, using different
 recommendation models).

repeated string experiment_ids = 4;

Specified by:: getExperimentIdsBytes in interface UserEventOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the experimentIds at the given index.

getAttributionToken

public String getAttributionToken()

 Highly recommended for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2beta.PredictionService.Predict].
 This field enables accurate attribution of recommendation model
 performance.

 The value must be a valid
 [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token]
 for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2beta.PredictionService.Predict].
 The value must be a valid
 [SearchResponse.attribution_token][google.cloud.retail.v2beta.SearchResponse.attribution_token]
 for user events that are the result of
 [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].

 This token enables us to accurately attribute page view or purchase 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
 [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token]
 as a URL parameter to product K's page. When recording events on product
 K's page, log the
 [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token]
 to this field.

string attribution_token = 5;

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

getAttributionTokenBytes

public com.google.protobuf.ByteString getAttributionTokenBytes()

 Highly recommended for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2beta.PredictionService.Predict].
 This field enables accurate attribution of recommendation model
 performance.

 The value must be a valid
 [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token]
 for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2beta.PredictionService.Predict].
 The value must be a valid
 [SearchResponse.attribution_token][google.cloud.retail.v2beta.SearchResponse.attribution_token]
 for user events that are the result of
 [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search].

 This token enables us to accurately attribute page view or purchase 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
 [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token]
 as a URL parameter to product K's page. When recording events on product
 K's page, log the
 [PredictResponse.attribution_token][google.cloud.retail.v2beta.PredictResponse.attribution_token]
 to this field.

string attribution_token = 5;

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