Interface UserInfoOrBuilder (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface UserInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPreciseLocation()

public abstract UserInfo.PreciseLocation getPreciseLocation()

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 precise_location = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserInfo.PreciseLocation	The preciseLocation.

getPreciseLocationOrBuilder()

public abstract UserInfo.PreciseLocationOrBuilder getPreciseLocationOrBuilder()

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 precise_location = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserInfo.PreciseLocationOrBuilder

getTimeZone()

public abstract String getTimeZone()

Optional. IANA time zone, e.g. Europe/Budapest.

string time_zone = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

Optional. IANA time zone, e.g. Europe/Budapest.

string time_zone = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for timeZone.

getUserAgent()

public abstract String 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 user_agent = 2;

Returns
Type	Description
String	The userAgent.

getUserAgentBytes()

public abstract ByteString getUserAgentBytes()

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 user_agent = 2;

Returns
Type	Description
ByteString	The bytes for userAgent.

getUserId()

public abstract String 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.

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 user_id = 1;

Returns
Type	Description
String	The userId.

getUserIdBytes()

public abstract ByteString getUserIdBytes()

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.

string user_id = 1;

Returns
Type	Description
ByteString	The bytes for userId.

hasPreciseLocation()

public abstract boolean hasPreciseLocation()

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 precise_location = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the preciseLocation field is set.