WebhookNotification

配置一个长时间运行的操作资源，以便在资源更新时从 Google Analytics Data API 向您的 webhook 服务器发送 webhook 通知。

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

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

string

可选。将接收 webhook 通知的网址。当长时间运行的操作资源状态发生变化时，此地址将会收到 POST 请求。POST 请求将在正文中包含长时间运行的操作资源的 JSON 版本，以及 sentTimestamp 字段。发送时间戳将指定自请求发送之时起的 Unix 微秒数；这样，您就可以识别重放的通知。

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

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

当您的网络钩子服务器收到通知时，应在 5 秒内回复 HTTP 响应状态代码 200。

必须提供 URI 才能使用网络钩子通知。

发送到此 webhook 服务器的请求将包含用于对服务账号 google-analytics-audience-export@system.gserviceaccount.com 进行身份验证的 ID 令牌。如需详细了解 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 发送 webhook 通知；对于 Google Cloud Functions 以外的 webhook 服务器，如果不需要授权 Bearer 标头中的此 ID 令牌，则应忽略该令牌。
channelToken

string

可选。渠道令牌是一个任意字符串值，字符串长度不得超过 64 个字符。借助渠道令牌，您可以验证 webhook 通知的来源。这可防止邮件被仿冒。渠道令牌将在 webhook POST 请求的 X-Goog-Channel-Token HTTP 标头中指定。

您无需渠道令牌即可使用网络钩子通知。