Class UserInfo (2.0.0) 

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

Information of an end user.

Inheritance

Object > UserInfo

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

UserInfo()

public UserInfo()

UserInfo(UserInfo)

public UserInfo(UserInfo other)
Parameter
NameDescription
otherUserInfo

Properties

DirectUserRequest

public bool DirectUserRequest { get; set; }

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

Property Value
TypeDescription
Boolean

IpAddress

public string IpAddress { get; set; }

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:

  • setting [SearchRequest.user_info][google.cloud.retail.v2.SearchRequest.user_info].
  • 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.
Property Value
TypeDescription
String

UserAgent

public string UserAgent { get; set; }

User agent as included in the HTTP header. Required for getting [SearchResponse.sponsored_results][google.cloud.retail.v2.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][google.cloud.retail.v2.UserEventService.CollectUserEvent] or if [direct_user_request][google.cloud.retail.v2.UserInfo.direct_user_request] is set.

Property Value
TypeDescription
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
TypeDescription
String