通知

アラート センター API は、アラートが更新されたときに通知を送信できます。通知を受け取るには、通知設定を構成する必要があります。

Pub/Sub 通知

Alert Center API は、Pub/Sub トピックに通知を公開できます。トピックを作成して alerts-api-push-notifications@system.gserviceaccount.com のパブリッシュ権限を付与したら、アラート センター API の設定更新 API を使用して、そのトピックを通知の宛先として設定します。構成が完了すると、Alert Center API は、新しいアラートが届いたときなど、更新ごとにそのトピックにメッセージをパブリッシュします。

Pub/Sub メッセージ属性

以降のセクションでは、Pub/Sub メッセージに含まれる属性について説明します。

一般的な属性

  • alertcenter_resource_type: リソースのタイプ。サポートされている値は "ALERT" です。
  • alertcenter_resource_status: リソースのステータス。サポートされている値は "CREATED"、"DELETED"、"UNDELETED"、"MODIFIED" です。
  • alertcenter_payload_format: ペイロードの形式。サポートされている値は "JSON" です。

アラートの属性

  • alertcenter_start_time: このアラートの原因となったイベントが開始または検出された時刻。
  • alertcenter_end_time: このアラートの原因となったイベントがアクティブでなくなった時刻。
  • alertcenter_type: アラートのタイプ。使用可能なアラートタイプのリストについては、Google Workspace アラートタイプをご覧ください。
  • alertcenter_source: アラートを報告したシステムの一意の識別子。
  • alertcenter_create_time: このアラートが作成された時間。
  • alertcenter_update_time: このアラートが最後に更新された時間。

メッセージ ペイロード

メッセージのペイロードは alertcenter_resource_type によって異なります。リソースタイプが "ALERT" の場合、ペイロードは Alert Center API のアラートタイプのいずれかになります。ペイロードの形式は alertcenter_payload_format によって異なります。形式が "JSON" の場合、ペイロードは base64 でエンコードされた JSON オブジェクトです。