UserInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)Information of an end user.
Attributes |
|
|---|---|
| Name | Description |
user_id |
str
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.
Represents an opaque ID to the Search API. The Search API
doesn't interpret the value in any way. This field is used
to associate events with a user across sessions if the
events are being uploaded.
|
user_agent |
str
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 |
str
Optional. IANA time zone, e.g. Europe/Budapest. |
precise_location |
google.cloud.discoveryengine_v1beta.types.UserInfo.PreciseLocation
Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. |
Classes
PreciseLocation
PreciseLocation(mapping=None, *, ignore_unknown_fields=False, **kwargs)Precise location info with multiple representation options. Currently only latitude and longitude point is supported.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields