Method: spreadsheets.values.batchClear

清除电子表格中的一个或多个值范围。调用方必须指定电子表格 ID 以及一个或多个范围。只会清除值,单元格的所有其他属性(例如格式设置和数据验证)都将保留。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
spreadsheetId

string

要更新的电子表格的 ID。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "ranges": [
    string
  ]
}
字段
ranges[]

string

要清除的范围,采用 A1 表示法或 R1C1 表示法

响应正文

清除电子表格中一系列值时的响应。

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

JSON 表示法
{
  "spreadsheetId": string,
  "clearedRanges": [
    string
  ]
}
字段
spreadsheetId

string

应用更新的电子表格。

clearedRanges[]

string

已清除的范围(采用 A1 表示法)。如果请求针对无界限范围或超出工作表边界的范围,则是实际清除的范围,以表格的上限为限。

授权范围

需要以下 OAuth 范围之一:

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

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