Google Cloud Retail V2 Client - Class UserEvent (2.1.1)

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

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

Generated from protobuf message google.cloud.retail.v2.UserEvent

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ event_type 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.
↳ visitor_id 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.
↳ session_id 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.
↳ event_time Google\Protobuf\Timestamp

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

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).
↳ attribution_token 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.
↳ product_details array<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.
↳ completion_detail 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.
↳ attributes array|Google\Protobuf\Internal\MapField

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.
↳ cart_id 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.
↳ purchase_transaction 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.
↳ search_query 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.
↳ filter 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.
↳ order_by 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.
↳ offset int

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.
↳ page_categories array

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.
↳ user_info UserInfo

User information.
↳ uri 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.
↳ referrer_uri 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.
↳ page_view_id 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.
↳ entity 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.

getEventType

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
Type Description
string

setEventType

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.
Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setVisitorId

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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:

  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
Type Description
string

setSessionId

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getEventTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEventTime

clearEventTime

setEventTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getExperimentIds

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
Type Description
Google\Protobuf\Internal\RepeatedField

setExperimentIds

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

Parameter
Name Description
var string[]
Returns
Type Description
$this

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.

Returns
Type Description
string

setAttributionToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getProductDetails

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
Type Description
Google\Protobuf\Internal\RepeatedField

setProductDetails

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.
Parameter
Name Description
var array<ProductDetail>
Returns
Type Description
$this

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.

Returns
Type Description
CompletionDetail|null

hasCompletionDetail

clearCompletionDetail

setCompletionDetail

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.

Parameter
Name Description
var CompletionDetail
Returns
Type Description
$this

getAttributes

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
Type Description
Google\Protobuf\Internal\MapField

setAttributes

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.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

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.

Returns
Type Description
string

setCartId

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
PurchaseTransaction|null

hasPurchaseTransaction

clearPurchaseTransaction

setPurchaseTransaction

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.

Parameter
Name Description
var PurchaseTransaction
Returns
Type Description
$this

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.

Returns
Type Description
string

setSearchQuery

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setFilter

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setOrderBy

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
int

setOffset

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageCategories

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
Type Description
Google\Protobuf\Internal\RepeatedField

setPageCategories

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getUserInfo

User information.

Returns
Type Description
UserInfo|null

hasUserInfo

clearUserInfo

setUserInfo

User information.

Parameter
Name Description
var UserInfo
Returns
Type Description
$this

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.

Returns
Type Description
string

setUri

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setReferrerUri

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setPageViewId

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntity

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
Type Description
string

setEntity

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.

Parameter
Name Description
var string
Returns
Type Description
$this