UserEvent.Builder (proto-google-cloud-retail-v2 2.34.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>
    - - com.google.cloud.retail.v2.UserEvent.Builder

All Implemented Interfaces:

UserEventOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

UserEvent
```
public static final class UserEvent.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>
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.v2.UserEvent

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`UserEvent.Builder`	`addAllExperimentIds(Iterable<String> values)` A list of identifiers for the independent experiment groups this user event belongs to.
`UserEvent.Builder`	`addAllPageCategories(Iterable<String> values)` The categories associated with a category page.
`UserEvent.Builder`	`addAllProductDetails(Iterable<? extends ProductDetail> values)` The main product details related to the event.
`UserEvent.Builder`	`addExperimentIds(String value)` A list of identifiers for the independent experiment groups this user event belongs to.
`UserEvent.Builder`	`addExperimentIdsBytes(com.google.protobuf.ByteString value)` A list of identifiers for the independent experiment groups this user event belongs to.
`UserEvent.Builder`	`addPageCategories(String value)` The categories associated with a category page.
`UserEvent.Builder`	`addPageCategoriesBytes(com.google.protobuf.ByteString value)` The categories associated with a category page.
`UserEvent.Builder`	`addProductDetails(int index, ProductDetail.Builder builderForValue)` The main product details related to the event.
`UserEvent.Builder`	`addProductDetails(int index, ProductDetail value)` The main product details related to the event.
`UserEvent.Builder`	`addProductDetails(ProductDetail.Builder builderForValue)` The main product details related to the event.
`UserEvent.Builder`	`addProductDetails(ProductDetail value)` The main product details related to the event.
`ProductDetail.Builder`	`addProductDetailsBuilder()` The main product details related to the event.
`ProductDetail.Builder`	`addProductDetailsBuilder(int index)` The main product details related to the event.
`UserEvent.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`UserEvent`	`build()`
`UserEvent`	`buildPartial()`
`UserEvent.Builder`	`clear()`
`UserEvent.Builder`	`clearAttributes()`
`UserEvent.Builder`	`clearAttributionToken()` Highly recommended for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
`UserEvent.Builder`	`clearCartId()` The ID or name of the associated shopping cart.
`UserEvent.Builder`	`clearCompletionDetail()` The main auto-completion details related to the event.
`UserEvent.Builder`	`clearEntity()` 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.
`UserEvent.Builder`	`clearEventTime()` Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2.UserEventService.ImportUserEvents] method.
`UserEvent.Builder`	`clearEventType()` Required.
`UserEvent.Builder`	`clearExperimentIds()` A list of identifiers for the independent experiment groups this user event belongs to.
`UserEvent.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`UserEvent.Builder`	`clearFilter()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered.
`UserEvent.Builder`	`clearOffset()` An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
`UserEvent.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`UserEvent.Builder`	`clearOrderBy()` The order in which products are returned.
`UserEvent.Builder`	`clearPageCategories()` The categories associated with a category page.
`UserEvent.Builder`	`clearPageViewId()` A unique ID of a web page view.
`UserEvent.Builder`	`clearProductDetails()` The main product details related to the event.
`UserEvent.Builder`	`clearPurchaseTransaction()` A transaction represents the entire purchase transaction.
`UserEvent.Builder`	`clearReferrerUri()` The referrer URL of the current page.
`UserEvent.Builder`	`clearSearchQuery()` The user's search query.
`UserEvent.Builder`	`clearSessionId()` A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`UserEvent.Builder`	`clearUri()` Complete URL (window.location.href) of the user's current page.
`UserEvent.Builder`	`clearUserInfo()` User information.
`UserEvent.Builder`	`clearVisitorId()` Required.
`UserEvent.Builder`	`clone()`
`boolean`	`containsAttributes(String key)` Extra user event features to include in the recommendation model.
`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.v2.PredictionService.Predict].
`com.google.protobuf.ByteString`	`getAttributionTokenBytes()` Highly recommended for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2.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.
`CompletionDetail.Builder`	`getCompletionDetailBuilder()` The main auto-completion details related to the event.
`CompletionDetailOrBuilder`	`getCompletionDetailOrBuilder()` The main auto-completion details related to the event.
`UserEvent`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`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.v2.UserEventService.ImportUserEvents] method.
`com.google.protobuf.Timestamp.Builder`	`getEventTimeBuilder()` Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2.UserEventService.ImportUserEvents] method.
`com.google.protobuf.TimestampOrBuilder`	`getEventTimeOrBuilder()` Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2.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.
`Map<String,CustomAttribute>`	`getMutableAttributes()` Deprecated.
`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.
`ProductDetail`	`getProductDetails(int index)` The main product details related to the event.
`ProductDetail.Builder`	`getProductDetailsBuilder(int index)` The main product details related to the event.
`List<ProductDetail.Builder>`	`getProductDetailsBuilderList()` 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.
`PurchaseTransaction.Builder`	`getPurchaseTransactionBuilder()` 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.
`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.
`UserInfo.Builder`	`getUserInfoBuilder()` 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.v2.UserEventService.ImportUserEvents] method.
`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)`
`protected com.google.protobuf.MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`UserEvent.Builder`	`mergeCompletionDetail(CompletionDetail value)` The main auto-completion details related to the event.
`UserEvent.Builder`	`mergeEventTime(com.google.protobuf.Timestamp value)` Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2.UserEventService.ImportUserEvents] method.
`UserEvent.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`UserEvent.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`UserEvent.Builder`	`mergeFrom(UserEvent other)`
`UserEvent.Builder`	`mergePurchaseTransaction(PurchaseTransaction value)` A transaction represents the entire purchase transaction.
`UserEvent.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`UserEvent.Builder`	`mergeUserInfo(UserInfo value)` User information.
`UserEvent.Builder`	`putAllAttributes(Map<String,CustomAttribute> values)` Extra user event features to include in the recommendation model.
`UserEvent.Builder`	`putAttributes(String key, CustomAttribute value)` Extra user event features to include in the recommendation model.
`UserEvent.Builder`	`removeAttributes(String key)` Extra user event features to include in the recommendation model.
`UserEvent.Builder`	`removeProductDetails(int index)` The main product details related to the event.
`UserEvent.Builder`	`setAttributionToken(String value)` Highly recommended for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
`UserEvent.Builder`	`setAttributionTokenBytes(com.google.protobuf.ByteString value)` Highly recommended for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
`UserEvent.Builder`	`setCartId(String value)` The ID or name of the associated shopping cart.
`UserEvent.Builder`	`setCartIdBytes(com.google.protobuf.ByteString value)` The ID or name of the associated shopping cart.
`UserEvent.Builder`	`setCompletionDetail(CompletionDetail.Builder builderForValue)` The main auto-completion details related to the event.
`UserEvent.Builder`	`setCompletionDetail(CompletionDetail value)` The main auto-completion details related to the event.
`UserEvent.Builder`	`setEntity(String value)` 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.
`UserEvent.Builder`	`setEntityBytes(com.google.protobuf.ByteString value)` 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.
`UserEvent.Builder`	`setEventTime(com.google.protobuf.Timestamp.Builder builderForValue)` Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2.UserEventService.ImportUserEvents] method.
`UserEvent.Builder`	`setEventTime(com.google.protobuf.Timestamp value)` Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2.UserEventService.ImportUserEvents] method.
`UserEvent.Builder`	`setEventType(String value)` Required.
`UserEvent.Builder`	`setEventTypeBytes(com.google.protobuf.ByteString value)` Required.
`UserEvent.Builder`	`setExperimentIds(int index, String value)` A list of identifiers for the independent experiment groups this user event belongs to.
`UserEvent.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`UserEvent.Builder`	`setFilter(String value)` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered.
`UserEvent.Builder`	`setFilterBytes(com.google.protobuf.ByteString value)` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered.
`UserEvent.Builder`	`setOffset(int value)` An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
`UserEvent.Builder`	`setOrderBy(String value)` The order in which products are returned.
`UserEvent.Builder`	`setOrderByBytes(com.google.protobuf.ByteString value)` The order in which products are returned.
`UserEvent.Builder`	`setPageCategories(int index, String value)` The categories associated with a category page.
`UserEvent.Builder`	`setPageViewId(String value)` A unique ID of a web page view.
`UserEvent.Builder`	`setPageViewIdBytes(com.google.protobuf.ByteString value)` A unique ID of a web page view.
`UserEvent.Builder`	`setProductDetails(int index, ProductDetail.Builder builderForValue)` The main product details related to the event.
`UserEvent.Builder`	`setProductDetails(int index, ProductDetail value)` The main product details related to the event.
`UserEvent.Builder`	`setPurchaseTransaction(PurchaseTransaction.Builder builderForValue)` A transaction represents the entire purchase transaction.
`UserEvent.Builder`	`setPurchaseTransaction(PurchaseTransaction value)` A transaction represents the entire purchase transaction.
`UserEvent.Builder`	`setReferrerUri(String value)` The referrer URL of the current page.
`UserEvent.Builder`	`setReferrerUriBytes(com.google.protobuf.ByteString value)` The referrer URL of the current page.
`UserEvent.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`UserEvent.Builder`	`setSearchQuery(String value)` The user's search query.
`UserEvent.Builder`	`setSearchQueryBytes(com.google.protobuf.ByteString value)` The user's search query.
`UserEvent.Builder`	`setSessionId(String value)` A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`UserEvent.Builder`	`setSessionIdBytes(com.google.protobuf.ByteString value)` A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`UserEvent.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`UserEvent.Builder`	`setUri(String value)` Complete URL (window.location.href) of the user's current page.
`UserEvent.Builder`	`setUriBytes(com.google.protobuf.ByteString value)` Complete URL (window.location.href) of the user's current page.
`UserEvent.Builder`	`setUserInfo(UserInfo.Builder builderForValue)` User information.
`UserEvent.Builder`	`setUserInfo(UserInfo value)` User information.
`UserEvent.Builder`	`setVisitorId(String value)` Required.
`UserEvent.Builder`	`setVisitorIdBytes(com.google.protobuf.ByteString value)` Required.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapFieldReflection, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

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

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

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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

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

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

