Method: projects.locations.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/v1/{parent=projects/*/locations/*}/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 API endpoint allows for writing a single user event to a specified parent resource, either at the DataStore or Location level."],["The HTTP request uses a `POST` method to the provided URL, utilizing gRPC Transcoding syntax for defining the parent resource in the path."],["The `parent` path parameter is mandatory, defining the target resource (DataStore or Location) where the user event will be written."],["A boolean query parameter `writeAsync` is available to trigger asynchronous writing of the user event, bypassing the wait time for write confirmation."],["Successful requests return a `UserEvent` instance in the response body, and the API requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the `discoveryengine.userEvents.create` IAM permission."]]],[]]
