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 中允許的字元。

當 webhook 伺服器收到通知時，應在 5 秒內回覆 HTTP 回應狀態碼 200。

您必須提供 URI 才能使用 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 叫用者 (roles/run.invoker) 和 Cloud Functions 叫用者 (roles/cloudfunctions.invoker) 角色，才能讓 webhook 發布要求通過 Google Cloud Functions 驗證。這個 API 可將 webhook 通知傳送至任意 URI；如果是 Google Cloud Functions 以外的 webhook 伺服器，則應忽略授權代管者標頭中的 ID 權杖 (如果不需要的話)。
channelToken

string

選用設定。管道符記是任意字串值，且字串長度不得超過 64 個半形字元。管道權杖可讓您驗證 Webhook 通知的來源。這可防止訊息遭到冒用。管道權杖會在 webhook POST 要求的 X-Goog-Channel-Token HTTP 標頭中指定。

使用 webhook 通知時，不需要管道權杖。