Discovery Engine v1 API - Class UserInfo (1.6.0)

public sealed class UserInfo : IMessage<UserInfo>, IEquatable<UserInfo>, IDeepCloneable<UserInfo>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class UserInfo.

Information of an end user.

Inheritance

object > UserInfo

Implements

IMessage UserInfo, IEquatable UserInfo, IDeepCloneable UserInfo, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

UserInfo()

public UserInfo()

UserInfo(UserInfo)

public UserInfo(UserInfo other)

Parameter
Name	Description
`other`	`UserInfo`

Properties

UserAgent

public string UserAgent { get; set; }

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][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent] or if [UserEvent.direct_user_request][google.cloud.discoveryengine.v1.UserEvent.direct_user_request] is set.

Property Value
Type	Description
`string`

UserId

public string UserId { get; set; }

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.

Property Value
Type	Description
`string`