Method: projects.databases.documents.beginTransaction

Démarre une nouvelle transaction.

Requête HTTP

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

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 
{
  "options": {
    object (TransactionOptions)
  }
}
Champs
options

object (TransactionOptions)

Options de la transaction. La valeur par défaut est une transaction en lecture-écriture.

Corps de la réponse

Réponse pour Firestore.BeginTransaction.

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
}
Champs
transaction

string (bytes format)

Transaction qui a démarré.

Chaîne encodée en base64.

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.