Method: projects.databases.documents.commit

修訂交易，並視需要更新文件。

HTTP 要求

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

這個網址使用 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-th 寫入結果與要求中的 i-th 寫入對應。
commitTime

string (Timestamp format)

修訂版本發生的時間。只要 readTime 等於或大於此值，就保證能看到修訂版本的效果。

RFC3339 世界標準時間「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

詳情請參閱驗證總覽一文。