このページは Cloud Translation API によって翻訳されました。
Switch to English

メソッド:projects.databases.documents.commit

オプションでドキュメントを更新しながら、トランザクションをコミットします。

HTTPリクエスト

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

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

パスパラメータ

パラメーター
database

string

必須。データベース名。形式: projects/{project_id}/databases/{database_id}

リクエストボディ

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

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

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