Method: projects.databases.documents.commit

トランザクションを commit し、必要に応じてドキュメントを更新します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
database

string

必須。データベース名。形式は projects/{projectId}/databases/{databaseId} です。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
フィールド
writes[]

object (Write)

適用する書き込み。

常にアトミックかつ順番に実行されます。
transaction

string (bytes format)

設定すると、このトランザクション内のすべての書き込みを適用して commit します。

Base64 でエンコードされた文字列。

レスポンスの本文

Firestore.Commit に対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
フィールド
writeResults[]

object (WriteResult)

書き込みを適用した結果。

この i 番目の書き込み結果は、リクエストの i 番目の書き込みに対応します。
commitTime

string (Timestamp format)

commit が発生した時刻。readTime 以上で読み取ると、commit の効果が保証されます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。