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 \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
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.
Returns
Type
Description
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$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.
Returns
Type
Description
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class UserInfo (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.UserInfo)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.UserInfo)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.UserInfo)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.UserInfo)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.UserInfo)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.UserInfo)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.UserInfo)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.UserInfo)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.UserInfo)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.UserInfo)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.UserInfo)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.UserInfo)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.UserInfo)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.UserInfo)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.UserInfo)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.UserInfo)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.UserInfo) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class UserInfo.\n\nInformation of an end user.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.UserInfo`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getUserId\n\nHighly recommended for logged-in users. Unique identifier for logged-in\nuser, such as a user name. Don't set for anonymous users.\n\nAlways use a hashed value for this ID.\nDon't set the field to the same fixed ID for different users. This mixes\nthe event history of those users together, which results in degraded\nmodel quality.\nThe field must be a UTF-8 encoded string with a length limit of 128\ncharacters. Otherwise, an `INVALID_ARGUMENT` error is returned.\n\n### setUserId\n\nHighly recommended for logged-in users. Unique identifier for logged-in\nuser, such as a user name. Don't set for anonymous users.\n\nAlways use a hashed value for this ID.\nDon't set the field to the same fixed ID for different users. This mixes\nthe event history of those users together, which results in degraded\nmodel quality.\nThe field must be a UTF-8 encoded string with a length limit of 128\ncharacters. Otherwise, an `INVALID_ARGUMENT` error is returned.\n\n### getUserAgent\n\nUser agent as included in the HTTP header.\n\nThe field must be a UTF-8 encoded string with a length limit of 1,000\ncharacters. Otherwise, an `INVALID_ARGUMENT` error is returned.\nThis should not be set when using the client side event reporting with\nGTM or JavaScript tag in\n[UserEventService.CollectUserEvent](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.UserEventServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_UserEventServiceClient__collectUserEvent__)\nor if\n[UserEvent.direct_user_request](/php/docs/reference/cloud-discoveryengine/latest/V1.UserEvent#_Google_Cloud_DiscoveryEngine_V1_UserEvent__getDirectUserRequest__)\nis set.\n\n### setUserAgent\n\nUser agent as included in the HTTP header.\n\nThe field must be a UTF-8 encoded string with a length limit of 1,000\ncharacters. Otherwise, an `INVALID_ARGUMENT` error is returned.\nThis should not be set when using the client side event reporting with\nGTM or JavaScript tag in\n[UserEventService.CollectUserEvent](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.UserEventServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_UserEventServiceClient__collectUserEvent__)\nor if\n[UserEvent.direct_user_request](/php/docs/reference/cloud-discoveryengine/latest/V1.UserEvent#_Google_Cloud_DiscoveryEngine_V1_UserEvent__getDirectUserRequest__)\nis set.\n\n### getTimeZone\n\nOptional. IANA time zone, e.g. Europe/Budapest.\n\n### setTimeZone\n\nOptional. IANA time zone, e.g. Europe/Budapest."]]
