Method: projects.databases.documents.get

Récupère un seul document.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de ressource du document à récupérer. Format à respecter: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Paramètres de requête

Paramètres
mask

object (DocumentMask)

Champs à renvoyer. Si ce champ n'est pas spécifié, tous les champs sont renvoyés.

Si le document comporte un champ qui n'est pas présent dans ce masque, il ne sera pas renvoyé dans la réponse.
Paramètre d'union consistency_selector. Mode de cohérence pour cette transaction. Si ce champ n'est pas spécifié, la valeur par défaut est la cohérence forte. consistency_selector ne peut être qu'un des éléments suivants :
transaction

string (bytes format)

Lit le document dans une transaction.

Chaîne encodée en base64.
readTime

string (Timestamp format)

Lit la version du document à l'heure donnée.

Il doit s'agir d'un horodatage de précision de l'ordre de la microseconde au cours de la dernière heure. Si la récupération à un moment précis est activée, il peut également s'agir d'un horodatage d'une minute entière datant des sept derniers jours.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Document.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.