Method: alerts.list

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

HTTP リクエスト

GET https://alertcenter.googleapis.com/v1beta1/alerts

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
customerId

string

省略可。アラートが関連付けられているお客様の Google Workspace アカウントの一意の識別子。customerId の先頭の「C」は削除する必要があります（例: 046psxkn）。指定されていない場合は、呼び出し元の ID から推測されます。お客様 ID を確認する。
pageSize

integer

省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。このパラメータを指定しないと、サーバーは適切なデフォルト値を選択します。
pageToken

string

省略可。サーバーが返す必要がある結果のページを特定するトークンです。 空の場合は、新しい反復処理が開始されます。イテレーションを続行するには、前の ListAlertsResponse の nextPageToken フィールドの値を渡します。
filter

string

省略可。アラート結果をフィルタリングするためのクエリ文字列。詳細については、クエリフィルタとサポートされているクエリフィルタ フィールドをご覧ください。
orderBy

string

省略可。リスト結果の並べ替え順序。指定しない場合、結果は任意の順序で返されることがあります。orderBy="createTime desc" を使用して、作成タイムスタンプに基づいて結果を降順に並べ替えることができます。現在、サポートされている並べ替えは createTime asc、createTime desc、updateTime desc です。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

アラート リスト リクエストに対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "alerts": [
    {
      object (Alert)
    }
  ],
  "nextPageToken": string
}
フィールド
alerts[]

object (Alert)

アラートのリスト。
nextPageToken

string

次のページのトークン。空でない場合、リスティング リクエストに一致するアラートが他にもある可能性があることを示します。この値は、後続の ListAlertsRequest で使用して、現在のリスト呼び出しの最後の結果から続くアラートを取得できます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/apps.alerts

詳しくは、認可ガイドをご覧ください。