Method: projects.databases.documents.list

列出文档。

HTTP请求

GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}

URL 使用gRPC 转码语法。

路径参数

参数
parent

string

必需的。父资源名称。格式为: projects/{projectId}/databases/{databaseId}/documentsprojects/{projectId}/databases/{databaseId}/documents/{document_path}

例如: projects/my-project/databases/my-database/documentsprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom

collectionId

string

选修的。要列出的集合 ID,相对于parent

例如: chatroomsmessages

这是可选的,如果未提供,Firestore 将列出所提供的parent下所有集合中的文档。

查询参数

参数
pageSize

integer

选修的。单个响应中返回的最大文档数。

Firestore 返回的值可能会少于此值。

pageToken

string

选修的。从先前的documents.list响应接收到的页面令牌。

提供此信息以检索后续页面。分页时,所有其他参数( pageSize除外)必须与生成页面令牌的请求中设置的值匹配。

orderBy

string

选修的。要返回的文档的可选排序。

例如: priority desc, __name__ desc

这反映了 Firestore 查询中使用的ORDER BY ,但采用字符串表示形式。如果不存在,文档将根据__name__ ASC排序。

mask

object ( DocumentMask )

选修的。要返回的字段。如果未设置,则返回所有字段。

如果文档具有此掩码中不存在的字段,则该字段将不会在响应中返回。

showMissing

boolean

如果列表应显示缺少的文档。

如果文档不存在,则该文档缺失,但其下面嵌套有子文档。如果为 true,则此类丢失的文档将带有键返回,但不会设置字段、 createTimeupdateTime

带有showMissing请求可能不会指定whereorderBy

联合参数consistency_selector 。此事务的一致性模式。如果不设置,默认为强一致性。 consistency_selector只能是以下之一:
transaction

string ( bytes format)

将读取作为已活动事务的一部分执行。

Base64 编码的字符串。

readTime

string ( Timestamp format)

在规定的时间执行读取。

这必须是过去一小时内的微秒精度时间戳,或者如果启用了时间点恢复,则还可以是过去 7 天内的整分钟时间戳。

RFC3339 UTC“Zulu”格式的时间戳,具有纳秒分辨率和最多九个小数位。示例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

请求正文

请求正文必须为空。

响应体

如果成功,响应正文将包含ListDocumentsResponse的实例。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述