Google 文档 API 概览

借助 Google Docs API，您可以在 Google 文档中创建和修改文档。

应用可以与 Docs API 集成，以便根据用户和系统提供的数据创建精美的文档。借助 Docs API，您可以：

  • 将流程自动化
  • 批量创建文档
  • 设置文档格式
  • 生成账单或合同
  • 检索对象的特定属性

以下是 Docs API 中使用的常用术语列表：

文档 ID

文档的唯一标识符。它是一种特殊字符串，包含字母、数字和一些引用文档的特殊字符，可从文档的网址派生而来。文档 ID 是稳定的，即使文档名称发生变化也是如此。如需详细了解如何查找此 ID，请参阅文档 ID。

https://docs.google.com/document/d/DOCUMENT_ID/edit
元素

构成文档的结构。文档的顶级元素包括 Body、DocumentStyle 和 List。

Google Workspace 文档

Google Workspace 应用（例如 Google 文档）创建的文件。Google 文档的 MIME 类型格式为 application/vnd.google-apps.document。如需查看 MIME 类型列表，请参阅 Google Workspace 和 Google 云端硬盘支持的 MIME 类型。

索引

内容正文中的大多数元素都具有 startIndex 和 endIndex 属性。这些属性用于指示元素的开头和结尾相对于其封闭 segment 的开头的偏移量。

内嵌图片

显示在文档文本流中的图片。它不是附件。

命名范围

连续的文本范围。NamedRange 是具有相同 namedRangeId 的一系列范围。借助命名范围，开发者可以将文档的部分内容与任意用户定义的标签相关联，以便日后以编程方式读取或修改其内容。文档可以包含多个名称相同的命名范围，但每个命名范围都有一个唯一 ID。

Segment

包含结构或内容元素的 Body、Header、Footer 或 Footnote。相应细分中的元素的索引是相对于该细分起点而言的。

建议

对文档进行更改，而不更改原文。如果所有者批准您的建议，那么修改建议便会替换原来的文本。