Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class UserInfo.
Information of an end user.
Generated from protobuf message google.cloud.discoveryengine.v1beta.UserInfo
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 |
↳ user_agent |
string
User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an |
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. Required for getting SearchResponse.sponsored_results.
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. Required for getting SearchResponse.sponsored_results.
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |