Method: projects.databases.documents.beginTransaction

Avvia una nuova transazione.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
database

string

Obbligatoria. Il nome del database. Nel formato: projects/{projectId}/databases/{databaseId}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "options": {
    object (TransactionOptions)
  }
}
Campi
options

object (TransactionOptions)

Le opzioni per la transazione. Il valore predefinito è una transazione di lettura-scrittura.

Corpo della risposta

La risposta per Firestore.BeginTransaction.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "transaction": string
}
Campi
transaction

string (bytes format)

La transazione avviata.

Una stringa con codifica Base64.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.