Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/representations.rb

Overview

Information of an end user.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaUserInfo

Returns a new instance of GoogleCloudRetailV2alphaUserInfo.



5552
5553
5554
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5552

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#direct_user_request ⇒ Boolean Also known as: direct_user_request?

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

Returns:

  • (Boolean) 


5519
5520
5521
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5519

def direct_user_request
  @direct_user_request
end

#ip_address ⇒ String

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. * using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set. Corresponds to the JSON property ipAddress

Returns:

  • (String) 


5530
5531
5532
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5530

def ip_address
  @ip_address
end

#user_agent ⇒ String

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

Returns:

  • (String) 


5540
5541
5542
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5540

def user_agent
  @user_agent
end

#user_id ⇒ String

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. Corresponds to the JSON property userId

Returns:

  • (String) 


5550
5551
5552
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5550

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5557
5558
5559
5560
5561
5562
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 5557

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