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 uses a GET request to write a single user event from the browser, primarily intended for the Discovery Engine API JavaScript pixel and Google Tag Manager, and is not meant for direct user invocation.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter, a required string, specifies the resource name, with formatting that varies depending on whether the user event is applied at the DataStore level or at the Location level across multiple DataStores.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires three query parameters: a \u003ccode\u003euserEvent\u003c/code\u003e (a URL-encoded UserEvent proto with a 2,000,000 character limit), a \u003ccode\u003euri\u003c/code\u003e (a URL excluding the hash fragment with a 5,000 character limit), and \u003ccode\u003eets\u003c/code\u003e (an event timestamp in milliseconds to prevent browser caching).\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this endpoint must be empty, and a successful request yields a generic HTTP response whose format is defined by the method.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this endpoint requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.dataStores.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/v1beta/{parent=projects/*/locations/*/dataStores/*}/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)."]]
