Method: documents.batchUpdate

ドキュメントに 1 つ以上の更新を適用します。

各 request は、適用前に検証されます。リクエストのいずれかが有効でない場合、リクエスト全体が失敗し、何も適用されません。

一部のリクエストには、その適用方法に関する情報を提供する replies が含まれています。それ以外のリクエストに対して情報を返す必要はありません。どのリクエストも空の返信を返します。返信の順序は、リクエストの順番と一致します。

たとえば、batchUpdate で 4 つの更新を行い、3 つ目のみに情報を返すとします。レスポンスでは、2 つの空の返信、3 番目のリクエストに対する返信、別の空の返信が順番に行われます。

他のユーザーがドキュメントを編集している可能性があるため、変更は自分のドキュメントには反映されない場合があります。つまり、共同編集者による変更に対してドキュメントの変更が行われる可能性があります。共同編集者がいない場合は、ドキュメントに変更が反映されます。いずれの場合も、リクエストの更新はアトミックに適用されることが保証されます。

HTTP リクエスト

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

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

パスパラメータ

パラメータ
documentId

string

更新するドキュメントの ID。

リクエスト本文

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

JSON 表現 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
フィールド
requests[]

object (Request)

ドキュメントに適用する更新のリスト。
writeControl

object (WriteControl)

書き込みリクエストの実行方法を制御します。

レスポンスの本文

documents.batchUpdate リクエストからのレスポンス メッセージ。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
フィールド
documentId

string

更新が適用されたドキュメントの ID。
replies[]

object (Response)

更新情報の返信。これにより、1 対 1 の更新でマッピングされますが、一部のリクエストへの応答は空になる場合があります。
writeControl

object (WriteControl)

リクエストの適用後に更新された書き込みコントロール。

認可スコープ

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

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

詳しくは、認可ガイドをご覧ください。

書き込み管理

書き込みリクエストの実行方法を制御します。

JSON 表現 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
フィールド
共用体フィールド control。書き込み先のドキュメントのリビジョンと、そのリビジョンがドキュメントの現在のリビジョンでない場合のリクエストの動作を指定します。どちらのフィールドも指定されていない場合、更新は最新のリビジョンに適用されます。control は次のいずれかになります。
requiredRevisionId

string

書き込みリクエストが適用されるドキュメント（省略可）の revision ID。これがドキュメントの最新のリビジョンでない場合、リクエストは処理されず、400 不正なリクエスト エラーが返されます。

必要なリビジョン ID がレスポンスで返されると、リクエスト適用後のドキュメントのリビジョン ID が示されます。
targetRevisionId

string

書き込みリクエストが適用されるドキュメントのオプション ターゲット revision ID。

API を使用してドキュメントの読み取り後に共同編集者の変更が行われた場合、この書き込みリクエストによって生成された変更が共同編集者の変更に適用されます。これにより、共同編集者による変更とリクエストの変更の両方を含むドキュメントが改訂され、競合する変更がドキュメント サーバーによって解決されます。ターゲット リビジョン ID を使用する場合、API クライアントはドキュメントの別の共同編集者と考えることができます。

ターゲット リビジョン ID は、ドキュメントの新しいバージョンへの書き込みにのみ使用できます。ターゲット リビジョンが最新のリビジョンよりかなり遅れている場合は、リクエストが処理されず、400 不正なリクエスト エラーが返されます。最新バージョンのドキュメントを取得してから、もう一度リクエストしてください。通常、リビジョン ID は読み取られた後、数分間はターゲット リビジョンとして使用できますが、頻繁に編集されるドキュメントでは、このウィンドウはこれより短い可能性があります。