Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1348275334.9 KB
projects

Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

post/v2/{+parent}/userEvents:collect

Path parameters

parentstring required

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

Request body

userEventstring

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

rawJsonstring

An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.

prebuiltRulestring

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

uristring

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.

etsstring int64

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

Response

Successful response