此页面由 Cloud Translation API 翻译。

Class Site

已弃用。此类已弃用，不应在新脚本中使用。

表示 Google 网站的对象。

方法

方法	返回类型	简介
`addEditor(emailAddress)`	`Site`	将指定用户添加到 `Site` 的编辑者列表中。
`addEditor(user)`	`Site`	将指定用户添加到 `Site` 的编辑者列表中。
`addEditors(emailAddresses)`	`Site`	向 `Site` 的编辑器列表添加给定的一组用户。
`addViewer(emailAddress)`	`Site`	将指定用户添加到 `Site` 的查看者列表中。
`addViewer(user)`	`Site`	将指定用户添加到 `Site` 的查看者列表中。
`addViewers(emailAddresses)`	`Site`	将指定的一组用户添加到 `Site` 的查看者列表。
`getEditors()`	`User[]`	获取此 `Site` 的编辑器列表。
`getViewers()`	`User[]`	获取此 `Site` 的查看者和评论者的列表。
`removeEditor(emailAddress)`	`Site`	从 `Site` 的编辑者列表中移除指定用户。
`removeEditor(user)`	`Site`	从 `Site` 的编辑者列表中移除指定用户。
`removeViewer(emailAddress)`	`Site`	从 `Site` 的查看者和评论者列表中移除指定用户。
`removeViewer(user)`	`Site`	从 `Site` 的查看者和评论者列表中移除指定用户。

已弃用的方法

方法	返回类型	简介
`addCollaborator(email)`	`Site`	向网站添加新的协作者
`addCollaborator(user)`	`Site`	向网站添加新的协作者
`addOwner(email)`	`Site`	为网站添加新的所有者
`addOwner(user)`	`Site`	为网站添加新的所有者
`createAnnouncement(title, html, parent)`	`Page`	创建新通知
`createAnnouncementsPage(title, name, html)`	`Page`	创建新的通知页面。
`createComment(inReplyTo, html, parent)`	`Comment`	已弃用。
`createFileCabinetPage(title, name, html)`	`Page`	创建新的文件箱式页面。
`createListItem(html, columnNames, values, parent)`	`ListItem`	已弃用。
`createListPage(title, name, html, columnNames)`	`Page`	新建列表页面。
`createPageFromTemplate(title, name, template)`	`Page`	通过模板创建新页面。
`createWebAttachment(title, url, parent)`	`Attachment`	已弃用。
`createWebPage(title, name, html)`	`Page`	创建新网页。
`deleteSite()`	`void`	删除此网站。
`getAllDescendants()`	`Page[]`	获取后代页面（直接和间接）的数组，上限为 200 个页面。
`getAllDescendants(options)`	`Page[]`	获取一组包含可选的高级参数的后代页面。
`getAnnouncements()`	`Page[]`	检索指定 Google 网站的公告列表。
`getAnnouncementsPages()`	`Page[]`	检索指定 Google 网站的公告页面列表。
`getAttachments()`	`Attachment[]`	检索指定 Google 网站的附件列表。
`getChildByName(name)`	`Page`	获取特定的子页面。
`getChildren()`	`Page[]`	获取一组子页面，最多 200 个页面。
`getChildren(options)`	`Page[]`	获取一组子页面，其中包含可选的高级参数。
`getCollaborators()`	`User[]`	检索网站的协作者列表
`getComments()`	`Comment[]`	检索指定 Google 网站的评论列表。
`getFileCabinetPages()`	`Page[]`	检索指定 Google 网站的“文件柜”(File Cabinet) 页面列表。
`getListItems()`	`ListItem[]`	检索指定 Google 网站的网站列表项列表。
`getListPages()`	`Page[]`	检索指定 Google 协作平台的网站列表页面列表。
`getName()`	`String`	返回网站的名称
`getOwners()`	`User[]`	检索网站的所有者列表
`getSelfLink()`	`String`	检索此网站的 Feed 网址。
`getSiteName()`	`String`	返回网站的 siteName
`getSummary()`	`String`	返回网站的摘要
`getTemplates()`	`Page[]`	返回所有模板页面。
`getTheme()`	`String`	获取网站的主题
`getTitle()`	`String`	返回网站的标题
`getUrl()`	`String`	检索此网站的网址。
`getWebAttachments()`	`Attachment[]`	检索指定 Google 协作平台的网络附件列表。
`getWebPages()`	`Page[]`	检索指定 Google 协作平台的网页列表。
`removeCollaborator(email)`	`Site`	通过用户电子邮件地址从网站中删除协作者
`removeCollaborator(user)`	`Site`	从网站中删除协作者
`removeOwner(email)`	`Site`	通过用户电子邮件地址从网站中移除所有者
`removeOwner(user)`	`Site`	从网站中移除所有者
`search(query)`	`Page[]`	获取与搜索查询匹配的后代页面的数组，上限为 200 个页面。
`search(query, options)`	`Page[]`	获取与搜索查询匹配的后代页面数组，其中包含可选的高级参数。
`setSummary(summary)`	`Site`	设置网站的摘要
`setTheme(theme)`	`Site`	设置网站的主题
`setTitle(title)`	`Site`	设置网站标题

