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 篩選器。有效的篩選欄位為:createTime 、updateTime 、trashTime 和 trashed 。 篩選器語法遵循 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
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[],[],null,["# Method: notes.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListNotesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nLists notes.\n\nEvery list call returns a page of results with `pageSize` as the upper bound of returned items. A `pageSize` of zero allows the server to choose the upper bound.\n\nThe ListNotesResponse contains at most `pageSize` entries. If there are more things left to list, it provides a `nextPageToken` value. (Page tokens are opaque values.)\n\nTo get the next page of results, copy the result's `nextPageToken` into the next request's `pageToken`. Repeat until the `nextPageToken` returned with a page of results is empty.\n\nnotes.list return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.\n\n### HTTP request\n\n`GET https://keep.googleapis.com/v1/notes`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of results to return. |\n| `pageToken` | `string` The previous page's `nextPageToken` field. |\n| `filter` | `string` Filter for list results. If no filter is supplied, the `trashed` filter is applied by default. Valid fields to filter by are: `createTime`, `updateTime`, `trashTime`, and `trashed`. Filter syntax follows the [Google AIP filtering spec](https://aip.dev/160). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response when listing a page of notes.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------|\n| ``` { \"notes\": [ { object (/workspace/keep/api/reference/rest/v1/notes#Note) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------|\n| `notes[]` | `object (`[Note](/workspace/keep/api/reference/rest/v1/notes#Note)`)` A page of notes. |\n| `nextPageToken` | `string` Next page's `pageToken` field. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/keep`\n- `https://www.googleapis.com/auth/keep.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]