Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::UserEvent (v1.3.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::UserEvent.

UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#attributes

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

Returns

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

#attributes=

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

Parameter

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

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

#attribution_token

def attribution_token() -> ::String

Returns

(::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:
- RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend.
- SearchResponse.attribution_token for events that are the result of SearchService.Search.
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 RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.

#attribution_token=

def attribution_token=(value) -> ::String

Parameter

value (::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:
- RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend.
- SearchResponse.attribution_token for events that are the result of SearchService.Search.
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 RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.

Returns

(::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:
- RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend.
- SearchResponse.attribution_token for events that are the result of SearchService.Search.
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 RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.

#completion_info

def completion_info() -> ::Google::Cloud::DiscoveryEngine::V1::CompletionInfo

Returns

(::Google::Cloud::DiscoveryEngine::V1::CompletionInfo) — CompletionService.CompleteQuery 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_info=

def completion_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::CompletionInfo

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::CompletionInfo) — CompletionService.CompleteQuery 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::DiscoveryEngine::V1::CompletionInfo) — CompletionService.CompleteQuery 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.

#data_store

def data_store() -> ::String

Returns

(::String) — The DataStore resource full name, of the form projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.

#data_store=

def data_store=(value) -> ::String

Parameter

value (::String) — The DataStore resource full name, of the form projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.

Returns

(::String) — The DataStore resource full name, of the form projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.

#direct_user_request

def direct_user_request() -> ::Boolean

Returns

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

#direct_user_request=

def direct_user_request=(value) -> ::Boolean

Parameter

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

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

#documents

def documents() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::DocumentInfo>

Returns

(::Array<::Google::Cloud::DiscoveryEngine::V1::DocumentInfo>) — 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 a search 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 new search event with different UserEvent.documents is desired.

#documents=

def documents=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::DocumentInfo>

Parameter

value (::Array<::Google::Cloud::DiscoveryEngine::V1::DocumentInfo>) — 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 a search 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 new search event with different UserEvent.documents is desired.

Returns

(::Array<::Google::Cloud::DiscoveryEngine::V1::DocumentInfo>) — 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 a search 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 new search event with different UserEvent.documents is desired.

#engine

def engine() -> ::String

Returns

(::String) — The Engine resource name, in the form of projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Optional. Only required for Engine produced user events. For example, user events from blended search.

#engine=

def engine=(value) -> ::String

Parameter

value (::String) — The Engine resource name, in the form of projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Optional. Only required for Engine produced user events. For example, user events from blended search.

Returns

(::String) — The Engine resource name, in the form of projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Optional. Only required for Engine produced user events. For example, user events from blended search.

#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:

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 shopping
- purchase: 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.

#event_type=

def event_type=(value) -> ::String

Parameter

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

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

#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 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 RecommendRequest, this field may be populated directly from 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.

#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 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 RecommendRequest, this field may be populated directly from 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

(::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 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 RecommendRequest, this field may be populated directly from 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.

#media_info

def media_info() -> ::Google::Cloud::DiscoveryEngine::V1::MediaInfo

Returns

(::Google::Cloud::DiscoveryEngine::V1::MediaInfo) — Media-specific info.

#media_info=

def media_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::MediaInfo

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::MediaInfo) — Media-specific info.

Returns

(::Google::Cloud::DiscoveryEngine::V1::MediaInfo) — Media-specific info.

#page_info

def page_info() -> ::Google::Cloud::DiscoveryEngine::V1::PageInfo

Returns

(::Google::Cloud::DiscoveryEngine::V1::PageInfo) — Page metadata such as categories and other critical information for certain event types such as view-category-page.

#page_info=

def page_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::PageInfo

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::PageInfo) — Page metadata such as categories and other critical information for certain event types such as view-category-page.

Returns

(::Google::Cloud::DiscoveryEngine::V1::PageInfo) — Page metadata such as categories and other critical information for certain event types such as view-category-page.

#panel

def panel() -> ::Google::Cloud::DiscoveryEngine::V1::PanelInfo

Returns

(::Google::Cloud::DiscoveryEngine::V1::PanelInfo) — Panel metadata associated with this user event.

#panel=

def panel=(value) -> ::Google::Cloud::DiscoveryEngine::V1::PanelInfo

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::PanelInfo) — Panel metadata associated with this user event.

Returns

(::Google::Cloud::DiscoveryEngine::V1::PanelInfo) — Panel metadata associated with this user event.

#promotion_ids

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

Returns

(::Array<::String>) — The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.

#promotion_ids=

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

Parameter

value (::Array<::String>) — The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.

Returns

(::Array<::String>) — The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.

#search_info

def search_info() -> ::Google::Cloud::DiscoveryEngine::V1::SearchInfo

Returns

(::Google::Cloud::DiscoveryEngine::V1::SearchInfo) — SearchService.Search details related to the event.

This field should be set for search event.

#search_info=

def search_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchInfo

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::SearchInfo) — SearchService.Search details related to the event.

This field should be set for search event.

Returns

(::Google::Cloud::DiscoveryEngine::V1::SearchInfo) — SearchService.Search details related to the event.

This field should be set for search event.

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

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

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

#tag_ids

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

#tag_ids=

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

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.

#transaction_info

def transaction_info() -> ::Google::Cloud::DiscoveryEngine::V1::TransactionInfo

Returns

(::Google::Cloud::DiscoveryEngine::V1::TransactionInfo) — The transaction metadata (if any) associated with this user event.

#transaction_info=

def transaction_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::TransactionInfo

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::TransactionInfo) — The transaction metadata (if any) associated with this user event.

Returns

(::Google::Cloud::DiscoveryEngine::V1::TransactionInfo) — The transaction metadata (if any) associated with this user event.

#user_info

def user_info() -> ::Google::Cloud::DiscoveryEngine::V1::UserInfo

Returns

(::Google::Cloud::DiscoveryEngine::V1::UserInfo) — Information about the end user.

#user_info=

def user_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::UserInfo

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::UserInfo) — Information about the end user.

Returns

(::Google::Cloud::DiscoveryEngine::V1::UserInfo) — Information about the end user.

#user_pseudo_id

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

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.

#user_pseudo_id=

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

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

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