Class: Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserInfo

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

Overview

Information of end users.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommendationengineV1beta1UserInfo

Returns a new instance of GoogleCloudRecommendationengineV1beta1UserInfo.



1784
1785
1786
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1784

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

Instance Attribute Details

#direct_user_request ⇒ Boolean Also known as: direct_user_request?

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

Returns:

  • (Boolean) 


1747
1748
1749
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1747

def direct_user_request
  @direct_user_request
end

#ip_address ⇒ String

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

Returns:

  • (String) 


1756
1757
1758
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1756

def ip_address
  @ip_address
end

#user_agent ⇒ String

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

Returns:

  • (String) 


1763
1764
1765
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1763

def user_agent
  @user_agent
end

#user_id ⇒ String

Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users. Don't set for anonymous users. 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. Corresponds to the JSON property userId

Returns:

  • (String) 


1771
1772
1773
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1771

def user_id
  @user_id
end

#visitor_id ⇒ String

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

Returns:

  • (String) 


1782
1783
1784
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1782

def visitor_id
  @visitor_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1789
1790
1791
1792
1793
1794
1795
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1789

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