Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class UserEvent.
UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
Generated from protobuf message google.cloud.discoveryengine.v1beta.UserEvent
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: Generic values: * |
↳ user_pseudo_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. Do not 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. |
↳ event_time |
Google\Protobuf\Timestamp
Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. |
↳ user_info |
Google\Cloud\DiscoveryEngine\V1beta\UserInfo
Information about the end user. |
↳ direct_user_request |
bool
Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent. |
↳ 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 session_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 UserEvent.user_pseudo_id as prefix. |
↳ page_info |
Google\Cloud\DiscoveryEngine\V1beta\PageInfo
Page metadata such as categories and other critical information for certain event types such as |
↳ attribution_token |
string
Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * PredictResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. * CompleteQueryResponse.attribution_token for events that are the result of CompletionService.CompleteQuery. This token enables us to accurately attribute page view or conversion completion 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. |
↳ filter |
string
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for |
↳ documents |
array<Google\Cloud\DiscoveryEngine\V1beta\DocumentInfo>
List of Documents associated with this user event. This field is optional except for the following event types: * |
↳ panel |
Google\Cloud\DiscoveryEngine\V1beta\PanelInfo
Panel metadata associated with this user event. |
↳ search_info |
Google\Cloud\DiscoveryEngine\V1beta\SearchInfo
Search API details related to the event. This field should be set for |
↳ completion_info |
Google\Cloud\DiscoveryEngine\V1beta\CompletionInfo
CompleteQuery API details related to the event. This field should be set for |
↳ transaction_info |
Google\Cloud\DiscoveryEngine\V1beta\TransactionInfo
The transaction metadata (if any) associated with this user event. |
↳ tag_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 on the customer end. |
↳ promotion_ids |
array
The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. |
↳ attributes |
array|Google\Protobuf\Internal\MapField
Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. 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 Discovery Engine 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 |
↳ media_info |
Google\Cloud\DiscoveryEngine\V1beta\MediaInfo
Media-specific info. |
getEventType
Required. User event type. Allowed values are: Generic values:
search
: Search for Documents.view-item
: Detailed page view of a Document.view-item-list
: View of a panel or ordered list of Documents.view-home-page
: View of the home page.view-category-page
: View of a category page, e.g. Home > Men > Jeans Retail-related values:add-to-cart
: Add an item(s) to cart, e.g. in Retail online shoppingpurchase
: Purchase an item(s) Media-related values:media-play
: Start/resume watching a video, playing a song, etc.media-complete
: Finished or stopped midway through a video, song, etc.
Returns | |
---|---|
Type | Description |
string |
setEventType
Required. User event type. Allowed values are: Generic values:
search
: Search for Documents.view-item
: Detailed page view of a Document.view-item-list
: View of a panel or ordered list of Documents.view-home-page
: View of the home page.view-category-page
: View of a category page, e.g. Home > Men > Jeans Retail-related values:add-to-cart
: Add an item(s) to cart, e.g. in Retail online shoppingpurchase
: Purchase an item(s) Media-related values:media-play
: Start/resume watching a video, playing a song, etc.media-complete
: Finished or stopped midway through a video, song, etc.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getUserPseudoId
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. Do not 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 |
setUserPseudoId
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. Do not 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 |
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 |
getUserInfo
Information about the end user.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1beta\UserInfo|null |
hasUserInfo
clearUserInfo
setUserInfo
Information about the end user.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1beta\UserInfo
|
Returns | |
---|---|
Type | Description |
$this |
getDirectUserRequest
Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request.
This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
Returns | |
---|---|
Type | Description |
bool |
setDirectUserRequest
Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request.
This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
Parameter | |
---|---|
Name | Description |
var |
bool
|
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 session_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 UserEvent.user_pseudo_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 session_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 UserEvent.user_pseudo_id as prefix.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageInfo
Page metadata such as categories and other critical information for certain
event types such as view-category-page
.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1beta\PageInfo|null |
hasPageInfo
clearPageInfo
setPageInfo
Page metadata such as categories and other critical information for certain
event types such as view-category-page
.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1beta\PageInfo
|
Returns | |
---|---|
Type | Description |
$this |
getAttributionToken
Token to attribute an API response to user action(s) to trigger the event.
Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of:
- PredictResponse.attribution_token for events that are the result of RecommendationService.Recommend.
- SearchResponse.attribution_token for events that are the result of SearchService.Search.
- CompleteQueryResponse.attribution_token for events that are the result of CompletionService.CompleteQuery. This token enables us to accurately attribute page view or conversion completion 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
Token to attribute an API response to user action(s) to trigger the event.
Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of:
- PredictResponse.attribution_token for events that are the result of RecommendationService.Recommend.
- SearchResponse.attribution_token for events that are the result of SearchService.Search.
- CompleteQueryResponse.attribution_token for events that are the result of CompletionService.CompleteQuery. This token enables us to accurately attribute page view or conversion completion 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 |
getFilter
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
One example is for search
events, the associated
SearchRequest may
contain a filter expression in
SearchRequest.filter
conforming to https://google.aip.dev/160#filtering.
Similarly, for view-item-list
events that are generated from a
RecommendationService.RecommendRequest, this field may be populated
directly from RecommendationService.RecommendRequest.filter conforming
to https://google.aip.dev/160#filtering.
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 documents being filtered.
One example is for search
events, the associated
SearchRequest may
contain a filter expression in
SearchRequest.filter
conforming to https://google.aip.dev/160#filtering.
Similarly, for view-item-list
events that are generated from a
RecommendationService.RecommendRequest, this field may be populated
directly from RecommendationService.RecommendRequest.filter conforming
to https://google.aip.dev/160#filtering.
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 |
getDocuments
List of Documents associated with this user event.
This field is optional except for the following event types:
view-item
add-to-cart
purchase
media-play
media-complete
In asearch
event, this field represents the documents 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 newsearch
event with different UserEvent.documents is desired.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setDocuments
List of Documents associated with this user event.
This field is optional except for the following event types:
view-item
add-to-cart
purchase
media-play
media-complete
In asearch
event, this field represents the documents 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 newsearch
event with different UserEvent.documents is desired.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\DiscoveryEngine\V1beta\DocumentInfo>
|
Returns | |
---|---|
Type | Description |
$this |
getPanel
Panel metadata associated with this user event.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1beta\PanelInfo|null |
hasPanel
clearPanel
setPanel
Panel metadata associated with this user event.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1beta\PanelInfo
|
Returns | |
---|---|
Type | Description |
$this |
getSearchInfo
Search API details related to the event.
This field should be set for search
event.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1beta\SearchInfo|null |
hasSearchInfo
clearSearchInfo
setSearchInfo
Search API details related to the event.
This field should be set for search
event.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1beta\SearchInfo
|
Returns | |
---|---|
Type | Description |
$this |
getCompletionInfo
CompleteQuery API 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 |
Google\Cloud\DiscoveryEngine\V1beta\CompletionInfo|null |
hasCompletionInfo
clearCompletionInfo
setCompletionInfo
CompleteQuery API 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 |
Google\Cloud\DiscoveryEngine\V1beta\CompletionInfo
|
Returns | |
---|---|
Type | Description |
$this |
getTransactionInfo
The transaction metadata (if any) associated with this user event.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1beta\TransactionInfo|null |
hasTransactionInfo
clearTransactionInfo
setTransactionInfo
The transaction metadata (if any) associated with this user event.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1beta\TransactionInfo
|
Returns | |
---|---|
Type | Description |
$this |
getTagIds
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 on the customer end.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setTagIds
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 on the customer end.
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getPromotionIds
The promotion IDs if this is an event associated with promotions.
Currently, this field is restricted to at most one ID.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setPromotionIds
The promotion IDs if this is an event associated with promotions.
Currently, this field is restricted to at most one ID.
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getAttributes
Extra user event features to include in the recommendation model.
These attributes must NOT contain data that needs to be parsed or processed
further, e.g. JSON or other encodings.
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 Discovery Engine 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.
These attributes must NOT contain data that needs to be parsed or processed
further, e.g. JSON or other encodings.
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 Discovery Engine 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 |
getMediaInfo
Media-specific info.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1beta\MediaInfo|null |
hasMediaInfo
clearMediaInfo
setMediaInfo
Media-specific info.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1beta\MediaInfo
|
Returns | |
---|---|
Type | Description |
$this |