Method: projects.databases.documents.get

Recupera un singolo documento.

Richiesta HTTP

GET https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*/documents/*/**}

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatoria. Il nome della risorsa del documento da recuperare. Nel formato: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Parametri di ricerca

Parametri
mask

object (DocumentMask)

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

Se il documento ha un campo che non è presente in questa maschera, quel campo non verrà restituito nella risposta.
Parametro 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 il documento in una transazione.

Una stringa con codifica Base64.
readTime

string (Timestamp format)

Legge la versione del documento nel 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 richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Document.

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.