Retail V2 API - Class Google::Cloud::Retail::V2::UserEvent (v1.2.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::UserEvent.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#attributes

def attributes() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}) — 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.

#attributes=

def attributes=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}

Parameter

value (::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}) — 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.

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}) — 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.

#attribution_token

def attribution_token() -> ::String

Returns

(::String) — 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.

#attribution_token=

def attribution_token=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#cart_id

def cart_id() -> ::String

Returns

(::String) — 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.

#cart_id=

def cart_id=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#completion_detail

def completion_detail() -> ::Google::Cloud::Retail::V2::CompletionDetail

Returns

(::Google::Cloud::Retail::V2::CompletionDetail) — 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.

#completion_detail=

def completion_detail=(value) -> ::Google::Cloud::Retail::V2::CompletionDetail

Parameter

value (::Google::Cloud::Retail::V2::CompletionDetail) — 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.

Returns

(::Google::Cloud::Retail::V2::CompletionDetail) — 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.

#entity

def entity() -> ::String

Returns

(::String) — The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results.

#entity=

def entity=(value) -> ::String

Parameter

value (::String) — The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results.

Returns

(::String) — The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. We recommend that you set this field to get better per-entity search, completion, and prediction results.

#event_time

def event_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.

#event_time=

def event_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.

Returns

(::Google::Protobuf::Timestamp) — Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.

#event_type

def event_type() -> ::String

Returns

(::String) —
Required. User event type. Allowed values are:
- add-to-cart: Products being added to cart.
- remove-from-cart: Products being removed from 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.

#event_type=

def event_type=(value) -> ::String

Parameter

value (::String) —
Required. User event type. Allowed values are:
- add-to-cart: Products being added to cart.
- remove-from-cart: Products being removed from 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.

Returns

(::String) —
Required. User event type. Allowed values are:
- add-to-cart: Products being added to cart.
- remove-from-cart: Products being removed from 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.

#experiment_ids

def experiment_ids() -> ::Array<::String>

Returns

(::Array<::String>) — 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).

#experiment_ids=

def experiment_ids=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — 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).

Returns

(::Array<::String>) — 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).

#filter

def filter() -> ::String

Returns

(::String) — 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.

#filter=

def filter=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#offset

def offset() -> ::Integer

Returns

(::Integer) — 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.

#offset=

def offset=(value) -> ::Integer

Parameter

value (::Integer) — 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.

Returns

(::Integer) — 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.

#order_by

def order_by() -> ::String

Returns

(::String) — 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.

#order_by=

def order_by=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#page_categories

def page_categories() -> ::Array<::String>

Returns

(::Array<::String>) — 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.

#page_categories=

def page_categories=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — 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.

Returns

(::Array<::String>) — 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.

#page_view_id

def page_view_id() -> ::String

Returns

(::String) — 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.

#page_view_id=

def page_view_id=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#product_details

def product_details() -> ::Array<::Google::Cloud::Retail::V2::ProductDetail>

Returns

(::Array<::Google::Cloud::Retail::V2::ProductDetail>) — 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.

#product_details=

def product_details=(value) -> ::Array<::Google::Cloud::Retail::V2::ProductDetail>

Parameter

value (::Array<::Google::Cloud::Retail::V2::ProductDetail>) — 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.

Returns

(::Array<::Google::Cloud::Retail::V2::ProductDetail>) — 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.

#purchase_transaction

def purchase_transaction() -> ::Google::Cloud::Retail::V2::PurchaseTransaction

Returns

(::Google::Cloud::Retail::V2::PurchaseTransaction) — 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.

#purchase_transaction=

def purchase_transaction=(value) -> ::Google::Cloud::Retail::V2::PurchaseTransaction

Parameter

value (::Google::Cloud::Retail::V2::PurchaseTransaction) — 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.

Returns

(::Google::Cloud::Retail::V2::PurchaseTransaction) — 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.

#referrer_uri

def referrer_uri() -> ::String

Returns

(::String) — 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.

#referrer_uri=

def referrer_uri=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#search_query

def search_query() -> ::String

Returns

(::String) — 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.

#search_query=

def search_query=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#session_id

def session_id() -> ::String

Returns

(::String) —
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:
1. If user has no activity for 30 min, a new session_id should be assigned.
2. The session_id should be unique across users, suggest use uuid or add visitor_id as prefix.

#session_id=

def session_id=(value) -> ::String

Parameter

value (::String) —
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:
1. If user has no activity for 30 min, a new session_id should be assigned.
2. The session_id should be unique across users, suggest use uuid or add visitor_id as prefix.

Returns

(::String) —
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:
1. If user has no activity for 30 min, a new session_id should be assigned.
2. The session_id should be unique across users, suggest use uuid or add visitor_id as prefix.

#uri

def uri() -> ::String

Returns

(::String) — 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.

#uri=

def uri=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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_info

def user_info() -> ::Google::Cloud::Retail::V2::UserInfo

Returns

(::Google::Cloud::Retail::V2::UserInfo) — User information.

#user_info=

def user_info=(value) -> ::Google::Cloud::Retail::V2::UserInfo

Parameter

value (::Google::Cloud::Retail::V2::UserInfo) — User information.

Returns

(::Google::Cloud::Retail::V2::UserInfo) — User information.

#visitor_id

def visitor_id() -> ::String

Returns

(::String) — 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.

#visitor_id=

def visitor_id=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.