Method: projects.databases.documents.beginTransaction

Inicia una transacción nueva.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
database

string

Obligatorio. Es el nombre de la base de datos. En el formato: projects/{projectId}/databases/{databaseId}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "options": {
    object (TransactionOptions)
  }
}
Campos
options

object (TransactionOptions)

Son las opciones de la transacción. La configuración predeterminada es una transacción de lectura y escritura.

Cuerpo de la respuesta

La respuesta para Firestore.BeginTransaction.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "transaction": string
}
Campos
transaction

string (bytes format)

Es la transacción que se inició.

String codificada en base64.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.