- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Writes a single user event.
HTTP request
POST https://retail.googleapis.com/v2alpha/{parent=projects/*/locations/*/catalogs/*}/userEvents:write
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
parent |
Required. The parent catalog resource name, such as |
Query parameters
| Parameters | |
|---|---|
writeAsync |
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:
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:
retail.userEvents.create
For more information, see the IAM documentation.