Method: projects.databases.documents.listCollectionIds

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

HTTP 请求

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

网址采用 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)（即“祖鲁时”）格式的时间戳，采用纳秒级精度，最多包含九个小数位。示例："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

如需了解详情，请参阅身份验证概览。