Method: projects.locations.userEvents.write

写入单个用户事件。

HTTP 请求

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*}/userEvents:write

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。父级资源名称。如果写入用户事件操作是在 DataStore 级别应用的，则格式为：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}。如果“写入用户事件”操作应用于 Location 级，例如，具有 Document 的事件跨多个 DataStore，则格式为：projects/{project}/locations/{location}。

查询参数

参数
writeAsync

boolean

如果设置为 true，则在验证后异步写入用户事件，并且 API 会在不等待写入的情况下做出响应。

请求正文

请求正文包含一个 UserEvent 实例。

响应正文

如果成功，则响应正文包含一个 UserEvent 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

  • discoveryengine.userEvents.create

如需了解详情，请参阅 IAM 文档。