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

詳情請參閱授權指南。