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

有关详情,请参阅授权指南