Method: spreadsheets.values.batchUpdate

設定試算表中一或多個範圍的值。呼叫端必須指定試算表 ID、valueInputOption 和一或多個 ValueRanges。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
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

資料列中至少有一個儲存格更新的資料列總數。
totalUpdatedColumns

integer

至少有一個儲存格更新的欄總數。
totalUpdatedCells

integer

更新的儲存格總數。
totalUpdatedSheets

integer

試算表中至少有一個儲存格更新的試算表總數。
responses[]

object (UpdateValuesResponse)

每個要求範圍一個 UpdateValuesResponse，且順序與要求出現的順序相同。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。