Class UserEvent.Builder (0.42.0)

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

Implements

UserEventOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UserEvent.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UserEvent.Builder
Overrides

build()

public UserEvent build()
Returns
TypeDescription
UserEvent

buildPartial()

public UserEvent buildPartial()
Returns
TypeDescription
UserEvent

clear()

public UserEvent.Builder clear()
Returns
TypeDescription
UserEvent.Builder
Overrides

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UserEvent.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UserEvent.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UserEvent.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UserEvent.Builder
Overrides

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

clearUserInfo()

public UserEvent.Builder clearUserInfo()

Required. User information.

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

Returns
TypeDescription
UserEvent.Builder

clone()

public UserEvent.Builder clone()
Returns
TypeDescription
UserEvent.Builder
Overrides

getDefaultInstanceForType()

public UserEvent getDefaultInstanceForType()
Returns
TypeDescription
UserEvent

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ProductEventDetailOrBuilder

getUserInfo()

public UserInfo getUserInfo()

Required. User information.

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

Returns
TypeDescription
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
TypeDescription
UserInfo.Builder

getUserInfoOrBuilder()

public UserInfoOrBuilder getUserInfoOrBuilder()

Required. User information.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the userInfo field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides