请求和响应

本指南介绍了构成 Google 文档 API 的主要请求和响应方法,以及如何批量更新文档。

要调用 Google 文档 API,您可以使用 HTTP 请求,也可以使用特定于语言的客户端库中的方法调用。这些概念大致相同。

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 方法可提供有关已应用请求的信息的响应。这些方法会返回一个包含 response 对象列表的响应正文。其他请求不需要返回信息并显示空回复。响应列表中的对象与对应的请求采用相同的索引顺序。

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

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

body = ... & requests & ...

...batchUpdate(body)

如需详细了解如何批量处理 Google 文档 API 调用,请参阅批量请求最佳实践以及有关请求和响应类型的 documents.batchUpdate 参考文档。

批量更新操作

批量更新请求分为多种类型。以下是按不同类别分组的请求类型细分。

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