Method: projects.databases.documents.beginTransaction

Inicia uma nova transação.

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
database

string

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

Solicitar corpo

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 para a transação. O padrão é uma transação de leitura e gravação.

Corpo de resposta

A resposta para Firestore.BeginTransaction .

Se for bem-sucedido, o corpo da resposta conterá dados com a seguinte estrutura:

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 OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .