Method: spreadsheets.values.batchUpdate

スプレッドシートの 1 つ以上の範囲に値を設定します。呼び出し元は、スプレッドシート ID、valueInputOption、1 つ以上の ValueRanges を指定する必要があります。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
spreadsheetId

string

更新するスプレッドシートの ID。

リクエストの本文

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

JSON 表現 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (ValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
フィールド
valueInputOption

enum (ValueInputOption)

入力データをどのように解釈するか。
data[]

object (ValueRange)

スプレッドシートに適用する新しい値。
includeValuesInResponse

boolean

更新されたセルの値を更新レスポンスに含めるかどうかを決定します。デフォルトでは、レスポンスには更新された値は含まれません。各 BatchUpdateValuesResponse.responses 内の updatedData フィールドには、更新された値が含まれます。書き込み範囲が実際に書き込まれた範囲よりも大きい場合、レスポンスにはリクエストされた範囲内のすべての値が含まれます（末尾の空の行と列を除く）。
responseValueRenderOption

enum (ValueRenderOption)

レスポンスの値のレンダリング方法を指定します。デフォルトのレンダリング オプションは FORMATTED_VALUE です。
responseDateTimeRenderOption

enum (DateTimeRenderOption)

レスポンスの日付、時刻、所要時間のレンダリング方法を決定します。responseValueRenderOption が FORMATTED_VALUE の場合、これは無視されます。デフォルトの dateTime レンダリング オプションは SERIAL_NUMBER です。

レスポンスの本文

スプレッドシート内の値の範囲を更新した場合のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesResponse)
    }
  ]
}
フィールド
spreadsheetId

string

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

integer

行内の少なくとも 1 つのセルが更新された行の合計数。
totalUpdatedColumns

integer

列内の少なくとも 1 つのセルが更新された列の合計数。
totalUpdatedCells

integer

更新されたセルの合計数。
totalUpdatedSheets

integer

シート内の少なくとも 1 つのセルが更新されたシートの合計数。
responses[]

object (UpdateValuesResponse)

リクエストされた範囲ごとに 1 つの UpdateValuesResponse（リクエストの表示順序と同じ順序）。

認可スコープ

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

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

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