Method: alerts.list

列出警報。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
customerId

string

選用設定。與警示相關聯的客戶 Google Workspace 帳戶專屬 ID。customerId 必須移除開頭的「C」(例如 046psxkn)。如果未提供,系統會從呼叫端身分推斷。查看客戶 ID

pageSize

integer

選用設定。所要求的頁面大小。伺服器傳回的項目數量可能會少於要求的項目數量。如未指定,伺服器會挑選適當的預設值。

pageToken

string

選用設定。這個符記可識別伺服器應傳回的結果頁面。如果為空,則會啟動新的迭代。如要繼續迭代,請傳入先前 ListAlertsResponse 的 nextPageToken 欄位值。

filter

string

選用設定。用於篩選快訊結果的查詢字串。詳情請參閱「查詢篩選器」和「支援的查詢篩選器欄位」。

orderBy

string

選用設定。清單結果的排序順序。如果未指定,結果可能會以任意順序傳回。您可以使用 orderBy="createTime desc",根據建立時間戳記以遞減順序排序結果。目前支援的排序方式為 createTime asccreateTime descupdateTime desc

要求主體

要求主體必須為空白。

回應主體

快訊清單要求的回應訊息。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "alerts": [
    {
      object (Alert)
    }
  ],
  "nextPageToken": string
}
欄位
alerts[]

object (Alert)

快訊清單。

nextPageToken

string

下一頁的符記。如果不為空白,表示可能還有其他符合清單要求的快訊;這個值可在後續的 ListAlertsRequest 中使用,以便從目前的清單呼叫的最後結果繼續取得快訊。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱授權指南