Method: projects.databases.documents.commit

Confirma uma transação, enquanto opcionalmente atualiza documentos.

Solicitação HTTP

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

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
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
Campos
writes[]

object ( Write )

As escritas para aplicar.

Sempre executado atomicamente e em ordem.

transaction

string ( bytes format)

Se definido, aplica todas as gravações nesta transação e a confirma.

Uma string codificada em base64.

Corpo de resposta

A resposta para Firestore.Commit .

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

Representação JSON
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
Campos
writeResults[]

object ( WriteResult )

O resultado da aplicação das gravações.

Este i-ésimo resultado de gravação corresponde à i-ésima gravação na solicitação.

commitTime

string ( Timestamp format)

A hora em que o commit ocorreu. Qualquer leitura com um readTime igual ou maior verá os efeitos do commit.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

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 .