Listet alle Sammlungs-IDs unter einem Dokument auf.
HTTP-Anfrage
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
parent |
Erforderlich. Das übergeordnete Dokument. Im Format: |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "pageSize": integer, "pageToken": string, // Union field |
Felder | |
---|---|
pageSize |
Die maximale Anzahl von zurückzugebenden Ergebnissen. |
pageToken |
Ein Seitentoken. Muss ein Wert aus |
Union-Feld consistency_selector . Der Konsistenzmodus für diese Anfrage. Wenn nichts festgelegt ist, wird standardmäßig „Strong Consistency“ verwendet. Für consistency_selector ist nur einer der folgenden Werte zulässig: |
|
readTime |
Liest Dokumente so, wie sie zum jeweiligen Zeitpunkt waren. Dabei muss es sich um einen Zeitstempel mit einer Genauigkeit von Mikrosekunden innerhalb der letzten Stunde handeln. Wenn die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist, kann zusätzlich ein Zeitstempel einer ganzen Minute innerhalb der letzten 7 Tage angegeben werden. Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
Antworttext
Die Antwort von Firestore.ListCollectionIds
.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{ "collectionIds": [ string ], "nextPageToken": string } |
Felder | |
---|---|
collectionIds[] |
Die Sammlungs-IDs. |
nextPageToken |
Ein Seitentoken, mit dem die Liste fortgesetzt werden kann. |
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Weitere Informationen finden Sie in der Authentifizierungsübersicht.