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_responsetrue 时,系统才会设置此参数。

授权范围

需要以下 OAuth 范围之一:

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

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