Interface UserEventOrBuilder (2.14.0)

public interface UserEventOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAttributes(String key)

public abstract boolean containsAttributes(String key)

Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:

The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.
For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

map<string, .google.cloud.retail.v2.CustomAttribute> attributes = 7;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

getAttributes()

public abstract Map<String,CustomAttribute> getAttributes()

Use #getAttributesMap() instead.

Returns

Type	Description
`Map<String,CustomAttribute>`

getAttributesCount()

public abstract int getAttributesCount()

The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.
For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

map<string, .google.cloud.retail.v2.CustomAttribute> attributes = 7;

Returns

Type	Description
`int`

getAttributesMap()

public abstract Map<String,CustomAttribute> getAttributesMap()

The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.
For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

map<string, .google.cloud.retail.v2.CustomAttribute> attributes = 7;

Returns

Type	Description
`Map<String,CustomAttribute>`

getAttributesOrDefault(String key, CustomAttribute defaultValue)

public abstract CustomAttribute getAttributesOrDefault(String key, CustomAttribute defaultValue)

The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.
For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

map<string, .google.cloud.retail.v2.CustomAttribute> attributes = 7;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`CustomAttribute`

Returns

Type	Description
`CustomAttribute`

getAttributesOrThrow(String key)

public abstract CustomAttribute getAttributesOrThrow(String key)

The key must be a UTF-8 encoded string with a length limit of 5,000 characters.
For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters.
For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.

map<string, .google.cloud.retail.v2.CustomAttribute> attributes = 7;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`CustomAttribute`

getAttributionToken()

public abstract String getAttributionToken()

Highly recommended for user events that are the result of PredictionService.Predict. This field enables accurate attribution of recommendation model performance. The value must be a valid PredictResponse.attribution_token for user events that are the result of PredictionService.Predict. The value must be a valid SearchResponse.attribution_token for user events that are the result of 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 as a URL parameter to product K's page. When recording events on product K's page, log the PredictResponse.attribution_token to this field.

string attribution_token = 5;

Returns

Type	Description
`String`	The attributionToken.

getAttributionTokenBytes()

public abstract ByteString getAttributionTokenBytes()

string attribution_token = 5;

Returns

Type	Description
`ByteString`	The bytes for attributionToken.

getCartId()

public abstract String getCartId()

The ID or name of the associated shopping cart. This ID is used to associate multiple items added or present in the cart before purchase. This can only be set for add-to-cart, purchase-complete, or shopping-cart-page-view events.

string cart_id = 8;

Returns

Type	Description
`String`	The cartId.

getCartIdBytes()

public abstract ByteString getCartIdBytes()

string cart_id = 8;

Returns

Type	Description
`ByteString`	The bytes for cartId.

getCompletionDetail()

public abstract CompletionDetail getCompletionDetail()

The main auto-completion details related to the event. This field should be set for search event when autocomplete function is enabled and the user clicks a suggestion for search.

.google.cloud.retail.v2.CompletionDetail completion_detail = 22;

Returns

Type	Description
`CompletionDetail`	The completionDetail.

getCompletionDetailOrBuilder()

public abstract CompletionDetailOrBuilder getCompletionDetailOrBuilder()

The main auto-completion details related to the event. This field should be set for search event when autocomplete function is enabled and the user clicks a suggestion for search.

.google.cloud.retail.v2.CompletionDetail completion_detail = 22;

Returns

Type	Description
`CompletionDetailOrBuilder`

getEventTime()

public abstract Timestamp getEventTime()

Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Returns

Type	Description
`Timestamp`	The eventTime.

getEventTimeOrBuilder()

public abstract TimestampOrBuilder getEventTimeOrBuilder()

Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Returns

Type	Description
`TimestampOrBuilder`

getEventType()

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

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

Type	Description
`ByteString`	The bytes for eventType.

getExperimentIds(int index)

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

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The experimentIds at the given index.

getExperimentIdsBytes(int index)

public abstract ByteString getExperimentIdsBytes(int index)

repeated string experiment_ids = 4;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the experimentIds at the given index.

getExperimentIdsCount()

