Method: projects.databases.documents.commit

Valide une transaction et met à jour des documents si vous le souhaitez.

Requête HTTP

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

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 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
Champs
writes[]

object (Write)

Écritures à appliquer.

Toujours exécuté de manière atomique et dans l'ordre.
transaction

string (bytes format)

Si cette option est définie, elle applique toutes les écritures de cette transaction et la valide.

Chaîne encodée en base64.

Corps de la réponse

Réponse pour Firestore.Commit.

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

Représentation JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
Champs
writeResults[]

object (WriteResult)

Résultat de l'application des écritures.

Cette i-ième écriture correspond à l'i-ième écriture de la requête.
commitTime

string (Timestamp format)

Heure à laquelle le commit a été effectué. Toute lecture avec un readTime égal ou supérieur affiche les effets du commit.

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".

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.