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

如需了解详情，请参阅授权指南。