Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: projects/{project}/locations/{location}.
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 third-party requests.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis endpoint is designed for writing a single user event from a browser using a GET request, primarily for use by the Discovery Engine API JavaScript pixel and Google Tag Manager.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003eGET\u003c/code\u003e request with a specific URL structure, including path parameters like \u003ccode\u003eparent\u003c/code\u003e, which denotes the resource name at either the \u003ccode\u003eDataStore\u003c/code\u003e or \u003ccode\u003eLocation\u003c/code\u003e level.\u003c/p\u003e\n"],["\u003cp\u003eRequired query parameters include \u003ccode\u003euserEvent\u003c/code\u003e, which is a URL-encoded \u003ccode\u003eUserEvent\u003c/code\u003e proto, \u003ccode\u003euri\u003c/code\u003e, representing the URL of the event, and \u003ccode\u003eets\u003c/code\u003e, the event timestamp in milliseconds.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this endpoint must be empty, and if successful, the response will be a generic HTTP response defined by the method.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this endpoint requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.userEvents.collect\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nWrites a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain.\n\nThis method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.\n\n### HTTP request\n\n`GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}/userEvents:collect`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
