Method: projects.locations.dataStores.userEvents.write

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.