Class UserInfo

Information of an end user.

Inheritance
System.Object
UserInfo
Implements
System.IEquatable<UserInfo>
Google.Protobuf.IBufferMessage
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Cloud.Retail.V2
Assembly: Google.Cloud.Retail.V2.dll
Syntax
public sealed class UserInfo : IMessage<UserInfo>, IEquatable<UserInfo>, IDeepCloneable<UserInfo>, IBufferMessage, IMessage

Constructors

UserInfo()

Declaration
public UserInfo()

UserInfo(UserInfo)

Declaration
public UserInfo(UserInfo other)
Parameters
Type Name Description
UserInfo other

Properties

DirectUserRequest

True if the request is made directly from the end user, in which case the [ip_address][google.cloud.retail.v2.UserInfo.ip_address] and [user_agent][google.cloud.retail.v2.UserInfo.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][google.cloud.retail.v2.UserEventService.CollectUserEvent].

Declaration
public bool DirectUserRequest { get; set; }
Property Value
Type Description
System.Boolean

IpAddress

The end user's IP address. This field is used to extract location information for personalization.

This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when using the JavaScript tag in [UserEventService.CollectUserEvent][google.cloud.retail.v2.UserEventService.CollectUserEvent] or if [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request] is set.

Declaration
public string IpAddress { get; set; }
Property Value
Type Description
System.String

UserAgent

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.retail.v2.UserEventService.CollectUserEvent] or if [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request] is set.

Declaration
public string UserAgent { get; set; }
Property Value
Type Description
System.String

UserId

Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Declaration
public string UserId { get; set; }
Property Value
Type Description
System.String