详细文档

`addEditor(emailAddress)`

将指定用户添加到 Site 的编辑者列表中。如果用户已经，则此方法会将该用户从查看者列表中进行升级。

参数

名称	类型	说明
`emailAddress`	`String`	要添加的用户的电子邮件地址。

Site - 此 Site，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`addEditor(user)`

将指定用户添加到 Site 的编辑者列表中。如果用户已经，则此方法会将该用户从查看者列表中进行升级。

参数

名称	类型	说明
`user`	`User`	表示要添加的用户。

Site - 此 Site，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`addEditors(emailAddresses)`

向 Site 的编辑器列表添加给定的一组用户。如果存在用户已经存在于查看者列表中，则此方法会将他们从观看者。

参数

名称	类型	说明
`emailAddresses`	`String[]`	要添加的用户的电子邮件地址的数组。

Site - 此 Site，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`addViewer(emailAddress)`

将指定用户添加到 Site 的查看者列表中。如果用户已经，则此方法不会产生任何效果。

参数

名称	类型	说明
`emailAddress`	`String`	要添加的用户的电子邮件地址。

Site - 此 Site，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`addViewer(user)`

将指定用户添加到 Site 的查看者列表中。如果用户已经，则此方法不会产生任何效果。

参数

名称	类型	说明
`user`	`User`	表示要添加的用户。

Site - 此 Site，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`addViewers(emailAddresses)`

将指定的一组用户添加到 Site 的查看者列表。如果存在用户已经位于编辑者列表中，则此方法对他们没有影响。

参数

名称	类型	说明
`emailAddresses`	`String[]`	要添加的用户的电子邮件地址的数组。

Site - 此 Site，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getEditors()`

获取此 Site 的编辑器列表。

User[] - 具有修改权限的用户数组。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getViewers()`

获取此 Site 的查看者和评论者的列表。

User[] - 具有查看或评论权限的用户数组。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`removeEditor(emailAddress)`

从 Site 的编辑者列表中移除指定用户。此方法如果用户属于符合以下条件的某个类别，则禁止该用户访问Site 例如，如果 Site 与用户的整个网域，或者如果 Site 位于用户有权访问的共享云端硬盘中。

对于云端硬盘文件，此操作还会将相应用户从查看者列表中移除。

参数

名称	类型	说明
`emailAddress`	`String`	要移除的用户的电子邮件地址。

Site - 此 Site，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`removeEditor(user)`

对于云端硬盘文件，此操作还会将相应用户从查看者列表中移除。

参数

名称	类型	说明
`user`	`User`	要移除的用户的表示法。

Site - 此 Site，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`removeViewer(emailAddress)`

从 Site 的查看者和评论者列表中移除指定用户。这个方法则不起作用。此方法还会如果用户属于Site 具有常规访问权限，例如，如果 Site 与用户的也可以指定 Site 在用户可以访问的共享云端硬盘中。

