Class UserEvent.Builder (0.25.0)

Version 0.25.0

• 0.61.0 (latest)
• 0.60.0
• 0.59.0
• 0.58.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.4
• 0.8.10

public static final class UserEvent.Builder extends GeneratedMessageV3.Builder<UserEvent.Builder> implements UserEventOrBuilder

UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.

Protobuf type google.cloud.recommendationengine.v1beta1.UserEvent

Inheritance

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

Implements

UserEventOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

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

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

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

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
UserEvent.Builder

Overrides

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

build()

public UserEvent build()

Returns
Type	Description
UserEvent

buildPartial()

public UserEvent buildPartial()

Returns
Type	Description
UserEvent

clear()

public UserEvent.Builder clear()

Returns
Type	Description
UserEvent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearEventDetail()

public UserEvent.Builder clearEventDetail()

Optional. User event detailed information common across different recommendation types.

.google.cloud.recommendationengine.v1beta1.EventDetail event_detail = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserEvent.Builder

clearEventSource()

public UserEvent.Builder clearEventSource()

Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to EVENT_SOURCE_UNSPECIFIED.

.google.cloud.recommendationengine.v1beta1.UserEvent.EventSource event_source = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserEvent.Builder	This builder for chaining.

clearEventTime()

public UserEvent.Builder clearEventTime()

Optional. Only required for ImportUserEvents method. Timestamp of user event created.

.google.protobuf.Timestamp event_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserEvent.Builder

clearEventType()

public UserEvent.Builder clearEventType()

Required. User event type. Allowed values are:

• add-to-cart Products being added to cart.
• add-to-list Items being added to a list (shopping list, favorites etc).
• category-page-view Special pages such as sale or promotion pages viewed.
• checkout-start User starting a checkout process.
• detail-page-view Products detail page viewed.
• home-page-view Homepage viewed.
• page-visit Generic page visits not included in the event types above.
• purchase-complete User finishing a purchase.
• refund Purchased items being refunded or returned.
• remove-from-cart Products being removed from cart.
• remove-from-list Items being removed from a list.
• search Product search.
• shopping-cart-page-view User viewing a shopping cart.
• impression List of items displayed. Used by Google Tag Manager.

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

Returns
Type	Description
UserEvent.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UserEvent.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
UserEvent.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public UserEvent.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
UserEvent.Builder

Overrides

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

clearProductEventDetail()

public UserEvent.Builder clearProductEventDetail()

Optional. Retail product specific user event metadata. This field is required for the following event types:

• add-to-cart
• add-to-list
• category-page-view
• checkout-start
• detail-page-view
• purchase-complete
• refund
• remove-from-cart
• remove-from-list
• search This field is optional for the following event types:
• page-visit
• shopping-cart-page-view - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types:
• home-page-view

.google.cloud.recommendationengine.v1beta1.ProductEventDetail product_event_detail = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserEvent.Builder

clearUserInfo()

public UserEvent.Builder clearUserInfo()

Required. User information.

.google.cloud.recommendationengine.v1beta1.UserInfo user_info = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
UserEvent.Builder

clone()

public UserEvent.Builder clone()

Returns
Type	Description
UserEvent.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public UserEvent getDefaultInstanceForType()

Returns
Type	Description
UserEvent

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEventDetail()

public EventDetail getEventDetail()

Optional. User event detailed information common across different recommendation types.

.google.cloud.recommendationengine.v1beta1.EventDetail event_detail = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EventDetail	The eventDetail.

getEventDetailBuilder()

public EventDetail.Builder getEventDetailBuilder()

Optional. User event detailed information common across different recommendation types.

.google.cloud.recommendationengine.v1beta1.EventDetail event_detail = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EventDetail.Builder

getEventDetailOrBuilder()

public EventDetailOrBuilder getEventDetailOrBuilder()

Optional. User event detailed information common across different recommendation types.

.google.cloud.recommendationengine.v1beta1.EventDetail event_detail = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EventDetailOrBuilder

getEventSource()

public UserEvent.EventSource getEventSource()

Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to EVENT_SOURCE_UNSPECIFIED.

.google.cloud.recommendationengine.v1beta1.UserEvent.EventSource event_source = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserEvent.EventSource	The eventSource.

getEventSourceValue()

public int getEventSourceValue()

Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to EVENT_SOURCE_UNSPECIFIED.

