Ruft ein einzelnes Dokument ab.
HTTP-Anfrage
GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
| Parameter | |
|---|---|
name |
Erforderlich. Der Ressourcenname des abzurufenden Dokuments. Im Format: |
Abfrageparameter
| Parameter | |
|---|---|
mask |
Die zurückzugebenden Felder. Wenn nicht festgelegt, werden alle Felder zurückgegeben. Wenn das Dokument ein Feld enthält, das in dieser Maske nicht vorhanden ist, wird dieses Feld nicht in der Antwort zurückgegeben. |
Union-Parameter consistency_selector. Der Konsistenzmodus für diese Transaktion. Wenn nichts festgelegt ist, wird standardmäßig „Strong Consistency“ verwendet. Für consistency_selector ist nur einer der folgenden Werte zulässig: |
|
transaction |
Liest das Dokument in einer Transaktion. Ein base64-codierter String. |
readTime |
Liest die Version des Dokuments zum angegebenen Zeitpunkt. 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: |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Document.
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
Weitere Informationen finden Sie in der Authentifizierungsübersicht.