对于云端硬盘文件，此操作也会将用户从编辑者列表中移除。

参数

名称	类型	说明
`emailAddress`	`String`	要移除的用户的电子邮件地址。

Site - 此 Site，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`removeViewer(user)`

从 Site 的查看者和评论者列表中移除指定用户。这个方法则不起作用。此方法也不会阻止如果用户属于对具有常规性访问权限的某一类用户，则他们无法访问 Site。访问权限 - 例如，如果 Site 与用户的整个网域共享，或者如果Site位于用户可以访问的共享云端硬盘中。

对于云端硬盘文件，此操作也会将用户从编辑者列表中移除。

参数

名称	类型	说明
`user`	`User`	要移除的用户的表示法。

Site - 此 Site，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

已弃用的方法

`addCollaborator(email)`

已弃用。此函数已弃用，不应在新脚本中使用。

向网站添加新的协作者

var site = SitesApp.getSite("example.com", "mysite");
site.addCollaborator("eric@example.com");

参数

名称	类型	说明
`email`	`String`	要添加为协作者的用户的电子邮件地址

Site - 此关联网站

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`addCollaborator(user)`

已弃用。此函数已弃用，不应在新脚本中使用。

向网站添加新的协作者

var site = SitesApp.getSite("example.com", "mysite");
var currentUser = Session.getActiveUser();
site.addCollaborator(currentUser);

参数

名称	类型	说明
`user`	`User`	要添加为协作者的用户

Site - 此关联网站

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`addOwner(email)`

已弃用。此函数已弃用，不应在新脚本中使用。

为网站添加新的所有者

var site = SitesApp.getSite("example.com", "mysite");
site.addOwner("eric@example.com");

参数

名称	类型	说明
`email`	`String`	要添加为所有者的用户的电子邮件地址

Site - 此关联网站

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`addOwner(user)`

已弃用。此函数已弃用，不应在新脚本中使用。

为网站添加新的所有者

var site = SitesApp.getSite("example.com", "mysite");
var currentUser = Session.getActiveUser();
site.addOwner(currentUser);

参数

名称	类型	说明
`user`	`User`	要添加为所有者的用户

Site - 此关联网站

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`createAnnouncement(title, html, parent)`

已弃用。此函数已弃用，不应在新脚本中使用。

创建新通知

参数

名称	类型	说明
`title`	`String`	要创建的公告页面的标题
`html`	`String`	网页的 HTML 正文
`parent`	`Page`	“父级”页面

Page - 创建的 Page

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`createAnnouncementsPage(title, name, html)`

已弃用。此函数已弃用，不应在新脚本中使用。

创建新的通知页面。请注意，父网站或网页的数量不能超过 500 子页面。

// This method can be called from both a Site instance
// as well as a Page instance
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createAnnouncementsPage("New Announcement",
                             "new-announcement",
                             "<h1>Your announcement goes here</h1>");

page.createAnnouncementsPage("New Announcement",
                             "new-announcement-child",
                             "<h1>Your announcement goes here</h1>");

参数

名称	类型	说明
`title`	`String`	网页标题
`name`	`String`	页面名称
`html`	`String`	网页内容

Page - 新创建的 Page

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`createComment(inReplyTo, html, parent)`

已弃用。此函数已弃用，不应在新脚本中使用。

已弃用。已在 Page 上替换为 createComment。

创建新评论。

参数

名称	类型	说明
`inReplyTo`	`String`	GData 供稿网址 - 无意义且已损坏
`html`	`String`	评论内容
`parent`	`Page`	显示评论的父级

Comment - 新创建的 Comment

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`createFileCabinetPage(title, name, html)`

已弃用。此函数已弃用，不应在新脚本中使用。

创建新的文件箱式页面。请注意，一个父级网站或页面的子级不能超过 500 个页面。

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createFileCabinetPage("New File Cabinet",
                           "new-file-cabinet",
                           "<h1>Your HTML here</h1>");