public abstract int getExperimentIdsCount()

repeated string experiment_ids = 4;

Returns

Type	Description
`int`	The count of experimentIds.

getExperimentIdsList()

public abstract List<String> getExperimentIdsList()

repeated string experiment_ids = 4;

Returns

Type	Description
`List<String>`	A list containing the experimentIds.

getFilter()

public abstract String getFilter()

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string filter = 16;

Returns

Type	Description
`String`	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

string filter = 16;

Returns

Type	Description
`ByteString`	The bytes for filter.

getOffset()

public abstract 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). See SearchRequest.offset for definition. If this field is negative, an INVALID_ARGUMENT is returned. This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

int32 offset = 18;

Returns

Type	Description
`int`	The offset.

getOrderBy()

public abstract String getOrderBy()

The order in which products are returned. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

string order_by = 17;

Returns

Type	Description
`String`	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

string order_by = 17;

Returns

Type	Description
`ByteString`	The bytes for orderBy.

getPageCategories(int index)

public abstract String getPageCategories(int index)

The categories associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"]. Required for category-page-view events. At least one of search_query or page_categories is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

repeated string page_categories = 11;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The pageCategories at the given index.

getPageCategoriesBytes(int index)

public abstract ByteString getPageCategoriesBytes(int index)

repeated string page_categories = 11;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the pageCategories at the given index.

getPageCategoriesCount()

public abstract int getPageCategoriesCount()

repeated string page_categories = 11;

Returns

Type	Description
`int`	The count of pageCategories.

getPageCategoriesList()

public abstract List<String> getPageCategoriesList()

repeated string page_categories = 11;

Returns

Type	Description
`List<String>`	A list containing the pageCategories.

getPageViewId()

public abstract String getPageViewId()

A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The pageViewId property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.

string page_view_id = 15;

Returns

Type	Description
`String`	The pageViewId.

getPageViewIdBytes()

public abstract ByteString getPageViewIdBytes()

string page_view_id = 15;

Returns

Type	Description
`ByteString`	The bytes for pageViewId.

getProductDetails(int index)

public abstract ProductDetail getProductDetails(int index)

The main product details related to the event. This field is optional except for the following event types:

add-to-cart
detail-page-view
purchase-complete In a search event, this field represents the products returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different product_details is desired. The end user may have not finished browsing the whole page yet.

repeated .google.cloud.retail.v2.ProductDetail product_details = 6;

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`ProductDetail`

getProductDetailsCount()

public abstract int getProductDetailsCount()

The main product details related to the event. This field is optional except for the following event types:

add-to-cart
detail-page-view
purchase-complete In a search event, this field represents the products returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different product_details is desired. The end user may have not finished browsing the whole page yet.

repeated .google.cloud.retail.v2.ProductDetail product_details = 6;

Returns

Type	Description
`int`

getProductDetailsList()

public abstract List<ProductDetail> getProductDetailsList()

The main product details related to the event. This field is optional except for the following event types:

add-to-cart
detail-page-view
purchase-complete In a search event, this field represents the products returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different product_details is desired. The end user may have not finished browsing the whole page yet.

repeated .google.cloud.retail.v2.ProductDetail product_details = 6;

Returns

Type	Description
`List<ProductDetail>`

getProductDetailsOrBuilder(int index)

public abstract ProductDetailOrBuilder getProductDetailsOrBuilder(int index)

The main product details related to the event. This field is optional except for the following event types:

add-to-cart
detail-page-view
purchase-complete In a search event, this field represents the products returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different product_details is desired. The end user may have not finished browsing the whole page yet.

repeated .google.cloud.retail.v2.ProductDetail product_details = 6;

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`ProductDetailOrBuilder`

getProductDetailsOrBuilderList()

public abstract List<? extends ProductDetailOrBuilder> getProductDetailsOrBuilderList()

The main product details related to the event. This field is optional except for the following event types:

add-to-cart
detail-page-view
purchase-complete In a search event, this field represents the products returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new search event with different product_details is desired. The end user may have not finished browsing the whole page yet.

