Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class UserInfo.
Information of an end user.
Generated from protobuf message google.cloud.discoveryengine.v1.UserInfo
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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.
↳ user_agent
string
User agent as included in the HTTP header. 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 UserEvent.direct_user_request
is set.
↳ time_zone
string
Optional. IANA time zone, e.g. Europe/Budapest.
getUserId
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.
string
setUserId
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.
var
string
$this
getUserAgent
User agent as included in the HTTP header.
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 UserEvent.direct_user_request
is set.
string
setUserAgent
User agent as included in the HTTP header.
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 UserEvent.direct_user_request
is set.
var
string
$this
getTimeZone
Optional. IANA time zone, e.g. Europe/Budapest.
string
setTimeZone
Optional. IANA time zone, e.g. Europe/Budapest.
var
string
$this
