Class: Google::Cloud::DiscoveryEngine::V1::UserInfo

Inherits:

Object

Object
Google::Cloud::DiscoveryEngine::V1::UserInfo

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/discoveryengine/v1/common.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 Attribute Details

#user_agent ⇒ `::String`

Returns User agent as included in the HTTP header.

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.

Returns:

(::String) —
User agent as included in the HTTP header.

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.

# File 'proto_docs/google/cloud/discoveryengine/v1/common.rb', line 99

class UserInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_id ⇒ `::String`

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