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 webpage details how to write a single user event using the Discovery Engine API, specifically with a POST request.\u003c/p\u003e\n"],["\u003cp\u003eThe API request utilizes gRPC Transcoding syntax with a structured URL that includes a \u003ccode\u003eparent\u003c/code\u003e path parameter, which specifies the resource location, either at the DataStore or Location level.\u003c/p\u003e\n"],["\u003cp\u003eThe API accepts a \u003ccode\u003ewriteAsync\u003c/code\u003e query parameter, enabling asynchronous event writing and immediate API response upon validation.\u003c/p\u003e\n"],["\u003cp\u003eThe request body expects a \u003ccode\u003eUserEvent\u003c/code\u003e instance, and if the request is successful, the response body will also contain a \u003ccode\u003eUserEvent\u003c/code\u003e instance.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this API call requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003ediscoveryengine.userEvents.create\u003c/code\u003e IAM permission on the \u003ccode\u003eparent\u003c/code\u003e resource.\u003c/p\u003e\n"]]],[],null,[]]
