Method: notes.list

列出附註。

每個清單呼叫都會傳回一個結果頁面,其中 pageSize 是傳回項目的上限。pageSize 為零時,伺服器會選擇上限。

ListNotesResponse 最多包含 pageSize 個項目。如果還有其他項目要列出,則會提供 nextPageToken 值。(網頁權杖是不可辨識的值)。

如要取得下一頁結果,請將結果的 nextPageToken 複製到下一個要求的 pageToken。重複執行,直到 nextPageToken 傳回的結果頁面為空白為止。

notes.list 會在並行變更的情況下傳回一致的結果,或傳送無法傳回結果的訊號,並顯示「已中止」錯誤。

HTTP 要求

GET https://keep.googleapis.com/v1/notes

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

查詢參數

參數
pageSize

integer

要傳回的結果數上限。

pageToken

string

上一頁的 nextPageToken 欄位。

filter

string

篩選清單結果。如果未提供篩選器,系統會預設套用 trashed 篩選器。有效的篩選欄位為:createTimeupdateTimetrashTimetrashed

篩選器語法遵循 Google AIP 篩選規格

要求主體

要求主體必須為空白。

回應主體

列出筆記頁面時的回應。

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

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

object (Note)

一頁筆記。

nextPageToken

string

下一頁的 pageToken 欄位。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/keep
  • https://www.googleapis.com/auth/keep.readonly

詳情請參閱授權指南