Method: spreadsheets.batchUpdate

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

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

一部のリクエストでは、どのように適用されるかに関する情報を提供する replies が指定されています。返信はリクエストをミラーリングします。たとえば、4 つの更新を適用し、3 つ目の更新に返信があった場合、レスポンスには、2 つの空の返信、実際の返信、もう 1 つの空の返信がこの順序で存在します。

スプレッドシートには共同編集機能があるため、処理の完了後に変更内容がスプレッドシートに正確に反映される保証はありませんが、リクエスト内の更新がアトミックに同時に適用されることは保証されます。共同編集者の変更に伴って、変更内容も変更される場合があります。共同編集者がいない場合は、変更内容がスプレッドシートに反映されます。

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

詳細については、承認ガイドをご覧ください。