Method: projects.databases.documents.listDocuments

string

Erforderlich. Der Name der übergeordneten Ressource. Im Format: projects/{projectId}/databases/{databaseId}/documents oder projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Beispiel: projects/my-project/databases/my-database/documents oder projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

Optional. Die Sammlungs-ID, relativ zu parent, die aufgelistet werden soll.

Beispiel: chatrooms oder messages.

Dies ist optional. Wenn keine Angabe erfolgt, listet Firestore Dokumente aus allen Sammlungen unter der angegebenen parent auf.

integer

Optional. Die maximale Anzahl von Dokumenten, die in einer einzelnen Antwort zurückgegeben werden sollen.

Firestore gibt möglicherweise weniger als diesen Wert zurück.

string

Optional. Ein Seitentoken, das von einer vorherigen documents.list-Antwort empfangen wurde.

Geben Sie diese an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen Parameter (mit Ausnahme von pageSize) mit den Werten übereinstimmen, die in der Anfrage festgelegt wurden, mit der das Seitentoken generiert wurde.

string

Optional. Die optionale Reihenfolge der zurückzugebenden Dokumente.

Beispiel: priority desc, __name__ desc.

Dies spiegelt die ORDER BY wider, die in Firestore-Abfragen verwendet wird, aber in einer Stringdarstellung. Wenn keine vorhanden sind, werden die Dokumente nach __name__ ASC sortiert.

object (DocumentMask)

Optional. Die zurückzugebenden Felder. Wenn nicht festgelegt, werden alle Felder zurückgegeben.

Wenn ein Dokument ein Feld enthält, das in dieser Maske nicht vorhanden ist, wird dieses Feld nicht in der Antwort zurückgegeben.

boolean

Gibt an, ob in der Liste fehlende Dokumente angezeigt werden sollen.

Ein Dokument fehlt, wenn es nicht existiert, aber darunter sind Unterdokumente verschachtelt. Wenn dieser Wert auf „true“ gesetzt ist, werden solche Dokumente mit einem Schlüssel zurückgegeben. Es sind jedoch keine Felder, createTime oder updateTime festgelegt.

Anfragen mit showMissing dürfen nicht where oder orderBy enthalten.

string (bytes format)

Führt den Lesevorgang als Teil einer bereits aktiven Transaktion aus.

Ein base64-codierter String.

string (Timestamp format)

Führe den Lesevorgang zur angegebenen Zeit aus.

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".