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 で応答することが想定されています。

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 で、Google Cloud Functions の認証に合格するには、Webhook リクエスト後の Cloud Run 起動元（roles/run.invoker）と Cloud Functions 起動元（roles/cloudfunctions.invoker）のロールに、サービス アカウントの権限を付与する必要があります。この API は、任意の URI に Webhook 通知を送信できます。Google Cloud Functions 以外の Webhook サーバーでは、Authorization Bearer ヘッダー内のこの ID トークンが不要な場合は無視してください。
channelToken

string

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

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