page.createFileCabinetPage("New File Cabinet",
                             "new-file-cabinet-child",
                             "<h1>Your HTML here</h1>");

参数

名称	类型	说明
`title`	`String`	网页标题
`name`	`String`	页面名称
`html`	`String`	网页内容

Page - 新创建的 Page

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`createListItem(html, columnNames, values, parent)`

已弃用。此函数已弃用，不应在新脚本中使用。

已弃用。已在 Page 上替换为 createListItem。

创建一个新的 ListItem。

参数

名称	类型	说明
`html`	`String`	商品内容 - 毫无意义且已损坏。
`columnNames`	`String[]`	列的名称，这是不必要的
`values`	`String[]`	列值
`parent`	`Page`	ListPage 父级

ListItem - 用于链接的 ListItem。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`createListPage(title, name, html, columnNames)`

已弃用。此函数已弃用，不应在新脚本中使用。

新建列表页面。请注意，父网站或页面的子页面数量不得超过 500 个。

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createListPage("New List Page",
                    "new-list-page",
                    "<h1>Your List Page HTML here</h1>",
                    [ "col1", "col2" ]);

page.createListPage("New List Page",
                    "new-list-page-child",
                    "<h1>Your List Page HTML here</h1>",
                    [ "col1", "col2" ]);

参数

名称	类型	说明
`title`	`String`	网页标题
`name`	`String`	页面名称
`html`	`String`	网页内容
`columnNames`	`String[]`	列表使用的列名称

Page - 新创建的 Page

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`createPageFromTemplate(title, name, template)`

已弃用。此函数已弃用，不应在新脚本中使用。

通过模板创建新页面。请注意，父网站或网页的数量不能超过 500 子页面。

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var template = site.getTemplates()[0];

// If an invalid template is passed, this will throw an "Invalid Argument" error.
site.createPageFromTemplate("ClonedPage", "cloned-page", template);

参数

名称	类型	说明
`title`	`String`	网页标题
`name`	`String`	页面名称
`template`	`Page`	模板页面

Page - 新创建的 Page

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`createWebAttachment(title, url, parent)`

已弃用。此函数已弃用，不应在新脚本中使用。

已弃用。已在 Page 上替换为 createWebAttachment。

创建新的网络附件。

参数

名称	类型	说明
`title`	`String`	附件标题
`url`	`String`	附件的网址
`parent`	`Page`	父页面

Attachment - 此连接（用于链路）。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`createWebPage(title, name, html)`

已弃用。此函数已弃用，不应在新脚本中使用。

创建新网页。请注意，父网站或页面的子页面数量不得超过 500 个。

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createAnnouncementsPage("New Announcement",
                             "new-announcement",
                             "<h1>Your announcement goes here</h1>");

page.createAnnouncementsPage("New Announcement",
                             "new-announcement-child",
                             "<h1>Your announcement goes here</h1>");

参数

名称	类型	说明
`title`	`String`	网页标题
`name`	`String`	页面名称
`html`	`String`	网页内容

Page - 新创建的 Page

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`deleteSite()`

已弃用。此方法目前尚未实现，在。

删除此网站。

var site = SitesApp.getSite('example.com', 'mysite');
site.deleteSite();

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getAllDescendants()`

已弃用。此函数已弃用，不应在新脚本中使用。

获取后代页面（直接和间接）的数组，上限为 200 个页面。

var site = SitesApp.getSite("example.com", "mysite");
var pages = site.getAllDescendants();

Page[] - 直接和间接子页面的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getAllDescendants(options)`

已弃用。此函数已弃用，不应在新脚本中使用。

获取一组包含可选的高级参数的后代页面。

var site = SitesApp.getSite("example.com", "mysite");
var descendants = site.getAllDescendants({
  type: SitesApp.PageType.WEB_PAGE,
  start: 0,
  max: 25,
  includeDrafts: false,
  includeDeleted: true,
  search: "target"
});

for(var i in descendants) {
  Logger.log(descendants[i].getName());
}

