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

The database name. In the format: projects/{project_id}/databases/{database_id}.

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

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

The response for Firestore.Commit.

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.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

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.

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...