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.
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.
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.
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.
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.
Highly recommended for logged-in users. Unique identifier for logged-in
user, such as a user name.
Always use a hashed value for this ID.
The field must be a UTF-8 encoded string with a length limit of 128
characters. Otherwise, an INVALID_ARGUMENT error is returned.
Highly recommended for logged-in users. Unique identifier for logged-in
user, such as a user name.
Always use a hashed value for this ID.
The field must be a UTF-8 encoded string with a length limit of 128
characters. Otherwise, an INVALID_ARGUMENT error is returned.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
