Interface UserInfoOrBuilder (0.18.0)

public interface UserInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getUserAgent()

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

string user_agent = 2;

Returns
TypeDescription
String

The userAgent.

getUserAgentBytes()

public abstract ByteString getUserAgentBytes()

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.

string user_agent = 2;

Returns
TypeDescription
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.

string user_id = 1;

Returns
TypeDescription
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.

string user_id = 1;

Returns
TypeDescription
ByteString

The bytes for userId.