Class: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo

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

Overview

Information of an end user.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2UserInfo

Returns a new instance of GoogleCloudRetailV2UserInfo.



3417
3418
3419
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3417

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) 


3386
3387
3388
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3386

def direct_user_request
  @direct_user_request
end

#ip_address ⇒ String

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

Returns:

  • (String) 


3398
3399
3400
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3398

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) 


3408
3409
3410
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3408

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


3415
3416
3417
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3415

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3422
3423
3424
3425
3426
3427
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3422

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