Lists all the collection IDs underneath a document.
HTTP request
POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}:listCollectionIds
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent document. In the format: |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "pageSize": integer, "pageToken": string, // Union field |
Fields | |
---|---|
pageSize |
The maximum number of results to return. |
pageToken |
A page token. Must be a value from |
Union field consistency_selector . The consistency mode for this request. If not set, defaults to strong consistency. consistency_selector can be only one of the following: |
|
readTime |
Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
Response body
The response from Firestore.ListCollectionIds
.
If successful, the response body contains data with the following structure:
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/datastore
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.