Method: projects.locations.dataStores.userEvents.write
Stay organized with collections
Save and categorize content based on your preferences.
Writes a single user event.
HTTP request
POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/dataStores/*}/userEvents:write
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
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.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent resource:
discoveryengine.userEvents.create
For more information, see the IAM documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["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-03-03 UTC."],[[["This endpoint facilitates the writing of a single user event using a POST request to a specific URL, utilizing gRPC Transcoding syntax."],["The `parent` path parameter is required, specifying either a DataStore-level path or a Location-level path, depending on the scope of the user event."],["The request body should contain a `UserEvent` instance, detailing the specifics of the user event being recorded."],["Setting the `writeAsync` query parameter to true will allow the API to respond before the user event is written."],["Successful requests return a `UserEvent` instance in the response body, and the operation requires the `discoveryengine.userEvents.create` IAM permission, as well as the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