参数

名称	类型	说明
`options`	`Object`	下文“高级参数”部分中定义的 JavaScript 对象字段

高级参数

名称	类型	说明
`type`	`PageType[]`	仅获取此类型的网页
`start`	`Integer`	从这里开始结果
`max`	`Integer`	结果数上限（默认值为 200）
`includeDrafts`	`Boolean`	是否包含草稿页面（默认值为 false）
`includeDeleted`	`Boolean`	是否包含已删除的网页（默认值为 false）
`search`	`String`	仅返回与此查询匹配的页面

Page[] - 指定类型的直接和间接子页面的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getAnnouncements()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索指定 Google 网站的公告列表。

var site = SitesApp.getSite("example.com", "mysite");

var pages = site.getAnnouncements();
for(var i in pages) {
  Logger.log(pages[i].getTitle());
}

Page[] - 一系列公告 @link Page} 实例

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getAnnouncementsPages()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索指定 Google 网站的公告页面列表。

var site = SitesApp.getSite("example.com", "mysite");

var pages = site.getAnnouncementsPages();
for(var i in pages) {
  Logger.log(pages[i].getTitle());
}

Page[] - Page 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getAttachments()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索指定 Google 网站的附件列表。

var site = SitesApp.getSite("example.com", "mysite");

var attachments = site.getAttachments();
for(var i in attachments) {
  // Only hosted attachments have content types
  Logger.log(attachments[i].getContentType());
}

Attachment[] - Attachment 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getChildByName(name)`

已弃用。此函数已弃用，不应在新脚本中使用。

获取特定的子页面。

var site = SitesApp.getSite("example.com", "mysite");
var pages = site.getChildByName("childPage");

参数

名称	类型	说明
`name`	`String`	子页面名称

Page - 子网页

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getChildren()`

已弃用。此函数已弃用，不应在新脚本中使用。

获取一组子页面，最多 200 个页面。

var site = SitesApp.getSite("example.com", "mysite");
var pages = site.getChildren();

Page[] - 一组直接子页面

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getChildren(options)`

已弃用。此函数已弃用，不应在新脚本中使用。

获取一组子页面，其中包含可选的高级参数。

var site = SitesApp.getSite("example.com", "mysite");
var childPages = site.getChildren({
  type: SitesApp.PageType.WEB_PAGE,
  start: 0,
  max: 25,
  includeDrafts: false,
  includeDeleted: true,
  search: "target"
});

for(var i in childPages) {
  Logger.log(childPages[i].getName());
}

参数

名称	类型	说明
`options`	`Object`	下文“高级参数”部分中定义的 JavaScript 对象字段

高级参数

名称	类型	说明
`type`	`PageType[]`	仅获取此类型的网页
`start`	`Integer`	从这里开始结果
`max`	`Integer`	结果数上限（默认值为 200）
`includeDrafts`	`Boolean`	是否包含草稿页面（默认值为 false）
`includeDeleted`	`Boolean`	是否包含已删除的网页（默认值为 false）
`search`	`String`	仅返回与此查询匹配的页面

Page[] - 指定类型的直接子页面的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getCollaborators()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索网站的协作者列表

var collaborators = SitesApp.getSite('example.com', 'mysite').getCollaborators();
for(var i in collaborators) {
  Logger.log(collaborators[i].getEmail())
}

User[] - 包含代表协作者的 User 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getComments()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索指定 Google 网站的评论列表。

var site = SitesApp.getSite("example.com", "mysite");

var comments = site.getComments();
for(var i in comments) {
  Logger.log(comments[i].getContent());
}

Comment[] - Comment 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getFileCabinetPages()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索指定 Google 网站的“文件柜”(File Cabinet) 页面列表。

var site = SitesApp.getSite("example.com", "mysite");

var pages = site.getFileCabinetPages();
for(var i in pages) {
  Logger.log(pages[i].getTitle());
}

Page[] - Page 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getListItems()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索指定 Google 网站的网站列表项列表。

var site = SitesApp.getSite("example.com", "mysite");

var listItems = site.getListItems();
for(var i in listItems) {
  Logger.log(listItems[i].getLastUpdated());
}

ListItem[] - ListItem 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getListPages()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索指定 Google 协作平台的网站列表页面列表。

var site = SitesApp.getSite("example.com", "mysite");

var pages = site.getListPages();
for(var i in pages) {
  Logger.log(pages[i].getTitle());
}

Page[] - Page 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getName()`

