Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserEvent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/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) ⇒ GoogleCloudDiscoveryengineV1betaUserEvent

Returns a new instance of GoogleCloudDiscoveryengineV1betaUserEvent.



20612
20613
20614
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20612

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

Instance Attribute Details

#attributes ⇒ Hash<String,Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCustomAttribute>

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:



20433
20434
20435
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20433

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) 


20450
20451
20452
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20450

def attribution_token
  @attribution_token
end

#completion_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCompletionInfo

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

Returns:



20456
20457
20458
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20456

def completion_info
  @completion_info
end

#conversion_type ⇒ String

Optional. Conversion type. Required if UserEvent.event_type is conversion. This is a customer-defined conversion name in lowercase letters or numbers separated by "-", such as "watch", "good-visit" etc. Do not set the field if UserEvent.event_type is not conversion. This mixes the custom conversion event with predefined events like search, view-item etc. Corresponds to the JSON property conversionType

Returns:

  • (String) 


20465
20466
20467
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20465

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


20474
20475
20476
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20474

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) 


20484
20485
20486
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20484

def direct_user_request
  @direct_user_request
end

#documents ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentInfo>

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:



20496
20497
20498
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20496

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) 


20504
20505
20506
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20504

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) 


20510
20511
20512
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20510

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 * add-feedback: Add a user feedback. 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. Custom conversion value:

  • conversion: Customer defined conversion event. Corresponds to the JSON property eventType

Returns:

  • (String) 


20524
20525
20526
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20524

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) 


20537
20538
20539
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20537

def filter
  @filter
end

#media_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaMediaInfo

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

Returns:



20542
20543
20544
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20542

def media_info
  @media_info
end

#page_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPageInfo

Detailed page information. Corresponds to the JSON property pageInfo

Returns:



20547
20548
20549
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20547

def page_info
  @page_info
end

#panel ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPanelInfo

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

Returns:



20552
20553
20554
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20552

def panel
  @panel
end

#panels ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPanelInfo>

Optional. List of panels associated with this event. Used for page-level impression data. Corresponds to the JSON property panels

Returns:



20558
20559
20560
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20558

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


20564
20565
20566
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20564

def promotion_ids
  @promotion_ids
end

#search_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchInfo

Detailed search information. Corresponds to the JSON property searchInfo

Returns:



20569
20570
20571
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20569

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) 


20579
20580
20581
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20579

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


20586
20587
20588
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20586

def tag_ids
  @tag_ids
end

#transaction_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTransactionInfo

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

Returns:



20591
20592
20593
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20591

def transaction_info
  @transaction_info
end

#user_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaUserInfo

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

Returns:



20596
20597
20598
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20596

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) 


20610
20611
20612
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20610

def user_pseudo_id
  @user_pseudo_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20617
20618
20619
20620
20621
20622
20623
20624
20625
20626
20627
20628
20629
20630
20631
20632
20633
20634
20635
20636
20637
20638
20639
20640
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 20617

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)
  @conversion_type = args[:conversion_type] if args.key?(:conversion_type)
  @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)
  @panels = args[:panels] if args.key?(:panels)
  @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