Method: projects.databases.documents.listCollectionIds

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

string

Erforderlich. Das übergeordnete Dokument. Im Format: projects/{projectId}/databases/{databaseId}/documents/{document_path}. Beispiel: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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.
}
Felder
pageSize

integer

Die maximale Anzahl von zurückzugebenden Ergebnissen.
pageToken

string

Ein Seitentoken. Muss ein Wert aus ListCollectionIdsResponse sein.
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

string (Timestamp format)

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: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

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[]

string

Die Sammlungs-IDs.
nextPageToken

string

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.