已弃用。此函数已弃用，不应在新脚本中使用。

返回网站的名称

var name = SitesApp.getSite('example.com', 'mysite').getName();

String - 此网站实例的名称

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getOwners()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索网站的所有者列表

var owners = SitesApp.getSite('example.com', 'mysite').getOwners();
for(var i in owners) {
  Logger.log(owners[i].getEmail())
}

User[] - 包含代表所有者的 User 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getSelfLink()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索此网站的 Feed 网址。

var site = SitesApp.getSite('example.com', 'mysite');
var url = site.getSelfLink();

String - 此网站的 Feed 的网址

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getSiteName()`

已弃用。此函数已弃用，不应在新脚本中使用。

返回网站的 siteName

var site = SitesApp.getSite('example.com', 'mysite');
var url = site.getSelfLink();

String - 网站的 siteName

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getSummary()`

已弃用。此函数已弃用，不应在新脚本中使用。

返回网站的摘要

var summary = SitesApp.getSite('example.com', 'mysite').getSummary();

String - 此网站的摘要

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getTemplates()`

已弃用。此函数已弃用，不应在新脚本中使用。

返回所有模板页。

var templates = SitesApp.getSite('example.com', 'mysite').getTemplates();
for(var i in templates) {
  Logger.log(templates[i].getName())
}

Page[] - 包含代表模板的 Page 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getTheme()`

已弃用。此函数已弃用，不应在新脚本中使用。

获取网站的主题

var theme = SitesApp.getSite('example.com', 'mysite').getTheme();

