class Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserInfo

Information of end users.

Attributes

direct_user_request[RW]

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). Corresponds to the JSON property `directUserRequest` @return [Boolean]

direct_user_request?[RW]

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). Corresponds to the JSON property `directUserRequest` @return [Boolean]

ip_address[RW]

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. Corresponds to the JSON property `ipAddress` @return [String]

user_agent[RW]

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. Corresponds to the JSON property `userAgent` @return [String]

user_id[RW]

Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users. Corresponds to the JSON property `userId` @return [String]

visitor_id[RW]

Required. A unique identifier for tracking visitors with a length limit of 128 bytes. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. Maximum length 128 bytes. Cannot be empty. Corresponds to the JSON property `visitorId` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/recommendationengine_v1beta1/classes.rb, line 1780
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/recommendationengine_v1beta1/classes.rb, line 1785
def update!(**args)
  @direct_user_request = args[:direct_user_request] if args.key?(:direct_user_request)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @user_agent = args[:user_agent] if args.key?(:user_agent)
  @user_id = args[:user_id] if args.key?(:user_id)
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
end