Diese Seite wurde von der Cloud Translation API übersetzt.

Method: projects.databases.documents.batchGet

Ruft mehrere Dokumente ab.

Bei von dieser Methode zurückgegebenen Dokumenten kann nicht garantiert werden, dass sie in derselben Reihenfolge zurückgegeben werden, in der sie angefordert wurden.

HTTP-Anfrage

POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter

Parameter
`database`	`string` Erforderlich. Der Datenbankname. Im Format: `projects/{projectId}/databases/{databaseId}`.

database

string

Erforderlich. Der Datenbankname. Im Format: projects/{projectId}/databases/{databaseId}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung

JSON-Darstellung
{ "documents": [ string ], "mask": { object (`DocumentMask`) }, // Union field `consistency_selector` can be only one of the following: "transaction": string, "newTransaction": { object (`TransactionOptions`) }, "readTime": string // End of list of possible types for union field `consistency_selector`. }

{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}

Felder
`documents[]`	`string` Die Namen der abzurufenden Dokumente. Im Format: `projects/{projectId}/databases/{databaseId}/documents/{document_path}`. Die Anfrage schlägt fehl, wenn eines der Dokumente keine untergeordnete Ressource des angegebenen `database` ist. Doppelte Namen werden entfernt.
`mask`	`object (DocumentMask)` 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.
Union-Feld `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`	`string (bytes format)` Liest Dokumente in einer Transaktion. Ein base64-codierter String.
`newTransaction`	`object (TransactionOptions)` Startet eine neue Transaktion und liest die Dokumente. Die Standardeinstellung ist eine schreibgeschützte Transaktion. Die neue Transaktions-ID wird als erste Antwort im Stream zurückgegeben.
`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 gestreamte Antwort für Firestore.BatchGetDocuments.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung

JSON-Darstellung
{ "transaction": string, "readTime": string, // Union field `result` can be only one of the following: "found": { object (`Document`) }, "missing": string // End of list of possible types for union field `result`. }

{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}

Felder
`transaction`	`string (bytes format)` Die Transaktion, die im Rahmen dieser Anfrage gestartet wurde. Wird nur in der ersten Antwort und nur dann festgelegt, wenn in der Anfrage `BatchGetDocumentsRequest.new_transaction` festgelegt wurde. Ein base64-codierter String.
`readTime`	`string (Timestamp format)` Der Zeitpunkt, zu dem das Dokument gelesen wurde. Dieser Wert kann kontinuierlich ansteigen. In diesem Fall ist garantiert, dass sich die vorherigen Dokumente im Ergebnisstream zwischen ihrer readTime und diesem geändert haben. 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"`.
Union-Feld `result`. Ein einzelnes Ergebnis. Dieses Feld kann leer sein, wenn der Server nur eine Transaktion zurückgibt. Für `result` ist nur einer der folgenden Werte zulässig:
`found`	`object (Document)` Ein angefordertes Dokument.
`missing`	`string` Ein Dokumentname, der angefordert wurde, aber nicht vorhanden ist. Im Format: `projects/{projectId}/databases/{databaseId}/documents/{document_path}`.

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.