String - 此网站的主题

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getTitle()`

已弃用。此函数已弃用，不应在新脚本中使用。

返回网站的标题

var title = SitesApp.getSite('example.com', 'mysite').getTitle();

String - 此网站的标题

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getUrl()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索此网站的网址。

var url = SitesApp.getSite('example.com', 'mysite').getUrl();

String - 此网站实例的网址

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getWebAttachments()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索指定 Google 协作平台的网络附件列表。

var site = SitesApp.getSite("example.com", "mysite");

var attachments = site.getWebAttachments();
for(var i in attachments) {
  // Only web attachments have URLs
  Logger.log(attachments[i].getUrl());
}

Attachment[] - Attachment 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`getWebPages()`

已弃用。此函数已弃用，不应在新脚本中使用。

检索指定 Google 协作平台的网页列表。

var site = SitesApp.getSite("example.com", "mysite");

var pages = site.getWebPages();
for(var i in pages) {
  Logger.log(pages[i].getTitle());
}

Page[] - Page 实例的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`removeCollaborator(email)`

已弃用。此函数已弃用，不应在新脚本中使用。

通过用户电子邮件地址从网站中删除协作者

// This snippet removes the user with the given email from the collaborators list
var site = SitesApp.getSite('example.com', 'mysite');
site.removeCollaborator("eric@example.com");

参数

名称	类型	说明
`email`	`String`	要从协作者中移除的用户的电子邮件地址

Site - 方法链接的网站实例

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`removeCollaborator(user)`

已弃用。此函数已弃用，不应在新脚本中使用。

从网站中删除协作者

// This snippet removes the current user from the list of collaborators
var site = SitesApp.getSite('example.com', 'mysite');
site.removeCollaborator(Session.getActiveUser());

参数

名称	类型	说明
`user`	`User`	要从协作者列表中移除的用户

Site - 方法链接的网站实例

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`removeOwner(email)`

已弃用。此函数已弃用，不应在新脚本中使用。

通过用户电子邮件地址从网站中移除所有者

// This snippet removes the user with the given email from the owners list
var site = SitesApp.getSite('example.com', 'mysite');
site.removeOwner("eric@example.com");

参数

名称	类型	说明
`email`	`String`	要从所有者中移除的用户的电子邮件地址

Site - 方法链接的网站实例

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`removeOwner(user)`

已弃用。此函数已弃用，不应在新脚本中使用。

从网站中移除所有者

// This snippet removes the current user from the list of owners
var site = SitesApp.getSite('example.com', 'mysite');
site.removeOwner(Session.getActiveUser());

参数

名称	类型	说明
`user`	`User`	要从所有者列表中移除的用户

Site - 方法链接的网站实例

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`search(query)`

已弃用。此函数已弃用，不应在新脚本中使用。

获取与搜索查询匹配的后代页面的数组，上限为 200 个页面。

var site = SitesApp.getSite("example.com", "mysite");
var matches = site.search("targetText");

for(var i in matches) {
  Logger.log(matches[i].getName());
}

参数

名称	类型	说明
`query`	`String`	要匹配的全文搜索查询

Page[] - 指定类型的直接和间接子页面的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`search(query, options)`

已弃用。此函数已弃用，不应在新脚本中使用。

获取与搜索查询匹配的后代页面数组，其中包含可选的高级参数。

var site = SitesApp.getSite("example.com", "mysite");
var childPages = site.getChildren({
  type: SitesApp.PageType.WEB_PAGE,
  start: 0,
  max: 25,
  includeDrafts: false,
  includeDeleted: true,
  search: "target"
});

for(var i in childPages) {
  Logger.log(childPages[i].getName());
}

参数

名称	类型	说明
`query`	`String`	要匹配的全文搜索查询
`options`	`Object`	下文“高级参数”部分中定义的 JavaScript 对象字段

高级参数

名称	类型	说明
`type`	`PageType[]`	仅获取此类型的网页
`start`	`Integer`	从这里开始结果
`max`	`Integer`	结果数上限（默认值为 200）
`includeDrafts`	`Boolean`	是否包含草稿页面（默认值为 false）
`includeDeleted`	`Boolean`	是否包含已删除的网页（默认值为 false）

Page[] - 指定类型的直接和间接子页面的数组

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`setSummary(summary)`

已弃用。此函数已弃用，不应在新脚本中使用。

设置网站的摘要

var site = SitesApp.getSite("example.com", "mysite");
// All of the setter methods return the site instance so setters
// can be chained
site.setTitle("My Site")
    .setSummary("This is my site")
    .setTheme("simple");

参数

名称	类型	说明
`summary`	`String`	描述网站的字符串摘要

Site - 方法链接的站点

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`setTheme(theme)`

已弃用。此函数已弃用，不应在新脚本中使用。

设置网站的主题

主题必须是有效的主题字符串。要获取详尽列表，请编写测试方法并将 setTheme() 的值无效。脚本将抛出一个 Service 错误并返回一个详尽的可用主题的列表。“管理”下还提供了可用主题的列表网站->主题。主题名称字符串通常与“主题”页面上的主题名称相同，移除了空格和特殊字符。例如，“Terra: 水"应为“terrawater”。

var site = SitesApp.getSite("example.com", "mysite");
// All of the setter methods return the site instance so setters
// can be chained
site.setTitle("My Site")
    .setSummary("This is my site")
    .setTheme("simple");

参数

名称	类型	说明
`theme`	`String`	要为此 `Site` 设置的主题的字符串名称

Site - 方法链接的站点

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds

`setTitle(title)`

已弃用。此函数已弃用，不应在新脚本中使用。

设置网站标题

var site = SitesApp.getSite("example.com", "mysite");
// All of the setter methods return the site instance so setters
// can be chained
site.setTitle("My Site")
    .setSummary("This is my site")
    .setTheme("simple");

参数

名称	类型	说明
`title`	`String`	网站的新标题

Site - 方法链接的站点

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

https://sites.google.com/feeds