Method: spreadsheets.batchUpdate

スプレッドシートに 1 つ以上の更新を適用します。

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

一部のリクエストには、その適用方法に関する情報を提供する replies が含まれています。返信はリクエストをミラーリングします。たとえば、4 つの更新を適用し、3 番目の更新に回答があった場合、実際の応答、空の返信の順で 2 つの返信が返されます。

スプレッドシートは共同作業を行うという性質上、これが完了するとスプレッドシートが変更内容を正確に反映する保証はありませんが、リクエストの更新がアトミックに適用されることが保証されています。共同編集者の変更に関連して、変更内容が変わることがあります。共同編集者がいない場合は、スプレッドシートに変更が反映されます。

HTTP リクエスト

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate

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

パスパラメータ

パラメータ
spreadsheetId

string

更新を適用するスプレッドシート。

リクエスト本文

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

JSON 表現 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean
}
フィールド
requests[]

object (Request)

スプレッドシートに適用する更新のリスト。リクエストは、指定された順序で適用されます。有効なリクエストがない場合、リクエストは適用されません。
includeSpreadsheetInResponse

boolean

更新レスポンスにスプレッドシート リソースを含めるかどうかを決定します。
responseRanges[]

string

回答スプレッドシートに含まれる範囲を制限します。includeSpreadsheetInResponse が「true」の場合にのみ意味があります。
responseIncludeGridData

boolean

グリッドデータを返す場合は true。includeSpreadsheetInResponse が「true」の場合にのみ意味があります。リクエストでフィールド マスクが設定されている場合、このパラメータは無視されます。

レスポンスの本文

スプレッドシートの一括更新に対する返信。

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

JSON 表現 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
フィールド
spreadsheetId

string

更新が適用されたスプレッドシート。
replies[]

object (Response)

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

object (Spreadsheet)

更新適用後のスプレッドシート。BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response が true の場合にのみ設定されます。

認可スコープ

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

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

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