WebhookNotification

リソースの更新時に Google Analytics Data API から Webhook サーバーに Webhook 通知を送信するように、長時間実行オペレーションのリソースを構成します。

通知設定にはプライベートな値と自分の GCP プロジェクトにのみ表示されます。異なる GCP プロジェクトが、同じ長時間実行オペレーション リソースに異なる Webhook 通知を添付する場合があります。

JSON 表現 
{
  "uri": string,
  "channelToken": string
}
フィールド
uri

string

省略可。Webhook 通知を受信するウェブアドレス。長時間実行オペレーション リソースの状態が変化すると、このアドレスは POST リクエストを受け取ります。POST リクエストの本文と sentTimestamp フィールドの両方に、長時間実行オペレーション リソースの JSON バージョンが含まれます。送信されたタイムスタンプは、リクエストが送信されたエポックからの UNIX マイクロ秒を示します。リプレイされた通知を特定できます

URI の例は https://us-central1-example-project-id.cloudfunctions.net/example-function-1 です。

URI は HTTPS を使用し、ウェブサーバー上に有効な SSL 証明書があるサイトを指している必要があります。URI は、文字列の最大長を 128 文字にする必要があります。RFC 1738 の許可リストに登録された文字のみを使用する。

Webhook サーバーが通知を受信すると、5 秒以内に HTTP レスポンスのステータス コード 200 を返すことが期待されます。

Webhook 通知を使用するには 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 起動元（roles/run.invoker）に付与する必要があります。Google Cloud Functions の認証を渡す Webhook POST リクエストの Cloud Functions 起動元（roles/cloudfunctions.invoker）ロール。この API は、Webhook 通知を任意の URI に送信できます。Google Cloud Functions 以外の Webhook サーバーでは、Authorization Bearer ヘッダー内のこの ID トークンが不要な場合は無視する必要があります。
channelToken

string

省略可。チャンネル トークンは任意の文字列値で、文字列の最大長は 64 文字である必要があります。チャネル トークンを使用すると、Webhook 通知のソースを確認できます。これにより、なりすましメールを防ぐことができます。チャネル トークンは、Webhook POST リクエストの X-Goog-Channel-Token HTTP ヘッダーで指定されます。

Webhook 通知を使用するためにチャネル トークンは必要ありません。