除了单元格中包含的值数据外,电子表格还包含许多其他类型的数据,例如:
- 维度
- 单元格格式和边框
- 命名范围
- 受保护的范围
- 条件格式
这些仅是控制电子表格外观和操作的众多数据种类的一部分。您可以使用 spreadsheets.batchUpdate
方法更新任意电子表格详情。更改将以分批形式组织到一起,因此,如果一个请求失败,也不会写入其他任何(潜在相关的)更改。
本页介绍了使用 spreadsheets.batchUpdate
方法的基础知识。如果您需要读取和写入单元格值数据,还可以使用读取和写入单元格值中介绍的 spreadsheets.values
资源。
操作类别
spreadsheets.batchUpdate
支持的具体操作可以分成以下几个大类:
类别 | 说明 |
---|---|
添加(和复制) | 添加新对象(有时基于旧对象,例如在“复制”请求中就是如此)。 |
更新(和设置) | 更新某个对象的特定属性,这种情况下旧属性通常不受影响(不过,“设置”请求会覆盖之前的数据)。 |
删除 | 移除对象。 |
下一部分将使用这些类别说明具体操作的行为。
批量更新操作
spreadsheets.batchUpdate
方法通过获取一个或多个 Request 对象运行,每个对象均指定一种要执行的请求。存在多种不同的请求。下面是各种请求类型,它们按类别分为不同的组。
还有一些请求可以模拟用户的数据操作:
- AutoFillRequest
- CutPasteRequest
- CopyPasteRequest
- FindReplaceRequest
- PasteDataRequest
- TextToColumnsRequest
- SortRangeRequest
限制
如需详细了解 Google 表格中的单元格和行数限制,请参阅可存储在 Google 云端硬盘中的文件。
字段掩码
许多“更新”请求都需要字段掩码。这些掩码是字段的逗号分隔列表,用于仅更新对象中的特定字段,而其他字段保持不变。字段掩码 *
被视为通配符,是一种简写形式,用于表示消息中的每个字段(这意味着,如果您不在请求中为字段指定值,那么该字段可能会恢复为默认状态)。如需详细了解字段掩码,请参阅使用字段掩码。
以下示例使用 UpdateSpreadsheetPropertiesRequest
仅更新电子表格的标题:
请求:
POST .../v4/spreadsheets/spreadsheetId:batchUpdate
请求正文:
{
"requests": [{
"updateSpreadsheetProperties": {
"properties": {"title": "TITLE"},
"fields": "title"
}
}]
}
将 TITLE 替换为电子表格的新标题。
响应
在更新电子表格时,某些种类的请求可能会返回响应。这些响应以数组形式返回,每个响应与对应的请求占用相同的索引。某些请求没有响应,对于这些请求,响应为空。
通常,“添加”请求具有响应,会返回添加的对象的 ID 等信息。如需查看受支持的响应的列表,请参阅响应。
示例
以下代码示例会执行以下操作:
- 使用
title
变量更新电子表格的标题。 - 使用
find
和replacement
变量查找和替换电子表格中的单元格值。