Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
このページは Cloud Translation API によって翻訳されました。
Switch to English

Method: projects.databases.documents.batchWrite

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

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

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

HTTPリクエスト

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

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

パスパラメータ

パラメーター
database

string

必須。データベース名。形式: projects/{project_id}/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

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