Method: projects.databases.documents.batchWrite

書き込み操作のバッチを適用します。

document.batchWrite メソッドは書き込み操作をアトミックに適用せず、順不同で適用する可能性があります。このメソッドでは、ドキュメントごとに複数の書き込みは許可されません。各書き込みは独立して成功または失敗します。各書き込みの成功ステータスについては、 BatchWriteResponse参照してください。

アトミックに適用される一連の書き込みが必要な場合は、代わりにdocuments.commitを使用してください。

HTTPリクエスト

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

URL は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 番目の書き込み結果は、リクエスト内の i 番目の書き込みに対応します。

status[]

object ( Status )

書き込みの適用ステータス。

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

認可範囲

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

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

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