Method: projects.databases.documents.batchGet

Récupère plusieurs documents.

Il n'est pas garanti que les documents renvoyés par cette méthode s'affichent dans le même ordre que celui demandé.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
database

string

Obligatoire. Nom de la base de données. Format à respecter: projects/{projectId}/databases/{databaseId}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
documents[]

string

Noms des documents à récupérer. Format à respecter: projects/{projectId}/databases/{databaseId}/documents/{document_path}. La requête échoue si l'un des documents n'est pas une ressource enfant de l'élément database donné. Les noms en double sont supprimés.
mask

object (DocumentMask)

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

Si un document comporte un champ qui n'est pas présent dans ce masque, ce champ n'est pas renvoyé dans la réponse.
Champ 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 les documents d'une transaction.

Chaîne encodée en base64.
newTransaction

object (TransactionOptions)

Démarre une nouvelle transaction et lit les documents. La valeur par défaut est une transaction en lecture seule. Le nouvel ID de transaction est renvoyé en tant que première réponse dans le flux.
readTime

string (Timestamp format)

Lit les documents tels qu'ils étaient à l'époque.

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 réponse

Réponse diffusée pour Firestore.BatchGetDocuments.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation 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.
}
Champs
transaction

string (bytes format)

Transaction démarrée dans le cadre de cette requête. Ne sera défini que dans la première réponse, et uniquement si BatchGetDocumentsRequest.new_transaction a été défini dans la requête.

Chaîne encodée en base64.
readTime

string (Timestamp format)

Heure à laquelle le document a été lu. Cette valeur peut augmenter de façon linéaire. Dans ce cas, il est garanti que les documents précédents dans le flux de résultats n'ont pas changé entre leur readTime et celui-ci.

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".
Champ d'union result. Un seul résultat. Ce champ peut être vide si le serveur ne fait que renvoyer une transaction. result ne peut être qu'un des éléments suivants :
found

object (Document)

Un document demandé.
missing

string

Nom de document demandé, mais qui n'existe pas. Format à respecter: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

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.