Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 Client class UserInfo.
Information of end users.
Generated from protobuf message google.cloud.recommendationengine.v1beta1.UserInfo
Namespace
Google \ Cloud \ RecommendationEngine \ V1beta1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ visitor_id
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.
↳ user_id
string
Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.
↳ 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.
↳ 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.
↳ direct_user_request
bool
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).
getVisitorId
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.
string
setVisitorId
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.
var
string
$this
getUserId
Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.
string
setUserId
Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.
var
string
$this
getIpAddress
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.
string
setIpAddress
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.
var
string
$this
getUserAgent
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.
string
setUserAgent
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.
var
string
$this
getDirectUserRequest
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).
bool
setDirectUserRequest
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).
var
bool
$this
