Recommendations AI v1beta1 API - Class UserInfo (2.0.0-beta05)

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

Reference documentation and code samples for the Recommendations AI v1beta1 API class UserInfo.

Information of end users.

Inheritance

object > UserInfo

Implements

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

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

UserInfo()

public UserInfo()

UserInfo(UserInfo)

public UserInfo(UserInfo other)

Parameter
Name	Description
`other`	`UserInfo`

Properties

DirectUserRequest

public bool DirectUserRequest { get; set; }

Optional. Indicates if the request is made directly from the end user in which case the user_agent and ip_address fields can be populated from the HTTP request. This should not be set when using the javascript pixel. 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).

Property Value
Type	Description
`bool`

IpAddress

public string IpAddress { get; set; }

Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should not be set when using the javascript pixel or if direct_user_request is set. Used to extract location information for personalization.

Property Value
Type	Description
`string`

UserAgent

public string UserAgent { get; set; }

Optional. User agent as included in the HTTP header. UTF-8 encoded string with a length limit of 1 KiB.

This should not be set when using the JavaScript pixel or if directUserRequest is set.

Property Value
Type	Description
`string`

UserId

public string UserId { get; set; }

Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.

Property Value
Type	Description
`string`

VisitorId

public string VisitorId { get; set; }

Required. A unique identifier for tracking visitors with a length limit of 128 bytes.

For example, this could be implemented with a 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. Maximum length 128 bytes. Cannot be empty.

Property Value
Type	Description
`string`