简介

您可以通过 GoogleSlides API 创建和修改 Google 幻灯片演示文稿。

应用可与 Google 幻灯片 API 集成,以根据用户和系统提供的数据自动创建精美的幻灯片组。例如,您可以使用数据库中的客户详细信息,并将其与预先设计的模板和选定的配置选项相结合,从而创建完成的演示文稿,所需时间要比手动创建演示文稿的少一些。

API 简介

通过 presentations 集合提供的方法,您可以获取和更新演示文稿中的元素。

您在使用幻灯片 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 进行标识。

页面

Google 幻灯片有以下几种页面:

硕士 幻灯片母版定义了默认文本样式、背景和使用此母版的所有幻灯片中显示的页面元素。应将所有幻灯片中必须显示的页面元素添加到母版中。大多数演示文稿都有一个母版,但有些演示文稿可能有多个母版或没有母版。
布局 布局可用作模板,指示在使用布局的幻灯片上默认情况下页面元素排列方式。每个布局都与一个母版相关联。
幻灯片 这些页面包含您要向受众群体展示的内容。 大多数幻灯片都基于母版和布局。您可以在创建每张幻灯片时指定要使用的布局。
备注 这些页面包含演示文稿讲义的内容,包括一个包含幻灯片演讲者备注的形状。每张幻灯片都有一个对应的备注页面。只有演讲者备注形状中的文本可以使用幻灯片 API 进行修改。
记事母版 记事母版可定义所有记事页面的默认文本样式和页面元素。备注母版在幻灯片 API 中是只读的。

页面元素

页面元素是放置在页面上的视觉组件。该 API 公开了多种页面元素:

群组 一组被视为单个单元的页面元素。它们可以一起移动、缩放和旋转。
形状 普通可视对象,例如矩形、椭圆形和文本框。 形状可以包含文本,因此它们是最常用来构建幻灯片的页面元素。
图片 导入 Google 幻灯片的图形。
视频 导入 Google 幻灯片的视频。
折线图 可视的线条、曲线或连接器。
内容网格。
WordArt 一种更类似于形状的视觉文本元素。
SheetsChart 从 Google 表格导入幻灯片的图表。

批量更新

您可以使用 batchUpdate 方法更新演示文稿的很多方面。更改会成批分组在一起,因此,如果一个请求失败,则不会写入其他任何(可能相关的)更改。

batchUpdate 方法的工作原理是接受一个或多个 Request 对象,每个对象指定一种要执行的请求。请求类型多种多样。下面是各种请求类型的细分,分为不同的类别。

使用幻灯片: CreateSlideRequest
UpdateSlidesPositionRequest
DuplicateObjectRequest
UpdatePagePropertiesRequest
DeleteObjectRequest
使用页面元素: CreateShapeRequest
CreateLineRequest
UpdatePageElementTransformRequest
UpdateShapePropertiesRequest
DuplicateObjectRequest
DeleteObjectRequest
使用表: CreateTableRequest
InsertTableRowsRequest
InsertTableColumnsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
UpdateTableRowPropertiesRequest
UpdateTableColumnPropertiesRequest
UpdateTableBorderPropertiesRequest
UpdateTableCellPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
DeleteObjectRequest
使用图表: CreateSheetsChartRequest
RefreshSheetsChartRequest
ReplaceAllShapesWithSheetsChartRequest
DeleteObjectRequest
使用图片和视频: CreateImageRequest
CreateVideoRequest
UpdateImagePropertiesRequest
UpdateVideoPropertiesRequest
ReplaceAllShapesWithImageRequest
DuplicateObjectRequest
DeleteObjectRequest
处理文本: InsertTextRequest
DeleteTextRequest
ReplaceAllTextRequest
CreateParagraphBulletsRequest
DeleteParagraphBulletsRequest
UpdateTextStyleRequest
UpdateParagraphStyleRequest

batchUpdate 方法会返回一个响应正文,其中包含每个请求的响应。每个响应都与相应请求占用相同的索引;对于没有适用响应的请求,该索引处的响应将为空。通常情况下,各种 Create 请求都有响应,以便您知道新添加对象的 ID。

使用对象 ID

Slides API 中的演示文稿由页面页面元素组成。这些对象包含一个在演示文稿中具有唯一性的对象 ID 字符串。

在创建时指定对象 ID

使用 batchUpdate 方法创建页面或页面元素时,您可以选择为新对象指定对象 ID。这样,您就可以在同一个 batchUpdate 请求中创建并对其进行修改,从而最大限度地减少对 Slides API 的调用次数并减少配额使用量

大多数情况下,我们建议生成一个随机对象 ID。例如,如果您使用的是 Java,则 java.util.UUID.randomUUID().toString() 应能够正常运行。

当您的应用想要在更长的时间段内跟踪对象时,请不要依赖于对象 ID,因为它可能会发生变化。如需了解详情,请参阅以下部分。

在不使用对象 ID 的情况下跟踪对象

当您发出 Slide API 请求时,通常会保留对象 ID。(该方法的参考文档中列出了所有例外情况。)使用 Drive API 制作整个演示文稿的副本也会保留对象 ID。

但是,在幻灯片界面中更改演示文稿后,您不能依赖于未更改的对象 ID。例如,如果有人使用幻灯片界面复制并粘贴页面元素,然后删除原始页面元素,则该页面元素现在将具有新的唯一 ID,而您之前通过 API 提供的 ID 也会丢失。因此,我们不建议您将对象 ID 存储在应用的存储空间中。而应根据对象的文本内容或替代文本查找演示文稿中的对象。

新创建的演示文稿通常对默认幻灯片、母版和文本框使用一组一致的 ID。这些 ID 会随着时间推移而发生变化,因此我们建议您不要依赖于此功能。您可以使用 create()get() 调用返回的呈现对象来查找您要修改的元素。