.google.cloud.recommendationengine.v1beta1.UserEvent.EventSource event_source = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for eventSource.

getEventTime()

public Timestamp getEventTime()

Optional. Only required for ImportUserEvents method. Timestamp of user event created.

.google.protobuf.Timestamp event_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Timestamp	The eventTime.

getEventTimeBuilder()

public Timestamp.Builder getEventTimeBuilder()

Optional. Only required for ImportUserEvents method. Timestamp of user event created.

.google.protobuf.Timestamp event_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Builder

getEventTimeOrBuilder()

public TimestampOrBuilder getEventTimeOrBuilder()

Optional. Only required for ImportUserEvents method. Timestamp of user event created.

.google.protobuf.Timestamp event_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimestampOrBuilder

getEventType()

public String getEventType()

Required. User event type. Allowed values are:

• add-to-cart Products being added to cart.
• add-to-list Items being added to a list (shopping list, favorites etc).
• category-page-view Special pages such as sale or promotion pages viewed.
• checkout-start User starting a checkout process.
• detail-page-view Products detail page viewed.
• home-page-view Homepage viewed.
• page-visit Generic page visits not included in the event types above.
• purchase-complete User finishing a purchase.
• refund Purchased items being refunded or returned.
• remove-from-cart Products being removed from cart.
• remove-from-list Items being removed from a list.
• search Product search.
• shopping-cart-page-view User viewing a shopping cart.
• impression List of items displayed. Used by Google Tag Manager.

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

Returns
Type	Description
String	The eventType.

getEventTypeBytes()

public ByteString getEventTypeBytes()

Required. User event type. Allowed values are:

• add-to-cart Products being added to cart.
• add-to-list Items being added to a list (shopping list, favorites etc).
• category-page-view Special pages such as sale or promotion pages viewed.
• checkout-start User starting a checkout process.
• detail-page-view Products detail page viewed.
• home-page-view Homepage viewed.
• page-visit Generic page visits not included in the event types above.
• purchase-complete User finishing a purchase.
• refund Purchased items being refunded or returned.
• remove-from-cart Products being removed from cart.
• remove-from-list Items being removed from a list.
• search Product search.
• shopping-cart-page-view User viewing a shopping cart.
• impression List of items displayed. Used by Google Tag Manager.

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

Returns
Type	Description
ByteString	The bytes for eventType.

getProductEventDetail()

public ProductEventDetail getProductEventDetail()

Optional. Retail product specific user event metadata. This field is required for the following event types:

• add-to-cart
• add-to-list
• category-page-view
• checkout-start
• detail-page-view
• purchase-complete
• refund
• remove-from-cart
• remove-from-list
• search This field is optional for the following event types:
• page-visit
• shopping-cart-page-view - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types:
• home-page-view

.google.cloud.recommendationengine.v1beta1.ProductEventDetail product_event_detail = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProductEventDetail	The productEventDetail.

getProductEventDetailBuilder()

public ProductEventDetail.Builder getProductEventDetailBuilder()

Optional. Retail product specific user event metadata. This field is required for the following event types:

• add-to-cart
• add-to-list
• category-page-view
• checkout-start
• detail-page-view
• purchase-complete
• refund
• remove-from-cart
• remove-from-list
• search This field is optional for the following event types:
• page-visit
• shopping-cart-page-view - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types:
• home-page-view

.google.cloud.recommendationengine.v1beta1.ProductEventDetail product_event_detail = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProductEventDetail.Builder

getProductEventDetailOrBuilder()

public ProductEventDetailOrBuilder getProductEventDetailOrBuilder()

Optional. Retail product specific user event metadata. This field is required for the following event types:

• add-to-cart
• add-to-list
• category-page-view
• checkout-start
• detail-page-view
• purchase-complete
• refund
• remove-from-cart
• remove-from-list
• search This field is optional for the following event types:
• page-visit
• shopping-cart-page-view - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types:
• home-page-view

.google.cloud.recommendationengine.v1beta1.ProductEventDetail product_event_detail = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProductEventDetailOrBuilder

getUserInfo()

public UserInfo getUserInfo()

Required. User information.

.google.cloud.recommendationengine.v1beta1.UserInfo user_info = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
UserInfo	The userInfo.

getUserInfoBuilder()

public UserInfo.Builder getUserInfoBuilder()

Required. User information.

.google.cloud.recommendationengine.v1beta1.UserInfo user_info = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
UserInfo.Builder

