Interface UserEventOrBuilder (0.49.0)

Version 0.49.0

• 0.60.0 (latest)
• 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 interface UserEventOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEventDetail()

public abstract 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.

getEventDetailOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.

getEventTimeOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.

getProductEventDetailOrBuilder()

public abstract 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 abstract UserInfo getUserInfo()

Required. User information.

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

Returns
Type	Description
UserInfo	The userInfo.

getUserInfoOrBuilder()

public abstract UserInfoOrBuilder getUserInfoOrBuilder()

Required. User information.

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

Returns
Type	Description
UserInfoOrBuilder

hasEventDetail()

public abstract 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 abstract 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 abstract 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 abstract 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.