本文档介绍了如何对 API 调用进行批处理,以减少客户端必须建立的连接数。批处理可以通过减少网络往返次数和提高吞吐量来提高应用效率。
概览
客户端建立的每个连接都会产生一定的开销。 Google Docs API 支持批处理,让您的客户端可以将多个请求对象(每个对象指定要执行的单个请求类型)放入单个批量请求中。通过将多个子请求合并为对服务器的单个调用,并检索单个响应,批处理请求可以提高性能。
我们建议用户始终将多个请求一起进行批处理。以下是一些可以使用批处理的情况示例:
- 您刚开始使用该 API,并且需要上传大量数据。
- 您需要更新多个对象的元数据或属性(例如格式)。
- 您需要删除多个对象。
限制、授权和依赖项注意事项
以下是采用批量更新时需要考虑的其他事项:
- 每个批处理请求(包括所有子请求)都算作一次 API 请求,计入您的用量限额。
- 批量请求只需进行一次身份验证。此单一身份验证适用于请求中的所有批量更新对象。
- 服务器会按子请求在批处理请求中出现的顺序处理这些子请求。后面的子请求可以依赖于在前面的子请求期间采取的操作。例如,在同一批处理请求中,用户可以将文本插入现有文档,然后设置其样式。
批量详情
批处理请求包含一个 batchUpdate
方法调用,其中包含多个子请求,例如添加文档,然后设置文档格式。
每项请求都会在应用之前进行验证。批处理更新中的所有子请求均以原子方式应用。也就是说,如果任何请求无效,则整个更新都会失败,并且不会应用任何(可能相关的)更改。
某些请求会提供包含有关已应用请求的信息的响应。 例如,所有用于添加对象的批量更新请求都会返回响应,以便您访问新添加对象的元数据,例如 ID 或标题。
借助此方法,您可以使用一个包含多个子请求的 API 批量更新请求来构建整个 Google 文档。
批量请求的格式
请求是一个包含多个嵌套子请求的 JSON 请求,其中包含一个必需属性:requests
。请求是在单个请求的数组中构建的。每个请求都使用 JSON 来表示请求对象并包含其属性。
批量响应的格式
批量请求的响应格式与请求格式类似。服务器的响应包含单个响应对象的完整答复。
主要 JSON 对象的属性名为 replies
。响应以数组形式返回,其中每个响应都与相应请求的索引顺序相同。某些请求没有响应,因此相应数组索引处的响应为空。
示例
以下代码示例展示了如何将批处理与 Docs API 搭配使用。
请求
此批量请求示例演示了如何执行以下操作:
使用
InsertTextRequest
将“Hello World”文本插入到现有文档的开头,索引location
为1
。使用
UpdateTextStyleRequest
更新“Hello”一词。startIndex
和endIndex
用于定义相应片段中格式化文本的range
。使用
textStyle
将“Hello”一词的字体样式设置为粗体,颜色设置为蓝色。您可以使用
WriteControl
字段来控制写入请求的执行方式。如需了解详情,请参阅使用 WriteControl 建立状态一致性。
{ "requests":[ { "insertText":{ "location":{ "index":1, "tabId":TAB_ID }, "text":"Hello World" } }, { "updateTextStyle":{ "range":{ "startIndex":1, "endIndex":6 }, "textStyle":{ "bold":true, "foregroundColor":{ "color":{ "rgbColor":{ "blue":1 } } } }, "fields":"bold,foreground_color" } } ], "writeControl": { "requiredRevisionId": "REQUIRED_REVISION_ID" } }
将 TAB_ID 和 REQUIRED_REVISION_ID 分别替换为写入请求所应用到的文档的标签页 ID 和修订版本 ID。
响应
此批量响应示例显示了有关如何应用批量请求中每个子请求的信息。InsertTextRequest
和 UpdateTextStyleRequest
均不包含响应,因此数组中 [0] 和 [1] 的索引值由空的大括号组成。批处理请求会显示 WriteControl
对象,其中显示了请求的执行方式。
{ "replies":[ {}, {} ], "writeControl":{ "requiredRevisionId":`REQUIRED_REVISION_ID` }, "documentId":`DOCUMENT_ID` }