getUserInfoOrBuilder()

public UserInfoOrBuilder getUserInfoOrBuilder()

Required. User information.

.google.cloud.recommendationengine.v1beta1.UserInfo user_info = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
UserInfoOrBuilder

hasEventDetail()

public boolean hasEventDetail()

Optional. User event detailed information common across different recommendation types.

.google.cloud.recommendationengine.v1beta1.EventDetail event_detail = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the eventDetail field is set.

hasEventTime()

public boolean hasEventTime()

Optional. Only required for ImportUserEvents method. Timestamp of user event created.

.google.protobuf.Timestamp event_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the eventTime field is set.

hasProductEventDetail()

public boolean hasProductEventDetail()

Optional. Retail product specific user event metadata. This field is required for the following event types:

• add-to-cart
• add-to-list
• category-page-view
• checkout-start
• detail-page-view
• purchase-complete
• refund
• remove-from-cart
• remove-from-list
• search This field is optional for the following event types:
• page-visit
• shopping-cart-page-view - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types:
• home-page-view

.google.cloud.recommendationengine.v1beta1.ProductEventDetail product_event_detail = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the productEventDetail field is set.

hasUserInfo()

public boolean hasUserInfo()

Required. User information.

.google.cloud.recommendationengine.v1beta1.UserInfo user_info = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the userInfo field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeEventDetail(EventDetail value)

public UserEvent.Builder mergeEventDetail(EventDetail value)

Optional. User event detailed information common across different recommendation types.

.google.cloud.recommendationengine.v1beta1.EventDetail event_detail = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	EventDetail

Returns
Type	Description
UserEvent.Builder

mergeEventTime(Timestamp value)

public UserEvent.Builder mergeEventTime(Timestamp value)

Optional. Only required for ImportUserEvents method. Timestamp of user event created.

.google.protobuf.Timestamp event_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
UserEvent.Builder

mergeFrom(UserEvent other)

public UserEvent.Builder mergeFrom(UserEvent other)

Parameter
Name	Description
other	UserEvent

Returns
Type	Description
UserEvent.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
UserEvent.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public UserEvent.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
UserEvent.Builder

Overrides

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

mergeProductEventDetail(ProductEventDetail value)

public UserEvent.Builder mergeProductEventDetail(ProductEventDetail value)

Optional. Retail product specific user event metadata. This field is required for the following event types:

• add-to-cart
• add-to-list
• category-page-view
• checkout-start
• detail-page-view
• purchase-complete
• refund
• remove-from-cart
• remove-from-list
• search This field is optional for the following event types:
• page-visit
• shopping-cart-page-view - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types:
• home-page-view

.google.cloud.recommendationengine.v1beta1.ProductEventDetail product_event_detail = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ProductEventDetail

Returns
Type	Description
UserEvent.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UserEvent.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
UserEvent.Builder

Overrides

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

mergeUserInfo(UserInfo value)

public UserEvent.Builder mergeUserInfo(UserInfo value)

Required. User information.

.google.cloud.recommendationengine.v1beta1.UserInfo user_info = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	UserInfo

Returns
Type	Description
UserEvent.Builder

setEventDetail(EventDetail value)

public UserEvent.Builder setEventDetail(EventDetail value)

Optional. User event detailed information common across different recommendation types.

.google.cloud.recommendationengine.v1beta1.EventDetail event_detail = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	EventDetail

Returns
Type	Description
UserEvent.Builder

setEventDetail(EventDetail.Builder builderForValue)

public UserEvent.Builder setEventDetail(EventDetail.Builder builderForValue)

Optional. User event detailed information common across different recommendation types.

.google.cloud.recommendationengine.v1beta1.EventDetail event_detail = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	EventDetail.Builder

Returns
Type	Description
UserEvent.Builder

setEventSource(UserEvent.EventSource value)

public UserEvent.Builder setEventSource(UserEvent.EventSource value)

Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to EVENT_SOURCE_UNSPECIFIED.

.google.cloud.recommendationengine.v1beta1.UserEvent.EventSource event_source = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	UserEvent.EventSource The eventSource to set.

Returns
Type	Description
UserEvent.Builder	This builder for chaining.

setEventSourceValue(int value)

public UserEvent.Builder setEventSourceValue(int value)

Optional. This field should not be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to EVENT_SOURCE_UNSPECIFIED.

.google.cloud.recommendationengine.v1beta1.UserEvent.EventSource event_source = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for eventSource to set.