clear
```
public UserEvent.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

getDefaultInstanceForType
```
public UserEvent getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public UserEvent build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public UserEvent buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public UserEvent.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

setField

public UserEvent.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                  Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

clearField
```
public UserEvent.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

clearOneof
```
public UserEvent.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

setRepeatedField

public UserEvent.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          int index,
                                          Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

addRepeatedField

public UserEvent.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

mergeFrom
```
public UserEvent.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UserEvent.Builder>

mergeFrom

public UserEvent.Builder mergeFrom(UserEvent other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<UserEvent.Builder>

mergeFrom
```
public UserEvent.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UserEvent.Builder>

Throws:

IOException

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.

setEventType

public UserEvent.Builder setEventType(String value)

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

Parameters:: value - The eventType to set.
Returns:: This builder for chaining.

clearEventType

public UserEvent.Builder clearEventType()

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

Returns:: This builder for chaining.

setEventTypeBytes

public UserEvent.Builder setEventTypeBytes(com.google.protobuf.ByteString value)

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

Parameters:: value - The bytes for eventType to set.
Returns:: This builder for chaining.

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.

setVisitorId

public UserEvent.Builder setVisitorId(String value)

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

Parameters:: value - The visitorId to set.
Returns:: This builder for chaining.

clearVisitorId

