UserInfo

Information of an end user.

JSON representation
{
  "userId": string,
  "userAgent": string,
  "timeZone": string,
  "preciseLocation": {
    object (PreciseLocation)
  }
}
Fields
userId

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_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.

userAgent

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_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.

timeZone

string

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

preciseLocation

object (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.

PreciseLocation

Precise location info with multiple representation options. Currently only latitude and longitude point is supported.

JSON representation
{

  // Union field location can be only one of the following:
  "point": {
    object (LatLng)
  },
  "address": string
  // End of list of possible types for union field location.
}
Fields

Union field location.

location can be only one of the following:

point

object (LatLng)

Optional. Location represented by a latitude/longitude point.

address

string

Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.