Method: projects.databases.documents.batchWrite

書き込みオペレーションのバッチを適用します。

Docs.batchWrite メソッドは、書き込みオペレーションをアトミックに適用せず、順不同で適用できます。このメソッドはドキュメントごとに複数回の書き込みに対応していません。各書き込みは個別に成功または失敗します。各書き込みの成功ステータスについては、BatchWriteResponse をご覧ください。

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

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
database

string

必須。データベース名。形式は projects/{projectId}/databases/{databaseId} です。

リクエスト本文

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

JSON 表現 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
フィールド
writes[]

object (Write)

適用する書き込み。

メソッドは書き込みをアトミックに適用せず、順序を保証するものではありません。各書き込みは個別に成功または失敗します。1 回のリクエストで、同じドキュメントに複数回書き込むことはできません。
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

詳細については、認証の概要をご覧ください。