Method: projects.locations.catalogs.userEvents.collect

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

GET https://retail.googleapis.com/v2alpha/{parent=projects/*/locations/*/catalogs/*}/userEvents:collect

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
userEvent

string

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

string

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

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

string

An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the userEvent field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.
Union parameter conversion_rule. The rule that can convert the raw_json to a user event. It is needed only when the raw_json is set. conversion_rule can be only one of the following:
prebuiltRule

string

The prebuilt rule name that can convert a specific type of rawJson. For example: "ga4_bq" rule for the GA4 user event schema.

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:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.