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

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