简介

借助 Google Slides API,您可以创建和修改 Google 幻灯片演示文稿。

应用可以与 Google Slides API 集成,以便根据用户和系统提供的数据自动创建精美的幻灯片组。例如,您可以从数据库中使用客户详细信息,并将其与预先设计的模板和所选配置选项相结合,从而在极短的时间内创建出成品演示,而手动创建则需要花费大量时间。

API 概览

演示文稿集合提供了一些方法,可让您获取和更新演示文稿中的元素。

您使用 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 标识。

页面

Google 幻灯片包含以下类型的页面:

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

页面元素

页面元素是指放置在页面上的视觉组件。该 API 可显示多种类型的网页元素:

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

批量更新

借助 batchUpdate 方法,您可以更新演示的许多方面。更改会分批分组,这样一来,如果一个请求失败,则不会写入任何其他(可能相关的)更改。

batchUpdate 方法通过接受一个或多个 Request 对象来运行,每个对象都指定要执行的单个请求类型。请求有很多不同的类型。下面按不同类别列出了各种类型的要求。

使用 Google 幻灯片: 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 可能会发生变化。如需了解详情,请参阅下一部分。

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

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

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

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