Google 文档 API 概览

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

应用可以与 Google 文档 API 集成，以便利用用户和系统提供的数据创建完善的文档。借助 Google 文档 API，您可以：

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

下面列出了 Google 文档 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 上开发。

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

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