Method: projects.databases.documents.batchGet

Recupera più documenti.

Non è garantito che i documenti restituiti con questo metodo vengano restituiti nello stesso ordine in cui sono stati richiesti.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
database

string

Obbligatoria. Il nome del database. Nel formato: projects/{projectId}/databases/{databaseId}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "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.
}
Campi
documents[]

string

I nomi dei documenti da recuperare. Nel formato: projects/{projectId}/databases/{databaseId}/documents/{document_path}. La richiesta avrà esito negativo se uno qualsiasi del documento non è una risorsa secondaria del database specificato. I nomi duplicati verranno eliminati.
mask

object (DocumentMask)

I campi da restituire. Se non viene configurato, restituisce tutti i campi.

Se un documento ha un campo che non è presente in questa maschera, quel campo non verrà restituito nella risposta.
Campo di unione consistency_selector. La modalità di coerenza per questa transazione. Se non viene configurato, il valore predefinito è elevata coerenza. consistency_selector può essere solo uno dei seguenti:
transaction

string (bytes format)

Legge i documenti di una transazione.

Una stringa con codifica Base64.
newTransaction

object (TransactionOptions)

Avvia una nuova transazione e legge i documenti. Il valore predefinito è una transazione di sola lettura. Il nuovo ID transazione verrà restituito come prima risposta nel flusso.
readTime

string (Timestamp format)

Legge i documenti così come erano al momento specificato.

Deve essere un timestamp con precisione in microsecondi risalente all'ultima ora oppure, se il recupero point-in-time è abilitato, può essere anche un timestamp di un minuto intero compreso negli ultimi 7 giorni.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Corpo della risposta

La risposta riprodotta in streaming per Firestore.BatchGetDocuments.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "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.
}
Campi
transaction

string (bytes format)

La transazione avviata nell'ambito di questa richiesta. Verrà impostato solo nella prima risposta e solo se BatchGetDocumentsRequest.new_transaction è stato impostato nella richiesta.

Una stringa con codifica Base64.
readTime

string (Timestamp format)

L'ora in cui il documento è stato letto. La variazione potrebbe aumentare monoticamente. In questo caso, infatti, i documenti precedenti nel flusso dei risultati sono garantiti che non siano cambiati tra il valore readTime e quello attuale.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
Campo di unione result. Un unico risultato. Questo campo può essere vuoto se il server restituisce solo una transazione. result può essere solo uno dei seguenti:
found

object (Document)

Un documento richiesto.
missing

string

Un nome documento che è stato richiesto, ma non esiste. Nel formato: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.