Returns
Type	Description
UserEvent.Builder	This builder for chaining.

setEventTime(Timestamp value)

public UserEvent.Builder setEventTime(Timestamp value)

Optional. Only required for ImportUserEvents method. Timestamp of user event created.

.google.protobuf.Timestamp event_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
UserEvent.Builder

setEventTime(Timestamp.Builder builderForValue)

public UserEvent.Builder setEventTime(Timestamp.Builder builderForValue)

Optional. Only required for ImportUserEvents method. Timestamp of user event created.

.google.protobuf.Timestamp event_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
UserEvent.Builder

setEventType(String value)

public UserEvent.Builder setEventType(String value)

Required. User event type. Allowed values are:

• add-to-cart Products being added to cart.
• add-to-list Items being added to a list (shopping list, favorites etc).
• category-page-view Special pages such as sale or promotion pages viewed.
• checkout-start User starting a checkout process.
• detail-page-view Products detail page viewed.
• home-page-view Homepage viewed.
• page-visit Generic page visits not included in the event types above.
• purchase-complete User finishing a purchase.
• refund Purchased items being refunded or returned.
• remove-from-cart Products being removed from cart.
• remove-from-list Items being removed from a list.
• search Product search.
• shopping-cart-page-view User viewing a shopping cart.
• impression List of items displayed. Used by Google Tag Manager.

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

Parameter
Name	Description
value	String The eventType to set.

Returns
Type	Description
UserEvent.Builder	This builder for chaining.

setEventTypeBytes(ByteString value)

public UserEvent.Builder setEventTypeBytes(ByteString value)

Required. User event type. Allowed values are:

• add-to-cart Products being added to cart.
• add-to-list Items being added to a list (shopping list, favorites etc).
• category-page-view Special pages such as sale or promotion pages viewed.
• checkout-start User starting a checkout process.
• detail-page-view Products detail page viewed.
• home-page-view Homepage viewed.
• page-visit Generic page visits not included in the event types above.
• purchase-complete User finishing a purchase.
• refund Purchased items being refunded or returned.
• remove-from-cart Products being removed from cart.
• remove-from-list Items being removed from a list.
• search Product search.
• shopping-cart-page-view User viewing a shopping cart.
• impression List of items displayed. Used by Google Tag Manager.

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

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

Returns
Type	Description
UserEvent.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
UserEvent.Builder

Overrides

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

setProductEventDetail(ProductEventDetail value)

public UserEvent.Builder setProductEventDetail(ProductEventDetail value)

Optional. Retail product specific user event metadata. This field is required for the following event types:

• add-to-cart
• add-to-list
• category-page-view
• checkout-start
• detail-page-view
• purchase-complete
• refund
• remove-from-cart
• remove-from-list
• search This field is optional for the following event types:
• page-visit
• shopping-cart-page-view - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types:
• home-page-view

.google.cloud.recommendationengine.v1beta1.ProductEventDetail product_event_detail = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ProductEventDetail

Returns
Type	Description
UserEvent.Builder

setProductEventDetail(ProductEventDetail.Builder builderForValue)

public UserEvent.Builder setProductEventDetail(ProductEventDetail.Builder builderForValue)

Optional. Retail product specific user event metadata. This field is required for the following event types:

• add-to-cart
• add-to-list
• category-page-view
• checkout-start
• detail-page-view
• purchase-complete
• refund
• remove-from-cart
• remove-from-list
• search This field is optional for the following event types:
• page-visit
• shopping-cart-page-view - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types:
• home-page-view

.google.cloud.recommendationengine.v1beta1.ProductEventDetail product_event_detail = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	ProductEventDetail.Builder

Returns
Type	Description
UserEvent.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
UserEvent.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final UserEvent.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
UserEvent.Builder

Overrides

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

setUserInfo(UserInfo value)

public UserEvent.Builder setUserInfo(UserInfo value)

Required. User information.

.google.cloud.recommendationengine.v1beta1.UserInfo user_info = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	UserInfo

Returns
Type	Description
UserEvent.Builder

setUserInfo(UserInfo.Builder builderForValue)

public UserEvent.Builder setUserInfo(UserInfo.Builder builderForValue)

Required. User information.

.google.cloud.recommendationengine.v1beta1.UserInfo user_info = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	UserInfo.Builder

Returns
Type	Description
UserEvent.Builder