Method: projects.locations.catalogs.userEvents.write

Stay organized with collections Save and categorize content based on your preferences.

Writes a single user event.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The parent catalog resource name, such as projects/1234/locations/global/catalogs/default_catalog.

Query parameters



If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.

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:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • retail.userEvents.create

For more information, see the IAM documentation.