WebhookNotification

配置长时间运行的操作资源，以便在资源更新时从 Google Analytics（分析）Data API 向您的网络钩子服务器发送网络钩子通知。

通知配置包含不公开值，并且仅对 GCP 项目可见。不同的 GCP 项目可能会将不同的 webhook 通知附加到同一个长时间运行的操作资源。

JSON 表示法 
{
  "uri": string,
  "channelToken": string
}
字段
uri

string

可选。将接收网络钩子通知的网址。当长时间运行的操作资源的状态发生更改时，此地址将接收 POST 请求。POST 请求将在正文中包含长运行操作资源的 JSON 版本和一个 sentTimestamp 字段。发送的时间戳将指定自发出请求的 Epoch 以来的 unix 微秒数，方便您识别重放通知。

示例 URI 为 https://us-central1-example-project-id.cloudfunctions.net/example-function-1。

URI 必须使用 HTTPS 并指向网络服务器上具有有效 SSL 证书的网站。URI 的字符串长度不得超过 128 个字符，并且只能使用 RFC 1738 中列入许可名单的字符。

当 webhook 服务器收到通知时，应在 5 秒内以 HTTP 响应状态代码 200 进行回复。

必须提供 URI 才能使用 webhook 通知。

发送到此 webhook 服务器的请求将包含一个 ID 令牌，用于对服务账号 google-analytics-audience-export@system.gserviceaccount.com 进行身份验证。如需详细了解 ID 令牌，请参阅 https://cloud.google.com/docs/authentication/token-types#id。对于 Google Cloud Functions，这可让您将函数配置为需要身份验证。在 Cloud IAM 中，您需要将服务账号权限授予 Cloud Run Invoker (roles/run.invoker) 和 Cloud Functions Invoker (roles/cloudfunctions.invoker) 角色，以便 webhook 发布请求通过 Google Cloud Functions 身份验证。此 API 可以向任意 URI 发送网络钩子通知；对于 Google Cloud Functions 以外的网络钩子服务器，如果不需要，应忽略授权不记名标头中的此 ID 令牌。
channelToken

string

可选。通道令牌为任意字符串值，且最大字符串长度必须为 64 个字符。通过通道令牌，您可以验证 webhook 通知的来源。这是为了防止邮件被假冒。通道令牌将在 webhook POST 请求的 X-Goog-Channel-Token HTTP 标头中指定。

无需渠道令牌即可使用 webhook 通知。