public UserEvent.Builder clearVisitorId()

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

Returns:: This builder for chaining.

setVisitorIdBytes

public UserEvent.Builder setVisitorIdBytes(com.google.protobuf.ByteString value)

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

Parameters:: value - The bytes for visitorId to set.
Returns:: This builder for chaining.

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.

setSessionId

public UserEvent.Builder setSessionId(String value)

 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;

Parameters:: value - The sessionId to set.
Returns:: This builder for chaining.

clearSessionId

public UserEvent.Builder clearSessionId()

 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;

Returns:: This builder for chaining.

setSessionIdBytes

public UserEvent.Builder setSessionIdBytes(com.google.protobuf.ByteString value)

 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;

Parameters:: value - The bytes for sessionId to set.
Returns:: This builder for chaining.

hasEventTime

public boolean hasEventTime()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.retail.v2.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.v2.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.

setEventTime

public UserEvent.Builder setEventTime(com.google.protobuf.Timestamp value)

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

.google.protobuf.Timestamp event_time = 3;

setEventTime

public UserEvent.Builder setEventTime(com.google.protobuf.Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp event_time = 3;

mergeEventTime

public UserEvent.Builder mergeEventTime(com.google.protobuf.Timestamp value)

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

.google.protobuf.Timestamp event_time = 3;

clearEventTime

public UserEvent.Builder clearEventTime()

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

.google.protobuf.Timestamp event_time = 3;

getEventTimeBuilder

public com.google.protobuf.Timestamp.Builder getEventTimeBuilder()

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

.google.protobuf.Timestamp event_time = 3;

getEventTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder()

 Only required for
 [UserEventService.ImportUserEvents][google.cloud.retail.v2.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.

setExperimentIds

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

 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;

Parameters:: index - The index to set the value at.; value - The experimentIds to set.
Returns:: This builder for chaining.

addExperimentIds

public UserEvent.Builder addExperimentIds(String value)

 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;

Parameters:: value - The experimentIds to add.
Returns:: This builder for chaining.

addAllExperimentIds

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

 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;

Parameters:: values - The experimentIds to add.
Returns:: This builder for chaining.

clearExperimentIds

public UserEvent.Builder clearExperimentIds()

 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;

Returns:: This builder for chaining.

addExperimentIdsBytes

public UserEvent.Builder addExperimentIdsBytes(com.google.protobuf.ByteString value)

 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;

Parameters:: value - The bytes of the experimentIds to add.
Returns:: This builder for chaining.

getAttributionToken

public String getAttributionToken()

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

 The value must be a valid
 [PredictResponse.attribution_token][google.cloud.retail.v2.PredictResponse.attribution_token]
 for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
 The value must be a valid
 [SearchResponse.attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
 for user events that are the result of
 [SearchService.Search][google.cloud.retail.v2.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.v2.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.v2.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.v2.PredictionService.Predict].
 This field enables accurate attribution of recommendation model
 performance.

 The value must be a valid
 [PredictResponse.attribution_token][google.cloud.retail.v2.PredictResponse.attribution_token]
 for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
 The value must be a valid
 [SearchResponse.attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
 for user events that are the result of
 [SearchService.Search][google.cloud.retail.v2.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.v2.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.v2.PredictResponse.attribution_token]
 to this field.

string attribution_token = 5;

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

setAttributionToken

public UserEvent.Builder setAttributionToken(String value)

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

 The value must be a valid
 [PredictResponse.attribution_token][google.cloud.retail.v2.PredictResponse.attribution_token]
 for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
 The value must be a valid
 [SearchResponse.attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
 for user events that are the result of
 [SearchService.Search][google.cloud.retail.v2.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.v2.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.v2.PredictResponse.attribution_token]
 to this field.

string attribution_token = 5;

Parameters:: value - The attributionToken to set.
Returns:: This builder for chaining.

clearAttributionToken

public UserEvent.Builder clearAttributionToken()

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

 The value must be a valid
 [PredictResponse.attribution_token][google.cloud.retail.v2.PredictResponse.attribution_token]
 for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
 The value must be a valid
 [SearchResponse.attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
 for user events that are the result of
 [SearchService.Search][google.cloud.retail.v2.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.v2.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.v2.PredictResponse.attribution_token]
 to this field.

string attribution_token = 5;

Returns:: This builder for chaining.

setAttributionTokenBytes

public UserEvent.Builder setAttributionTokenBytes(com.google.protobuf.ByteString value)

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

 The value must be a valid
 [PredictResponse.attribution_token][google.cloud.retail.v2.PredictResponse.attribution_token]
 for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
 The value must be a valid
 [SearchResponse.attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
 for user events that are the result of
 [SearchService.Search][google.cloud.retail.v2.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.v2.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.v2.PredictResponse.attribution_token]
 to this field.

string attribution_token = 5;

Parameters:: value - The bytes for attributionToken to set.
Returns:: This builder for chaining.