projects

Changed on

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 AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

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

Request

  • Base URL: https://retail.googleapis.com
  • URL: https://retail.googleapis.com/v2/{+parent}/userEvents:collect
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

parentstring required

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

Request body

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.

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.

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.

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.

userEventstring

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

Response

Successful response

Changes

  • e3e148bacc87Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status