演示文稿。
方法
详细文档
add Editor(emailAddress)
将指定用户添加到 Presentation
的编辑者列表中。如果用户已在观看者列表中,此方法会将用户从观看者列表中移除。
参数
名称 | 类型 | 说明 |
---|---|---|
email | String | 要添加的用户的电子邮件地址。 |
返回
Presentation
- 此 Presentation
,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
add Editor(user)
将指定用户添加到 Presentation
的编辑者列表中。如果用户已在观看者列表中,此方法会将用户从观看者列表中移除。
参数
名称 | 类型 | 说明 |
---|---|---|
user | User | 要添加的用户的表示法。 |
返回
Presentation
- 此 Presentation
,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
add Editors(emailAddresses)
将指定的用户数组添加到 Presentation
的编辑者列表中。如果任何用户已在观看者列表中,此方法会将其从观看者列表中移除。
参数
名称 | 类型 | 说明 |
---|---|---|
email | String[] | 要添加的用户的电子邮件地址的数组。 |
返回
Presentation
- 此 Presentation
,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
add Viewer(emailAddress)
将指定用户添加到 Presentation
的观看者列表中。如果用户已在编辑者名单中,此方法将不会产生任何影响。
参数
名称 | 类型 | 说明 |
---|---|---|
email | String | 要添加的用户的电子邮件地址。 |
返回
Presentation
- 此 Presentation
,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
add Viewer(user)
将指定用户添加到 Presentation
的观看者列表中。如果用户已在编辑者名单中,此方法将不会产生任何影响。
参数
名称 | 类型 | 说明 |
---|---|---|
user | User | 要添加的用户的表示法。 |
返回
Presentation
- 此 Presentation
,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
add Viewers(emailAddresses)
将给定用户数组添加到 Presentation
的观看者列表中。如果任何用户已在编辑者列表中,此方法对他们没有任何影响。
参数
名称 | 类型 | 说明 |
---|---|---|
email | String[] | 要添加的用户的电子邮件地址的数组。 |
返回
Presentation
- 此 Presentation
,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
append Slide()
根据当前母版使用 Predefined
预定义布局将幻灯片附加到演示文稿的末尾。当前主副本是以下各项之一:
- 当前最后一张幻灯片的母版。
- 演示文稿中的第一张母版(如果没有幻灯片)。
返回
Slide
- 附加的新幻灯片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
append Slide(layout)
append Slide(predefinedLayout)
根据当前母版使用指定的预定义布局将幻灯片附加到演示文稿的末尾。当前主副本是以下各项之一:
- 当前最后一张幻灯片的母版。
- 演示文稿中的第一张母版(如果没有幻灯片)。
参数
名称 | 类型 | 说明 |
---|---|---|
predefined | Predefined | 要为新幻灯片使用的预定义布局;该布局应存在于当前主幻灯片中。 |
返回
Slide
- 附加的新幻灯片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
append Slide(slide)
将提供的 Slide
的副本附加到演示文稿的末尾。
如果要复制的幻灯片来自其他演示文稿,则系统还会复制父级母版页和布局页(如果此演示文稿中尚不存在这些页面)。
// Copy a slide from another presentation and appends it. const otherPresentation = SlidesApp.openById('presentationId'); const currentPresentation = SlidesApp.getActivePresentation(); const slide = otherPresentation.getSlides()[0]; currentPresentation.appendSlide(slide);
参数
名称 | 类型 | 说明 |
---|---|---|
slide | Slide | 要复制和附加的幻灯片。 |
返回
Slide
- 附加的新幻灯片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
append Slide(slide, linkingMode)
将源演示文稿中提供的 Slide
的副本附加到当前演示文稿的末尾,并将幻灯片链接设置为 Slide
指定的链接。
如果要复制的幻灯片来自其他演示文稿,并且父级母版页和布局页在当前演示文稿中尚不存在,系统也会一并复制这些页面。
如果链接模式为 Slide
,则在调用 Slide.refreshSlide()
时,附加的幻灯片可以更新为与提供的源幻灯片匹配。其他协作者可以看到指向源幻灯片的链接。Slide
不能与当前演示文稿中的源幻灯片搭配使用。
// Copy a slide from another presentation, then append and link it. const sourcePresentation = SlidesApp.openById('presentationId'); const currentPresentation = SlidesApp.getActivePresentation(); const slide = sourcePresentation.getSlides()[0]; const appendedSlide = currentPresentation.appendSlide( slide, SlidesApp.SlideLinkingMode.LINKED, );
参数
名称 | 类型 | 说明 |
---|---|---|
slide | Slide | 要复制、附加和关联的幻灯片。 |
linking | Slide | 要使用的关联模式。 |
返回
Slide
- 新幻灯片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Editors()
获取此 Presentation
的编辑器列表。
返回
User[]
- 具有修改权限的用户数组。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Id()
获取演示文稿的唯一标识符。演示文稿 ID 与 Slides
搭配使用,用于打开特定演示文稿实例。
返回
String
- 此演示文稿的 ID。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Layouts()
get Masters()
get Name()
获取演示文稿的名称或标题。
返回
String
- 此演示文稿的标题。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Notes Master()
获取演示文稿的备注母版。
返回
Notes
- 演示文稿的备注母版。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Notes Page Height()
获取演示文稿中备注母版和备注页的页面高度(以点为单位)。它们的页面高度都相同。
返回
Number
- 记事页面的高度(以点为单位)。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Notes Page Width()
获取演示文稿中备注母版和备注页面的页面宽度(以点为单位)。它们的页面宽度都相同。
返回
Number
- 记事页面宽度(以点为单位)。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Page Element By Id(id)
返回具有给定 ID 的 Page
,如果不存在,则返回 null
。
参数
名称 | 类型 | 说明 |
---|---|---|
id | String | 要检索的页面元素的 ID。 |
返回
Page
- 具有指定 ID 的页面元素。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Page Height()
获取演示文稿中幻灯片、布局和母版的页面高度(以点为单位)。它们的页面高度都相同。
返回
Number
- 页面高度(以点为单位)。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Page Width()
获取演示文稿中幻灯片、布局和母版的页面宽度(以点为单位)。它们的页面宽度都相同。
返回
Number
- 页面宽度(以磅为单位)。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Selection()
获取用户在当前演示文稿中的选择。脚本只能访问运行脚本的用户的选择,并且只有在脚本绑定到演示文稿的情况下才能执行此操作。
请注意,返回的选择是当前有效的选择。当脚本对演示文稿进行各种更改时,系统会转换所选内容以考虑这些更改。例如,如果选择了两个形状 A 和 B,然后脚本移除了形状 B,则返回的选择对象会隐式更新,以便仅选择形状 A。
// Gets the current active page that is selected in the active presentation. const selection = SlidesApp.getActivePresentation().getSelection(); const currentPage = selection.getCurrentPage();
返回
Selection
- 用户选择的表示法;如果脚本未绑定到演示文稿或没有有效的用户选择,则为 null
。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Slide By Id(id)
get Slides()
get Url()
检索用于访问此演示文稿的网址。
const presentation = SlidesApp.getActivePresentation(); // Send out the link to open the presentation. MailApp.sendEmail( '<email-address>', presentation.getName(), presentation.getUrl(), );
返回
String
- 用于访问当前演示文稿的网址。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
get Viewers()
获取此 Presentation
的查看者和评论者的列表。
返回
User[]
- 具有查看或评论权限的用户数组。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
insert Slide(insertionIndex)
根据当前母版使用 Predefined
预定义布局在演示文稿的指定索引处插入幻灯片。当前主实例是以下各项之一:
- 上一张幻灯片的主幻灯片。
- 如果 insertionIndex 为零,则为第一个幻灯片的主幻灯片。
- 演示文稿中的第一张母版(如果没有幻灯片)。
参数
名称 | 类型 | 说明 |
---|---|---|
insertion | Integer | 从零开始的索引,表示要插入幻灯片的位置。 |
返回
Slide
- 插入的新幻灯片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
insert Slide(insertionIndex, layout)
根据当前母版使用指定的布局在演示文稿的指定索引处插入幻灯片。当前主副本是以下各项之一:
- 上一张幻灯片的主幻灯片。
- 如果 insertionIndex 为零,则为第一个幻灯片的主幻灯片。
- 演示文稿中的第一张母版(如果没有幻灯片)。
参数
名称 | 类型 | 说明 |
---|---|---|
insertion | Integer | 从零开始的索引,表示要插入幻灯片的位置。 |
layout | Layout | 要为新幻灯片使用的布局;该布局应位于当前的母版中。 |
返回
Slide
- 插入的新幻灯片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
insert Slide(insertionIndex, predefinedLayout)
根据当前母版使用指定的预定义布局,在演示文稿的指定索引处插入幻灯片。当前主副本是以下各项之一:
- 上一张幻灯片的主幻灯片。
- 如果 insertionIndex 为零,则为第一个幻灯片的主幻灯片。
- 演示文稿中的第一张母版(如果没有幻灯片)。
参数
名称 | 类型 | 说明 |
---|---|---|
insertion | Integer | 从零开始的索引,表示要插入幻灯片的位置。 |
predefined | Predefined | 要为新幻灯片使用的预定义布局;该布局应存在于当前主幻灯片中。 |
返回
Slide
- 插入的新幻灯片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
insert Slide(insertionIndex, slide)
在演示文稿的指定索引处插入所提供 Slide
的副本。
如果要复制的幻灯片来自其他演示文稿,并且父级母版页和布局页在此演示文稿中尚不存在,则系统也会复制这些页面。
// Copy a slide from another presentation and inserts it. const otherPresentation = SlidesApp.openById('presentationId'); const currentPresentation = SlidesApp.getActivePresentation(); const slide = otherPresentation.getSlides()[0]; const insertionIndex = 1; currentPresentation.insertSlide(insertionIndex, slide);
参数
名称 | 类型 | 说明 |
---|---|---|
insertion | Integer | 从零开始的索引,表示要插入幻灯片的位置。 |
slide | Slide | 要复制并插入的幻灯片。 |
返回
Slide
- 插入的新幻灯片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
insert Slide(insertionIndex, slide, linkingMode)
将源演示文稿中提供的 Slide
的副本插入当前演示文稿中的指定索引,并将幻灯片链接设置为 Slide
所指定的链接。
如果要复制的幻灯片来自其他演示文稿,并且父级母版页和布局页在当前演示文稿中尚不存在,系统也会一并复制这些页面。
如果链接模式为 Slide
,则在调用 Slide.refreshSlide()
时,插入的幻灯片可以更新为与提供的源幻灯片匹配。其他协作者可以看到指向源幻灯片的链接。Slide
不能与当前演示文稿中的源幻灯片搭配使用。
// Copy a slide from another presentation, then insert and link it. const sourcePresentation = SlidesApp.openById('presentationId'); const currentPresentation = SlidesApp.getActivePresentation(); const slide = sourcePresentation.getSlides()[0]; const insertionIndex = 1; const insertedSlide = currentPresentation.insertSlide( insertionIndex, slide, SlidesApp.SlideLinkingMode.LINKED, );
参数
名称 | 类型 | 说明 |
---|---|---|
insertion | Integer | 从零开始的索引,表示要插入幻灯片的位置。 |
slide | Slide | 要复制并插入的幻灯片。 |
linking | Slide | 要使用的关联模式。 |
返回
Slide
- 新幻灯片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
remove Editor(emailAddress)
从 Presentation
的编辑者列表中移除指定用户。如果用户属于拥有一般访问权限的用户类别,此方法不会阻止他们访问 Presentation
,例如,如果 Presentation
与用户的整个网域共享,或者 Presentation
位于用户可以访问的共享云端硬盘中。
对于云端硬盘文件,这还会将用户从观看者列表中移除。
参数
名称 | 类型 | 说明 |
---|---|---|
email | String | 要移除的用户的电子邮件地址。 |
返回
Presentation
- 此 Presentation
,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
remove Editor(user)
从 Presentation
的编辑者列表中移除指定用户。如果用户属于拥有一般访问权限的用户类别,此方法不会阻止他们访问 Presentation
,例如,如果 Presentation
与用户的整个网域共享,或者 Presentation
位于用户可以访问的共享云端硬盘中。
对于云端硬盘文件,这还会将用户从观看者列表中移除。
参数
名称 | 类型 | 说明 |
---|---|---|
user | User | 要移除的用户的表示法。 |
返回
Presentation
- 此 Presentation
,用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
remove Viewer(emailAddress)
从 Presentation
的观看者和评论者列表中移除指定用户。如果用户是编辑者(而非观看者或评论者),此方法将无效。此外,如果用户属于具有一般访问权限的用户类别,此方法也不会阻止他们访问 Presentation
,例如,如果 Presentation
与用户的整个网域共享,或者 Presentation
位于用户可以访问的共享云端硬盘中。
对于云端硬盘文件,这还会将用户从编辑者列表中移除。
参数
名称 | 类型 | 说明 |
---|---|---|
email | String | 要移除的用户的电子邮件地址。 |
返回
Presentation
- 此 Presentation
用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
remove Viewer(user)
从 Presentation
的观看者和评论者列表中移除指定用户。如果用户是编辑者(而非查看者),此方法将无效。如果用户属于具有一般访问权限的用户类别,此方法也不会阻止他们访问 Presentation
,例如,如果 Presentation
与用户的整个网域共享,或者 Presentation
位于用户可以访问的共享云端硬盘中。
对于云端硬盘文件,这还会将用户从编辑者列表中移除。
参数
名称 | 类型 | 说明 |
---|---|---|
user | User | 要移除的用户的表示法。 |
返回
Presentation
- 此 Presentation
用于链式调用。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replace All Text(findText, replaceText)
将与查找文本匹配的所有文本替换为替换文本。搜索不区分大小写。
参数
名称 | 类型 | 说明 |
---|---|---|
find | String | 要查找的文本。 |
replace | String | 要替换匹配文本的文本。 |
返回
Integer
- 发生次数的更改
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replace All Text(findText, replaceText, matchCase)
将与查找文本匹配的所有文本替换为替换文本。
参数
名称 | 类型 | 说明 |
---|---|---|
find | String | 要查找的文本。 |
replace | String | 要替换匹配文本的文本。 |
match | Boolean | 如果为 true ,则搜索区分大小写;如果为 false ,则搜索不区分大小写。 |
返回
Integer
- 发生次数的更改
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
save And Close()
保存当前 Presentation
。导致系统刷新并应用待处理的更新。
系统会在脚本执行结束时自动为每个打开的 Presentation
调用 save
方法,即使脚本执行因出错而终止也是如此。
已关闭的 Presentation
无法修改。使用 Slides
上的某种打开方法重新打开给定演示文稿以进行修改。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
set Name(name)
设置演示文稿的名称或标题。
参数
名称 | 类型 | 说明 |
---|---|---|
name | String | 要为此演示文稿设置的名称。 |
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations