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

有关详情，请参阅授权指南。