Method: projects.databases.documents.beginTransaction

Startet eine neue Transaktion.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
database

string

Erforderlich. Der Datenbankname. Im Format: projects/{projectId}/databases/{databaseId}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "options": {
    object (TransactionOptions)
  }
}
Felder
options

object (TransactionOptions)

Die Optionen für die Transaktion. Die Standardeinstellung ist eine Lese-Schreib-Transaktion.

Antworttext

Die Antwort für Firestore.BeginTransaction.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "transaction": string
}
Felder
transaction

string (bytes format)

Die gestartete Transaktion.

Ein base64-codierter String.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.