Google 文档 API 概览

Google 文档 API 可让您在 Google 文档中创建和修改文档。

应用可与 Google 文档 API 集成，以根据用户和系统提供的数据创建精致的文档。通过 Google 文档 API，您可以：

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

以下是文档 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 属性。这些值表示元素起始和结束位置相对于其所属线段的起始位置。

内嵌图片

在文档的文字流中显示的图片。这不是附件。

命名的范围

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

Segment

包含结构或内容元素的 Body、Header、Footer 或 Footnote。片段内元素的索引相对于该片段的开头。

建议

在不更改原文本的情况下更改文档。如果所有者批准您的建议，则这些建议会替换原始文本。

  • 如需了解如何使用 Google Workspace API 进行开发（包括处理身份验证和授权），请参阅在 Google Workspace 上开发。

  • 如需从概念上大致了解某个文档，请参阅文档。

  • 如需了解如何配置和运行 Google 文档 API 应用，请参阅 JavaScript 快速入门。