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

如需了解详情，请参阅授权指南。