class Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo

Information of an end user.

Attributes

direct_user_request[RW]

True if the request is made directly from the end user, in which case the ip_address and 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. Corresponds to the JSON property `directUserRequest` @return [Boolean]

direct_user_request?[RW]

True if the request is made directly from the end user, in which case the ip_address and 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. Corresponds to the JSON property `directUserRequest` @return [Boolean]

ip_address[RW]

The end user's IP address. Required for getting SearchResponse. sponsored_results. 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 or if direct_user_request is set. Corresponds to the JSON property `ipAddress` @return [String]

user_agent[RW]

User agent as included in the HTTP header. Required for getting 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 or if direct_user_request is set. Corresponds to the JSON property `userAgent` @return [String]

user_id[RW]

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

Public Class Methods

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

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/retail_v2beta/classes.rb, line 4293
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)
end