Method: projects.databases.documents.commit

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

HTTPリクエスト

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

URL はgRPC トランスコーディング構文を使用します。

パスパラメータ

パラメーター
database

string

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

リクエストボディ

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

JSON表現
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
田畑
writes[]

object ( Write )

適用する書き込み。

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

transaction

string ( bytes format)

設定すると、このトランザクション内のすべての書き込みが適用され、コミットされます。

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

レスポンスボディ

Firestore.Commitの応答。

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

JSON表現
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
田畑
writeResults[]

object ( WriteResult )

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

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

commitTime

string ( Timestamp format)

コミットが発生した時刻。 readTime以上の読み取りでは、コミットの効果が保証されます。

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

詳細については、 「認証の概要」を参照してください。