Method: projects.databases.documents.listCollectionIds

列出文档下的所有集合 ID。

HTTP请求

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

URL 使用gRPC 转码语法。

路径参数

参数
parent

string

必需的。父文档。格式为: projects/{projectId}/databases/{databaseId}/documents/{document_path} 。例如: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

请求正文

请求正文包含具有以下结构的数据:

JSON 表示
{
  "pageSize": integer,
  "pageToken": string,

  // Union field consistency_selector can be only one of the following:
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
领域
pageSize

integer

要返回的最大结果数。

pageToken

string

页面令牌。必须是ListCollectionIdsResponse中的值。

联合字段consistency_selector 。此请求的一致性模式。如果不设置,默认为强一致性。 consistency_selector只能是以下之一:
readTime

string ( Timestamp format)

按给定时间的原样读取文档。

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

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

响应体

来自Firestore.ListCollectionIds的响应。

如果成功,响应正文包含具有以下结构的数据:

JSON 表示
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
领域
collectionIds[]

string

集合 ID。

nextPageToken

string

可用于继续列表的页面令牌。

授权范围

需要以下 OAuth 范围之一:

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

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