Class: Google::Cloud::RecommendationEngine::V1beta1::UserInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb

Overview

Information of end users.

Instance Attribute Summary collapse

Instance Attribute Details

#direct_user_request ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



144
145
146
147
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 144

class UserInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#ip_address ⇒ ::String

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

Returns:

  • (::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.



144
145
146
147
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 144

class UserInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_agent ⇒ ::String

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

Returns:

  • (::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.



144
145
146
147
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 144

class UserInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_id ⇒ ::String

Returns Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.

Returns:

  • (::String) —

    Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.



144
145
146
147
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 144

class UserInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#visitor_id ⇒ ::String

Returns Required. A unique identifier for tracking visitors with a length limit of 128 bytes.

For example, this could be implemented with a http cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Maximum length 128 bytes. Cannot be empty.

Returns:

  • (::String) —

    Required. A unique identifier for tracking visitors with a length limit of 128 bytes.

    For example, this could be implemented with a http cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Maximum length 128 bytes. Cannot be empty.



144
145
146
147
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/user_event.rb', line 144

class UserInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end