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,
  "commentsViewMode": enum (CommentsViewMode)
}
字段
requests[]

object (Request)

要应用于电子表格的更新列表。请求将按照指定的顺序应用。如果任何请求无效，则不会应用任何请求。
includeSpreadsheetInResponse

boolean

确定更新响应是否应包含电子表格资源。
responseRanges[]

string

限制响应电子表格中包含的范围。仅当 includeSpreadsheetInResponse 为“true”时才有意义。
responseIncludeGridData

boolean

如果应返回网格数据，则为 True。仅当 includeSpreadsheetInResponse 为“true”时才有意义。如果请求中设置了字段掩码，则此参数会被忽略。
commentsViewMode

enum (CommentsViewMode)

要应用于电子表格的评论视图模式。这样一来，您就可以选择查看省略评论的电子表格，也可以选择查看包含评论的电子表格。如果未指定，则会使用 COMMENTS_VIEW_MODE_OMITTED。仅当 includeSpreadsheetInResponse 为“true”时才有意义。

响应正文

用于批量更新电子表格的回复。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  },
  "commentUpdateState": enum (CommentUpdateState)
}
字段
spreadsheetId

string

应用更新的电子表格。
replies[]

object (Response)

对更新的回复。这与更新一一对应，但对某些请求的回复可能为空。
updatedSpreadsheet

object (Spreadsheet)

应用更新后的电子表格。只有当 BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response 为 true 时，才会设置此字段。
commentUpdateState

enum (CommentUpdateState)

批量请求中是否应用了评论更新。

授权范围

需要以下 OAuth 范围之一：

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

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

CommentUpdateState

批量请求中评论更新的状态。

枚举
COMMENT_UPDATE_STATE_UNSPECIFIED 评论更新的状态未指定。
NO_UPDATES_REQUESTED 批量请求中未请求任何评论更新。
ALL_SAVED 批处理请求中请求的所有评论更新均已应用。
ALL_FAILED_UNKNOWN_REASON 所有请求的评论更新均失败。