Method: projects.databases.documents.beginTransaction

Inicia uma nova transação.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
database

string

Obrigatório. O nome do banco de dados. Use o formato: projects/{projectId}/databases/{databaseId}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "options": {
    object (TransactionOptions)
  }
}
Campos
options

object (TransactionOptions)

As opções da transação. O padrão é uma transação de leitura e gravação.

Corpo da resposta

A resposta para Firestore.BeginTransaction.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "transaction": string
}
Campos
transaction

string (bytes format)

A transação que foi iniciada.

Uma string codificada em base64.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.