Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserEvent
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb
Overview
UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
Instance Attribute Summary collapse
-
#attributes ⇒ Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomAttribute>
Extra user event features to include in the recommendation model.
-
#attribution_token ⇒ String
Token to attribute an API response to user action(s) to trigger the event.
-
#completion_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompletionInfo
Detailed completion information including completion attribution token and clicked completion info.
-
#direct_user_request ⇒ Boolean
(also: #direct_user_request?)
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.
-
#documents ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentInfo>
List of Documents associated with this user event.
-
#event_time ⇒ String
Only required for UserEventService.ImportUserEvents method.
-
#event_type ⇒ String
Required.
-
#filter ⇒ String
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
-
#media_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaMediaInfo
Media-specific user event information.
-
#page_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPageInfo
Detailed page information.
-
#panel ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPanelInfo
Detailed panel information associated with a user event.
-
#promotion_ids ⇒ Array<String>
The promotion IDs if this is an event associated with promotions.
-
#search_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchInfo
Detailed search information.
-
#session_id ⇒ String
A unique identifier for tracking a visitor session with a length limit of 128 bytes.
-
#tag_ids ⇒ Array<String>
A list of identifiers for the independent experiment groups this user event belongs to.
-
#transaction_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTransactionInfo
A transaction represents the entire purchase transaction.
-
#user_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo
Information of an end user.
-
#user_pseudo_id ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaUserEvent
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaUserEvent.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaUserEvent
Returns a new instance of GoogleCloudDiscoveryengineV1alphaUserEvent.
4084 4085 4086 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4084 def initialize(**args) update!(**args) end |
Instance Attribute Details
#attributes ⇒ Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomAttribute>
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.
Corresponds to the JSON property attributes
3938 3939 3940 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3938 def attributes @attributes end |
#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: *
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.
Corresponds to the JSON property attributionToken
3955 3956 3957 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3955 def attribution_token @attribution_token end |
#completion_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCompletionInfo
Detailed completion information including completion attribution token and
clicked completion info.
Corresponds to the JSON property completionInfo
3961 3962 3963 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3961 def completion_info @completion_info end |
#direct_user_request ⇒ Boolean Also known as: direct_user_request?
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.
Corresponds to the JSON property directUserRequest
3971 3972 3973 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3971 def direct_user_request @direct_user_request end |
#documents ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentInfo>
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.
Corresponds to the JSON property documents
3983 3984 3985 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3983 def documents @documents end |
#event_time ⇒ String
Only required for UserEventService.ImportUserEvents method. Timestamp of when
the user event happened.
Corresponds to the JSON property eventTime
3989 3990 3991 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3989 def event_time @event_time end |
#event_type ⇒ 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.
Corresponds to the JSON property eventType
4001 4002 4003 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4001 def event_type @event_type end |
#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 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.
Corresponds to the JSON property filter
4015 4016 4017 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4015 def filter @filter end |
#media_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaMediaInfo
Media-specific user event information.
Corresponds to the JSON property mediaInfo
4020 4021 4022 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4020 def media_info @media_info end |
#page_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPageInfo
Detailed page information.
Corresponds to the JSON property pageInfo
4025 4026 4027 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4025 def page_info @page_info end |
#panel ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPanelInfo
Detailed panel information associated with a user event.
Corresponds to the JSON property panel
4030 4031 4032 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4030 def panel @panel end |
#promotion_ids ⇒ Array<String>
The promotion IDs if this is an event associated with promotions. Currently,
this field is restricted to at most one ID.
Corresponds to the JSON property promotionIds
4036 4037 4038 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4036 def promotion_ids @promotion_ids end |
#search_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchInfo
Detailed search information.
Corresponds to the JSON property searchInfo
4041 4042 4043 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4041 def search_info @search_info end |
#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.
Corresponds to the JSON property sessionId
4051 4052 4053 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4051 def session_id @session_id end |
#tag_ids ⇒ 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 on the customer end.
Corresponds to the JSON property tagIds
4058 4059 4060 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4058 def tag_ids @tag_ids end |
#transaction_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTransactionInfo
A transaction represents the entire purchase transaction.
Corresponds to the JSON property transactionInfo
4063 4064 4065 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4063 def transaction_info @transaction_info end |
#user_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo
Information of an end user.
Corresponds to the JSON property userInfo
4068 4069 4070 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4068 def user_info @user_info end |
#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.
Corresponds to the JSON property userPseudoId
4082 4083 4084 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4082 def user_pseudo_id @user_pseudo_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4089 def update!(**args) @attributes = args[:attributes] if args.key?(:attributes) @attribution_token = args[:attribution_token] if args.key?(:attribution_token) @completion_info = args[:completion_info] if args.key?(:completion_info) @direct_user_request = args[:direct_user_request] if args.key?(:direct_user_request) @documents = args[:documents] if args.key?(:documents) @event_time = args[:event_time] if args.key?(:event_time) @event_type = args[:event_type] if args.key?(:event_type) @filter = args[:filter] if args.key?(:filter) @media_info = args[:media_info] if args.key?(:media_info) @page_info = args[:page_info] if args.key?(:page_info) @panel = args[:panel] if args.key?(:panel) @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids) @search_info = args[:search_info] if args.key?(:search_info) @session_id = args[:session_id] if args.key?(:session_id) @tag_ids = args[:tag_ids] if args.key?(:tag_ids) @transaction_info = args[:transaction_info] if args.key?(:transaction_info) @user_info = args[:user_info] if args.key?(:user_info) @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id) end |