repeated .google.cloud.retail.v2.ProductDetail product_details = 6;

Returns

Type	Description
`List<? extends com.google.cloud.retail.v2.ProductDetailOrBuilder>`

getPurchaseTransaction()

public abstract PurchaseTransaction getPurchaseTransaction()

A transaction represents the entire purchase transaction. Required for purchase-complete events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

.google.cloud.retail.v2.PurchaseTransaction purchase_transaction = 9;

Returns

Type	Description
`PurchaseTransaction`	The purchaseTransaction.

getPurchaseTransactionOrBuilder()

public abstract PurchaseTransactionOrBuilder getPurchaseTransactionOrBuilder()

A transaction represents the entire purchase transaction. Required for purchase-complete events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

.google.cloud.retail.v2.PurchaseTransaction purchase_transaction = 9;

Returns

Type	Description
`PurchaseTransactionOrBuilder`

getReferrerUri()

public abstract String getReferrerUri()

The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.

string referrer_uri = 14;

Returns

Type	Description
`String`	The referrerUri.

getReferrerUriBytes()

public abstract ByteString getReferrerUriBytes()

The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.

string referrer_uri = 14;

Returns

Type	Description
`ByteString`	The bytes for referrerUri.

getSearchQuery()

public abstract String getSearchQuery()

The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query or page_categories is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

string search_query = 10;

Returns

Type	Description
`String`	The searchQuery.

getSearchQueryBytes()

public abstract ByteString getSearchQueryBytes()

string search_query = 10;

Returns

Type	Description
`ByteString`	The bytes for searchQuery.

getSessionId()

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

If user has no activity for 30 min, a new session_id should be assigned.
The session_id should be unique across users, suggest use uuid or add visitor_id as prefix.

string session_id = 21;

Returns

Type	Description
`String`	The sessionId.

getSessionIdBytes()

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

If user has no activity for 30 min, a new session_id should be assigned.
The session_id should be unique across users, suggest use uuid or add visitor_id as prefix.

string session_id = 21;

Returns

Type	Description
`ByteString`	The bytes for sessionId.

getUri()

public abstract String getUri()

Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.

string uri = 13;

Returns

Type	Description
`String`	The uri.

getUriBytes()

public abstract ByteString getUriBytes()

string uri = 13;

Returns

Type	Description
`ByteString`	The bytes for uri.

getUserInfo()

public abstract UserInfo getUserInfo()

User information.

.google.cloud.retail.v2.UserInfo user_info = 12;

Returns

Type	Description
`UserInfo`	The userInfo.

getUserInfoOrBuilder()

public abstract UserInfoOrBuilder getUserInfoOrBuilder()

User information.

.google.cloud.retail.v2.UserInfo user_info = 12;

Returns

Type	Description
`UserInfoOrBuilder`

getVisitorId()

public abstract 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 for this field.

string visitor_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`String`	The visitorId.

getVisitorIdBytes()

public abstract ByteString getVisitorIdBytes()

string visitor_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
`ByteString`	The bytes for visitorId.

hasCompletionDetail()

public abstract boolean hasCompletionDetail()

The main auto-completion details related to the event. This field should be set for search event when autocomplete function is enabled and the user clicks a suggestion for search.

.google.cloud.retail.v2.CompletionDetail completion_detail = 22;

Returns

Type	Description
`boolean`	Whether the completionDetail field is set.

hasEventTime()

public abstract boolean hasEventTime()

Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.

.google.protobuf.Timestamp event_time = 3;

Returns

Type	Description
`boolean`	Whether the eventTime field is set.

hasPurchaseTransaction()

public abstract boolean hasPurchaseTransaction()

A transaction represents the entire purchase transaction. Required for purchase-complete events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

.google.cloud.retail.v2.PurchaseTransaction purchase_transaction = 9;

Returns

Type	Description
`boolean`	Whether the purchaseTransaction field is set.

hasUserInfo()

public abstract boolean hasUserInfo()

User information.

.google.cloud.retail.v2.UserInfo user_info = 12;

Returns

Type	Description
`boolean`	Whether the userInfo field is set.