Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. If the write 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
writeAsync
boolean
If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
Request body
The request body contains an instance of UserEvent.
Response body
If successful, the response body contains an instance of UserEvent.
[[["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 API call writes a single user event to a specified data store or location using the \u003ccode\u003ePOST\u003c/code\u003e method with a defined URL structure.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eparent\u003c/code\u003e path parameter, which designates the target data store or location where the user event will be written, and this format will differ depending on the level of operation, whether it is on a DataStore or location level.\u003c/p\u003e\n"],["\u003cp\u003eThe API supports an optional \u003ccode\u003ewriteAsync\u003c/code\u003e query parameter to handle user events asynchronously, so that the API will respond without waiting for the event to be written.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain a \u003ccode\u003eUserEvent\u003c/code\u003e instance, and the response body will also return a \u003ccode\u003eUserEvent\u003c/code\u003e instance if the operation is successful.\u003c/p\u003e\n"],["\u003cp\u003eThe call requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003ediscoveryengine.userEvents.create\u003c/code\u003e on the \u003ccode\u003eparent\u003c/code\u003e resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.collections.dataStores.userEvents.write\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- [IAM Permissions](#body.aspect_1)\n\nWrites a single user event.\n\n### HTTP request\n\n`POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write`\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 contains an instance of [UserEvent](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.dataStores.userEvents#UserEvent).\n\n### Response body\n\nIf successful, the response body contains an instance of [UserEvent](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.dataStores.userEvents#UserEvent).\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).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `discoveryengine.userEvents.create`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
