Method: notes.list

清單記事。

每個清單呼叫都會傳回結果頁面,且傳回項目的邊界會以 pageSize 表示。如果 pageSize 為零,伺服器即可選擇上限。

ListNotesResponse 最多包含 pageSize 個項目。如果還要列出更多項目,則會提供 nextPageToken 值。(頁面符記為不透明值。)

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

Notes.list 會在並行變更時傳回一致的結果,或是無法產生 ABORTED 錯誤的信號。

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

詳情請參閱授權指南