Lists all the collection IDs underneath a document.
HTTP request
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
parent |
The parent document. In the format: |
Request body
The request body contains data with the following structure:
| JSON representation | |
|---|---|
{ "pageSize": number, "pageToken": string } |
|
| Fields | |
|---|---|
pageSize |
The maximum number of results to return. |
pageToken |
A page token. Must be a value from |
Response body
If successful, the response body contains data with the following structure:
The response from Firestore.ListCollectionIds.
| JSON representation | |
|---|---|
{ "collectionIds": [ string ], "nextPageToken": string } |
|
| Fields | |
|---|---|
collectionIds[] |
The collection ids. |
nextPageToken |
A page token that may be used to continue the list. |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
ご不明な点がありましたら、Google の