Method: projects.databases.documents.commit

Confirma uma transação e atualiza os documentos opcionalmente.

Solicitação HTTP

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

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

object (Write)

As gravações a serem aplicadas.

Sempre executado atomicamente e em ordem.
transaction

string (bytes format)

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

Uma string codificada em base64.

Corpo da resposta

A resposta para Firestore.Commit.

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

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

object (WriteResult)

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

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

string (Timestamp format)

O horário em que a confirmação ocorreu. Qualquer leitura com um readTime igual ou maior garante a visualização dos efeitos da confirmação.

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 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.