REST Resource: alerts

リソース: Alert

ユーザーに影響するアラート。

JSON 表現 
{
  "customerId": string,
  "alertId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "type": string,
  "source": string,
  "data": {
    "@type": string,
    field1: ...,
    ...
  },
  "securityInvestigationToolLink": string,
  "deleted": boolean,
  "metadata": {
    object (AlertMetadata)
  },
  "updateTime": string,
  "etag": string
}
フィールド
customerId

string

出力のみ。お客様の Google Workspace アカウントの一意の識別子。
alertId

string

出力のみ。アラートの一意の識別子。
createTime

string (Timestamp format)

出力のみ。このアラートの作成時刻。
startTime

string (Timestamp format)

必須。このアラートの原因となったイベントが発生した日時。
endTime

string (Timestamp format)

（省略可）このアラートの原因となったイベントがアクティブでなくなった時刻。指定する場合は、終了時間が開始時間より前でなければなりません。設定されていない場合は、進行中のアラートが表示されます。
type

string

必須。アラートのタイプ。これは、アラートの作成後にのみ出力されます。利用可能なアラートの種類については、Google Workspace のアラートの種類をご覧ください。
source

string

必須。アラートを報告したシステムの一意の識別子。これは、アラートの作成後にのみ出力されます。

サポートされているソースは、次のいずれかです。

  • Google Operations
  • モバイル デバイスの管理
  • Gmail でのフィッシング
  • データ損失防止（DLP）
  • ドメイン全体のデータ エクスポート
  • 国家が支援する攻撃
  • Google の ID
  • アプリの停止
data

object

（省略可）このアラートに関連付けられているデータ。例: google.apps.alertcenter.type.DeviceCompromised
deleted

boolean

出力のみ。True: このアラートが削除対象としてマークされている場合。
metadata

object (AlertMetadata)

出力のみ。このアラートに関連付けられているメタデータ。
updateTime

string (Timestamp format)

出力のみ。このアラートが最後に更新された時刻。
etag

string

（省略可）etag は、アラートの同時更新による相互上書きを防ぐために、オプティミスティック同時実行制御に使用されます。競合状態を避けるため、読み取り - 変更 - 書き込みサイクルで etag を使用してアラートの更新を行うことを強くおすすめします。レスポンスを含むアラートで etag が返され、その etag がアラート更新リクエストに追加され、同じバージョンのアラートに変更が適用されることが期待されます。

更新アラートの呼び出しに etag が指定されていない場合、既存のアラートが無条件に上書きされます。

アラートのメタデータ

アラートのメタデータ。

JSON 表現 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
フィールド
customerId

string

出力のみ。お客様の Google Workspace アカウントの一意の識別子。
alertId

string

出力のみ。アラート ID。
status

string

アラートの現在のステータス。サポートされている値は次のとおりです。

  • 開始されていません
  • IN_PROGRESS
  • クローズ済み
assignee

string

アラートに割り当てられたユーザーのメールアドレス。
updateTime

string (Timestamp format)

出力のみ。このメタデータの最終更新日時。
severity

string

アラートの重大度の値。アラート センターでは、アラートの作成時にこのフィールドを設定します。判断できない場合は、デフォルトで空の文字列が設定されます。このフィールドでの更新アクションでサポートされている値は次のとおりです。

  • 高
  • MEDIUM
  • 低
etag

string

（省略可）etag は、アラート メタデータの同時更新による相互上書きを防止する手段として、オプティミスティック同時実行制御に使用されます。競合状態を避けるため、読み取り - 変更 - 書き込みサイクルで etag を使用してメタデータを更新することを強くおすすめします。レスポンス メタデータを含むレスポンスで etag が返され、その ETag をアラート メタデータの更新リクエストに設定して、同じバージョンのアラート メタデータに変更が適用されることが想定されています。

アラートのメタデータを更新する呼び出しで etag が指定されていない場合、既存のアラートのメタデータがブラインドで上書きされます。

Methods

batchDelete

 アラートに対して一括削除オペレーションを実行します。

batchUndelete

 アラートに対して一括削除の取り消しオペレーションを実行します。

delete

 指定されたアラートに削除マークを付けます。

get

 指定されたアラートを取得します。

getMetadata

 アラートのメタデータを返します。

list

 アラートを一覧表示します。

undelete

 過去 30 日以内に削除としてマークされたアラートを復元（または「削除取り消し」）します。