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 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

詳情請參閱授權指南。