请求和响应

本指南介绍了构成 Google 文档 API 以及如何批量更新文档。

您可以使用 HTTP 请求或使用方法调用 Google 文档 API (支持在特定语言的客户端库中进行调用)。 这些概念大致相同。

Google 文档 API 返回 HTTP 响应,其中通常包含结果 请求调用的一部分使用客户端库发出请求时,系统会以特定于语言的方式返回响应。

请求方法

Google 文档 API 支持以下方法:

  • documents.create:创建 空白 Google 文档。
  • documents.get:返回 指定文档的完整实例。您可以解析返回的 JSON 来提取文档内容、格式和其他功能。
  • documents.batchUpdate: 提交一系列要以原子方式应用于文档的修改请求,以及 返回结果列表。

documents.getdocuments.batchUpdate 方法需要 documentId 以指定目标文档。documents.create 方法 返回所创建文档的实例,您可以从中读取 documentId。有关 documentId 的详细信息,请参阅文档 ID

批量更新

documents.batchUpdate 方法会获取一系列 request 个对象,每个 指定要执行的单个请求例如,设置段落格式后, 添加内嵌图片每个请求都会在应用之前进行验证, 系统会根据它们在批量请求中出现的顺序来处理它们。

批量更新中的所有请求均以原子方式应用。也就是说,如果任何请求无效,则整个更新都将失败,并且系统不会应用任何(可能依赖的)更改。

某些 documents.batchUpdate 方法会在响应中提供有关已应用请求的信息。这些方法会返回响应 body 包含一系列 response 对象的操作。其他请求不需要返回信息并显示空的 回复。响应列表中的对象与 相应请求。

发出批量请求的常见模式如下所示:

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

如需全面了解相关详情,请参阅批量请求最佳做法 如何批量处理文档 API 调用,以及 documents.batchUpdate 请求和响应类型的参考文档。

批量更新操作

批量更新请求分为多种类型。下面详细介绍了 请求类型分为 不同类别。

对象 添加 / 插入 更新 / 替换 删除
文本 InsertTextRequest ReplaceAllTextRequest
样式 CreateParagraphBulletsRequest UpdateTextStyleRequest
UpdateParagraphStyleRequest
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
UpdateDocumentStyleRequest
UpdateSectionStyleRequest
DeleteParagraphBulletsRequest
命名的范围 CreateNamedRangeRequest ReplaceNamedRangeContentRequest DeleteNamedRangeRequest
DeleteContentRangeRequest
图片 InsertInlineImageRequest ReplaceImageRequest
InsertTableRequest
InsertTableRowRequest
InsertTableColumnRequest
UpdateTableColumnPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
页面对象(包括页眉页脚 InsertPageBreakRequest
CreateHeaderRequest
CreateFooterRequest
CreateFootnoteRequest
InsertSectionBreakRequest
DeletePositionedObjectRequest
DeleteHeaderRequest
DeleteFooterRequest