Method: projects.databases.documents.batchWrite

套用批次寫入作業。

Document.batchWrite 方法不會以不可分割的形式套用寫入作業，而且會依序套用寫入作業，此方法不允許每份文件執行多次寫入。每項寫入作業成功或失敗。如要瞭解每次寫入的成功狀態，請參閱 BatchWriteResponse。

如果您需要以不可分割的形式套用一組寫入，請改用 documents.commit。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
database

string

執行個體類型，資料庫名稱。請採用下列格式：projects/{projectId}/databases/{databaseId}。

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
欄位
writes[]

object (Write)

要套用的寫入作業。

方法不會以不可分割的形式套用寫入，亦不保證排序。每項寫入作業成功或失敗。每次要求只能寫入同一份文件一次。
labels

map (key: string, value: string)

與這項批次寫入作業相關聯的標籤。

包含 "key": value 組合清單的物件。範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

回應主體

Firestore.BatchWrite 的回應。

如果執行成功，回應主體中會有結構如下的資料：

JSON 表示法 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
欄位
writeResults[]

object (WriteResult)

套用寫入的結果。

這項 i-th 寫入結果與要求中的 i-th 寫入對應。
status[]

object (Status)

套用寫入的狀態。

此 i-th 寫入狀態與要求中的 i-th 寫入對應。

授權範圍

需要下列其中一種 OAuth 範圍：

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

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