Method: projects.databases.documents.beginTransaction

Inicia una nueva transacción.

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
database	string Requerido. 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 ) Las opciones para la transacción. El valor predeterminado es una transacción de lectura y escritura.

Cuerpo de respuesta

La respuesta para Firestore.BeginTransaction .

Si tiene éxito, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{ "transaction": string }

Campos
transaction	string ( bytes format) La transacción que se inició. Una cadena codificada en base64.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

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

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