Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserEvent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1UserEvent

Returns a new instance of GoogleCloudDiscoveryengineV1UserEvent.



8858
8859
8860
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8858

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#attributes ⇒ Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CustomAttribute>

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

Returns:



8696
8697
8698
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8696

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

Returns:

  • (String) 


8713
8714
8715
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8713

def attribution_token
  @attribution_token
end

#completion_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CompletionInfo

Detailed completion information including completion attribution token and clicked completion info. Corresponds to the JSON property completionInfo

Returns:



8719
8720
8721
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8719

def completion_info
  @completion_info
end

#data_store ⇒ 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. Corresponds to the JSON propertydataStore`

Returns:

  • (String) 


8728
8729
8730
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8728

def data_store
  @data_store
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

Returns:

  • (Boolean) 


8738
8739
8740
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8738

def direct_user_request
  @direct_user_request
end

#documents ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo>

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

Returns:



8750
8751
8752
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8750

def documents
  @documents
end

#engine ⇒ 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. Corresponds to the JSON propertyengine`

Returns:

  • (String) 


8758
8759
8760
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8758

def engine
  @engine
end

#event_time ⇒ String

Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. Corresponds to the JSON property eventTime

Returns:

  • (String) 


8764
8765
8766
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8764

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

Returns:

  • (String) 


8776
8777
8778
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8776

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 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. Corresponds to the JSON property filter

Returns:

  • (String) 


8789
8790
8791
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8789

def filter
  @filter
end

#media_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1MediaInfo

Media-specific user event information. Corresponds to the JSON property mediaInfo

Returns:



8794
8795
8796
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8794

def media_info
  @media_info
end

#page_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PageInfo

Detailed page information. Corresponds to the JSON property pageInfo

Returns:



8799
8800
8801
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8799

def page_info
  @page_info
end

#panel ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PanelInfo

Detailed panel information associated with a user event. Corresponds to the JSON property panel

Returns:



8804
8805
8806
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8804

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

Returns:

  • (Array<String>) 


8810
8811
8812
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8810

def promotion_ids
  @promotion_ids
end

#search_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchInfo

Detailed search information. Corresponds to the JSON property searchInfo

Returns:



8815
8816
8817
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8815

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

Returns:

  • (String) 


8825
8826
8827
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8825

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. Corresponds to the JSON property tagIds

Returns:

  • (Array<String>) 


8832
8833
8834
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8832

def tag_ids
  @tag_ids
end

#transaction_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1TransactionInfo

A transaction represents the entire purchase transaction. Corresponds to the JSON property transactionInfo

Returns:



8837
8838
8839
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8837

def transaction_info
  @transaction_info
end

#user_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserInfo

Information of an end user. Corresponds to the JSON property userInfo

Returns:



8842
8843
8844
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8842

def 
  @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

Returns:

  • (String) 


8856
8857
8858
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8856

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8863

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)
  @data_store = args[:data_store] if args.key?(:data_store)
  @direct_user_request = args[:direct_user_request] if args.key?(:direct_user_request)
  @documents = args[:documents] if args.key?(:documents)
  @engine = args[:engine] if args.key?(:engine)
  @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