Method: spreadsheets.batchUpdate

将一个或多个更新应用于电子表格。

每个 request 都会在应用之前进行验证。如果任何请求无效，则整个请求都会失败，并且不会应用任何更改。

某些请求会带有 replies，以便您了解这些请求的应用方式。回复将镜像请求。例如，如果您应用了 4 次更新，并且第 3 次更新有回复，则响应将包含 2 个空白回复、实际回复和另一个空白回复，依此类推。

由于电子表格具有协作性质，因此我们无法保证电子表格在完成此操作后会完全反映您的更改，但我们保证请求中的更新将以原子方式一起应用。您的更改可能会因协作者所做的更改而发生变化。如果没有协作者，电子表格中应该会反映您的更改。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
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

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