Interface UserInfoOrBuilder (2.41.0)

Version 2.41.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public interface UserInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDirectUserRequest()

public abstract boolean getDirectUserRequest()

True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).

This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.

bool direct_user_request = 4;

Returns
Type	Description
boolean	The directUserRequest.

getIpAddress()

public abstract String getIpAddress()

The end user's IP address. This field is used to extract location information for personalization.

This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when:

• setting SearchRequest.user_info.
• using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

string ip_address = 2;

Returns
Type	Description
String	The ipAddress.

getIpAddressBytes()

public abstract ByteString getIpAddressBytes()

The end user's IP address. This field is used to extract location information for personalization.

This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when:

• setting SearchRequest.user_info.
• using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

string ip_address = 2;

Returns
Type	Description
ByteString	The bytes for ipAddress.

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 direct_user_request is set.

string user_agent = 3;

Returns
Type	Description
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 direct_user_request is set.

string user_agent = 3;

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.

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.

string user_id = 1;

Returns
Type	Description
ByteString	The bytes for userId.