Method: projects.databases.documents.commit

Commits a transaction, while optionally updating documents.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
database

string

Required. The database name. In the format: projects/{projectId}/databases/{databaseId}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
Fields
writes[]

object (Write)

The writes to apply.

Always executed atomically and in order.
transaction

string (bytes format)

If set, applies all writes in this transaction, and commits it.

A base64-encoded string.

Response body

The response for Firestore.Commit.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
Fields
writeResults[]

object (WriteResult)

The result of applying the writes.

This i-th write result corresponds to the i-th write in the request.
commitTime

string (Timestamp format)

The time at which the commit occurred. Any read with an equal or greater readTime is guaranteed to see the effects of the commit.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.