Package com.google.cloud.recommendationengine.v1beta1

Interface UserEventOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UserEvent, UserEvent.Builder

public interface UserEventOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
EventDetail	getEventDetail()	Optional.
EventDetailOrBuilder	getEventDetailOrBuilder()	Optional.
UserEvent.EventSource	getEventSource()	Optional.
int	getEventSourceValue()	Optional.
com.google.protobuf.Timestamp	getEventTime()	Optional.
com.google.protobuf.TimestampOrBuilder	getEventTimeOrBuilder()	Optional.
String	getEventType()	Required.
com.google.protobuf.ByteString	getEventTypeBytes()	Required.
ProductEventDetail	getProductEventDetail()	Optional.
ProductEventDetailOrBuilder	getProductEventDetailOrBuilder()	Optional.
UserInfo	getUserInfo()	Required.
UserInfoOrBuilder	getUserInfoOrBuilder()	Required.
boolean	hasEventDetail()	Optional.
boolean	hasEventTime()	Optional.
boolean	hasProductEventDetail()	Optional.
boolean	hasUserInfo()	Required.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getEventType

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:

The eventType.

getEventTypeBytes

com.google.protobuf.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:

The bytes for eventType.

hasUserInfo

boolean hasUserInfo()

 Required. User information.
 

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

Returns:

Whether the userInfo field is set.

getUserInfo

UserInfo getUserInfo()

 Required. User information.
 

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

Returns:

The userInfo.

getUserInfoOrBuilder

UserInfoOrBuilder getUserInfoOrBuilder()

 Required. User information.
 

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

hasEventDetail

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:

Whether the eventDetail field is set.

getEventDetail

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:

The eventDetail.

getEventDetailOrBuilder

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

hasProductEventDetail

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:

Whether the productEventDetail field is set.

getProductEventDetail

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:

The productEventDetail.

getProductEventDetailOrBuilder

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

hasEventTime

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:

Whether the eventTime field is set.

getEventTime

com.google.protobuf.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:

The eventTime.

getEventTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder()

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

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

getEventSourceValue

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:

The enum numeric value on the wire for eventSource.

getEventSource

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:

The eventSource.