This is the documentation for Recommendations AI, Retail Search, and the new Retail console.

Method: projects.locations.catalogs.userEvents.collect

Stay organized with collections Save and categorize content based on your preferences.

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain.

This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

Query parameters



Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.



The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.


string (int64 format)

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

Request body

The request body must be empty.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.