Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::UserInfo.
Information of an end user.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#precise_location
def precise_location() -> ::Google::Cloud::DiscoveryEngine::V1beta::UserInfo::PreciseLocation- (::Google::Cloud::DiscoveryEngine::V1beta::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.
#precise_location=
def precise_location=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::UserInfo::PreciseLocation- value (::Google::Cloud::DiscoveryEngine::V1beta::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.
- (::Google::Cloud::DiscoveryEngine::V1beta::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.
#time_zone
def time_zone() -> ::String- (::String) — Optional. IANA time zone, e.g. Europe/Budapest.
#time_zone=
def time_zone=(value) -> ::String- value (::String) — Optional. IANA time zone, e.g. Europe/Budapest.
- (::String) — Optional. IANA time zone, e.g. Europe/Budapest.
#user_agent
def user_agent() -> ::String-
(::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_ARGUMENTerror 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.
#user_agent=
def user_agent=(value) -> ::String-
value (::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_ARGUMENTerror 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) — 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_ARGUMENTerror 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.
#user_id
def user_id() -> ::String-
(::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_ARGUMENTerror 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_id=
def user_id=(value) -> ::String-
value (::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_ARGUMENTerror 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.
-
(::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_ARGUMENTerror 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.