Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaUserInfo
- 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
Information of an end user.
Instance Attribute Summary collapse
-
#user_agent ⇒ String
User agent as included in the HTTP header.
-
#user_id ⇒ String
Highly recommended for logged-in users.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaUserInfo
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaUserInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaUserInfo
Returns a new instance of GoogleCloudDiscoveryengineV1alphaUserInfo.
1609 1610 1611 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1609 def initialize(**args) update!(**args) end |
Instance Attribute Details
#user_agent ⇒ String
User agent as included in the HTTP header. Required for getting SearchResponse.
sponsored_results. The field must be a UTF-8 encoded string with a length
limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT
error is returned.
This should not be set when using the client side event reporting with GTM or
JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.
direct_user_request is set.
Corresponds to the JSON property userAgent
1597 1598 1599 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1597 def user_agent @user_agent end |
#user_id ⇒ String
Highly recommended for logged-in users. Unique identifier for logged-in user,
such as a user name. Don't set for anonymous users. Always use a hashed value
for this ID. Don't 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.
Corresponds to the JSON property userId
1607 1608 1609 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1607 def user_id @user_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1614 1615 1616 1617 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1614 def update!(**args) @user_agent = args[:user_agent] if args.key?(:user_agent) @user_id = args[:user_id] if args.key?(:user_id) end |