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 过滤器。可用于过滤的有效字段包括: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
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):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)."]]