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

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