借助 Google 幻灯片 API,您可以创建和修改 Google 幻灯片演示文稿。
应用可以与 Google 幻灯片 API 集成,以便根据用户和系统提供的数据自动创建精美的幻灯片演示文稿。例如,您可以使用数据库中的客户详细信息,并将其与预先设计的模板和所选的配置选项相结合,以便在手动创建所需演示文稿所需时间的一小部分时间内创建完成的演示文稿。
API 概览
presentations 集合提供了一些方法,可让您获取和更新演示文稿中的元素。
您使用 Slides API 进行的大部分工作可能都与创建和更新演示文稿有关。您将使用 batchUpdate 方法执行此操作;此方法接受 Request 对象的列表,可让您执行以下操作:
- 创建幻灯片
- 向幻灯片添加形状或表格等元素
- 插入、更改和移除文本
- 对元素应用转换
- 更改幻灯片的顺序
如需了解详情,请参阅批量更新。如需通过简单的端到端示例了解如何使用该 API,请参阅“使用入门”指南。
演示文稿的结构
Slides API 中的演示文稿由页面组成,页面包含页面元素。
演示文稿的 ID 可以从网址派生:
https://docs.google.com/presentation/d/presentationId/edit
演示文稿 ID 是一个字符串,其中包含字母、数字和一些特殊字符。您可以使用以下正则表达式从 Google 表格网址中提取演示文稿 ID:
/presentation/d/([a-zA-Z0-9-_]+)
如果您熟悉 Drive API,则 presentationId
对应于 File 资源的 ID。
网页和网页元素通过对象 ID 进行标识。
Pages
Google 幻灯片有以下几种页面:
硕士 | 幻灯片母版用于定义使用此母版的所有幻灯片中显示的默认文本样式、背景和页面元素。必须显示在所有幻灯片上的页面元素应添加到母版中。大多数演示文稿只有一个主副本,但有些演示文稿可能有多个主副本,也可能没有主副本。 |
布局 | 布局可用作模板,用于默认设置页面元素在幻灯片中使用布局的排列方式。每个布局都与一个主布局相关联。 |
幻灯片 | 这些网页包含您要向观众展示的内容。 大多数幻灯片都基于母版和布局。您可以在创建幻灯片时指定要为其使用的布局。 |
备注 | 这些页面包含演示文稿的相关内容,包括包含幻灯片演讲者备注的形状。每个幻灯片都有一个对应的备注页。只能使用幻灯片 API 修改演讲者备注形状中的文本。 |
记事母版 | 记事母版用于定义所有记事页面的默认文本样式和页面元素。在 Google 幻灯片 API 中,备注母版是只读的。 |
页面元素
页面元素是放置在页面上的视觉组件。该 API 会公开多种类型的页面元素:
群组 | 一组被视为单个单元的网页元素。它们可以一起移动、缩放和旋转。 |
形状 | 纯视觉对象,例如矩形、椭圆形和文本框。 形状可以包含文本,因此是构建幻灯片最常用的页面元素。 |
Image | 导入到幻灯片中的图形。 |
视频 | 导入到 Google 幻灯片中的视频。 |
折线图 | 视觉线条、曲线或连接器。 |
表 | 内容网格。 |
WordArt | 一种视觉文本元素,其行为更像形状。 |
SheetsChart | 从 Google 表格导入到 Google 幻灯片中的图表。 |
批量更新
借助 batchUpdate 方法,您可以更新演示文稿的许多方面。更改会分批组合在一起,这样一来,如果一个请求失败,系统便不会写入任何其他(可能依赖的)更改。
batchUpdate
方法的工作原理是接受一个或多个 Request 对象,每个对象指定要执行的单一类型的请求。请求有多种不同的类型。下面按不同类别对要求类型进行了细分。
batchUpdate
方法会返回一个响应正文,其中包含每个请求的响应。每个响应都占据与相应请求相同的索引;对于没有适用响应的请求,该索引对应的响应将为空。各种 Create
请求通常都有响应,以便您知道新添加对象的 ID。
使用对象 ID
Slides API 中的演示文稿由页面和页面元素组成。这些对象包含一个在演示文稿中唯一的对象 ID 字符串。
在创建时指定对象 ID
使用 batchUpdate 方法创建页面或页面元素时,您可以选择为新对象指定对象 ID。这样,您就可以在同一批量更新请求中创建对象并对其进行修改,从而最大限度地减少对 Google 幻灯片 API 的调用次数并降低配额用量。
在大多数情况下,我们建议生成随机对象 ID。例如,如果您使用的是 Java,java.util.UUID.randomUUID().toString()
应该可以正常运行。
如果您的应用需要在较长一段时间内跟踪对象,请勿依赖对象 ID,因为它可能会发生变化。如需了解详情,请参阅以下部分。
在不使用对象 ID 的情况下跟踪对象
发出 Google 幻灯片 API 请求时,系统通常会保留对象 ID。(方法的参考文档中会指出任何异常。)使用 Drive API 复制整个演示文稿时,对象 ID 也会保留。
不过,您不能依赖于在幻灯片界面中更改演示文稿后对象 ID 保持不变。例如,如果用户使用 Google 幻灯片界面复制并粘贴页面元素,然后删除原始元素,则该页面元素现在将具有新的唯一 ID,您之前通过 API 提供的 ID 将会丢失。因此,我们不建议您在应用的存储空间中存储对象 ID。相反,您应根据文本内容或替代文本查找演示文稿中的对象。
新创建的演示文稿通常会为默认幻灯片、母版和文本框使用一组一致的 ID。这些 ID 可能会随时间而变化,因此我们不建议您依赖此功能。而是使用对 create() 或 get() 的调用返回的呈现对象查找要修改的元素。