WebhookNotification

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

通知配置包含不公开的值和只有您的 GCP 项目可见不同的 GCP 项目可以将不同的网络钩子通知附加到同一个长时间运行的操作资源。

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

string

可选。将接收网络钩子通知的网址。当长时间运行的操作资源的状态更改时,此地址将接收 POST 请求。POST 请求的正文中将包含长时间运行的操作资源的 JSON 版本以及 sentTimestamp 字段。发送的时间戳将指定自请求发送时间以来的 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 才能使用网络钩子通知。

发送到此网络钩子服务器的请求将包含用于对服务账号 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 调用者 (roles/run.invoker) 授予服务账号权限,webhook post 请求的 Cloud Functions Invoker (roles/cloudfunctions.invoker) 角色,以传递 Google Cloud Functions 身份验证。此 API 可以向任意 URI 发送 webhook 通知;对于 Google Cloud Functions 以外的 Webhook 服务器,如果不需要,则应忽略授权不记名标头中的此 ID 令牌。

channelToken

string

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

使用网络钩子通知不需要渠道令牌。