v1

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

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 Recommendations AI JavaScript pixel. Users should not call this method directly.

get/v1beta1/{+parent}/userEvents:collect

Path parameters

parentstring required

Required. The parent eventStore name, such as projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store.

Query parameters

etsstring

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

uristring

Optional. The url including cgi-parameters but excluding the hash fragment. The URL must be truncated to 1.5K bytes to conservatively be under the 2K bytes. 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.

Response

Successful response