Class UserEvent (1.0.0)

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

Extra user event features to include in the recommendation model.

The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.

Highly recommended for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict]. This field enables accurate attribution of recommendation model performance.

The value must be a valid [PredictResponse.attribution_token][google.cloud.retail.v2.PredictResponse.attribution_token] for user events that are the result of [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].

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][google.cloud.retail.v2.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][google.cloud.retail.v2.PredictResponse.attribution_token] to this field.

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.

Only required for [UserEventService.ImportUserEvents][google.cloud.retail.v2.UserEventService.ImportUserEvents] method. Timestamp of when the user event happened.

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.
• purchase-complete: User finishing a purchase.
• search: Product search.
• shopping-cart-page-view: User viewing a shopping cart.

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

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, please 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. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

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.

The main product details related to the event.

This field is required 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 broswing 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][google.cloud.retail.v2.UserEvent.product_details] is desired. The end user may have not finished broswing the whole page yet.

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.

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.

The user's search query.

The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

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.

User information.

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.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.