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)

這個外掛程式能在指定時間讀取文件。

這個值必須是過去 1 小時內的微秒精確度，如果已啟用「時間點復原」功能，則可以是過去 7 天內的整分鐘時間戳記。

採用 RFC3339 世界標準時間「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

詳情請參閱驗證總覽。