Class Page

页面

Google 协作平台上的页面。

方法

方法返回类型简介
addColumn(name)Column向列表中添加新列。
addHostedAttachment(blob)Attachment向页面添加附件。
addHostedAttachment(blob, description)Attachment向页面添加附件。
addListItem(values)ListItem将列表项添加到列表中。
addWebAttachment(title, description, url)Attachment将网络附件添加到页面中。
createAnnouncement(title, html)Page为此页面创建通知。
createAnnouncement(title, html, asDraft)Page为此页面创建通知。
createAnnouncementsPage(title, name, html)Page创建新的公告页面。
createFileCabinetPage(title, name, html)Page创建新的文件箱式页面。
createListPage(title, name, html, columnNames)Page创建新的列表页面。
createPageFromTemplate(title, name, template)Page通过模板创建新页面。
createWebPage(title, name, html)Page创建新网页。
deletePage()void删除此页面。
getAllDescendants()Page[]获取后代页面(直接和间接)的数组,上限为 200 页。
getAllDescendants(options)Page[]获取后代网页数组,其中包含可选的高级参数。
getAnnouncements()Page[]获取此页面上的公告。
getAnnouncements(optOptions)Page[]获取此页面上的公告。
getAttachments()Attachment[]获取此页面的附件。
getAttachments(optOptions)Attachment[]获取此页面的附件。
getAuthors()String[]接收网页作者的电子邮件
getChildByName(name)Page获取特定的子页面。
getChildren()Page[]获取一组子页面,最多包含 200 页。
getChildren(options)Page[]获取包含可选高级参数的子页面数组。
getColumns()Column[]获取列表列。
getDatePublished()Date返回此页面的首次发布日期。
getHtmlContent()String获取网页的 HTML 内容。
getIsDraft()Boolean返回页面是否处于草稿模式。
getLastEdited()Date返回上次修改日期,其中仅包含内容修改日期。
getLastUpdated()Date返回上次更新日期,包括移动等非内容更改。
getListItems()ListItem[]获取列表项。
getListItems(optOptions)ListItem[]获取列表项。
getName()String返回信息页的名称。
getPageType()PageType以 SitesApp.PageType 枚举的形式返回此网页的类型。
getParent()Page返回此页面的父状态。
getTextContent()String返回纯文本页面内容。
getTitle()String返回网页的标题。
getUrl()String获取网页的网址。
isDeleted()Boolean返回页面是否已删除。
isTemplate()Boolean返回此页面是否为可复制模板。
publishAsTemplate(name)Page将此页面作为可复制模板发布。
search(query)Page[]获取与搜索查询匹配的后代网页数组(上限为 200 个网页)。
search(query, options)Page[]获取与搜索查询匹配的后代网页数组,其中含有可选的高级参数。
setHtmlContent(html)Page设置网页的 HTML 内容。
setIsDraft(draft)Page设置页面是否处于草稿模式。
setName(name)Page设置此页面的名称。
setParent(parent)Page设置此页面的父状态。
setTitle(title)Page设置网页的标题。

详细文档

addColumn(name)

向列表中添加新列。仅适用于列表页面。

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

var page = site.getChildByName("listpage");
// Only valid on List pages. Check for the type like so:
//     if(page.getPageType() == SitesApp.PageType.LIST_PAGE))
var columns = page.addColumn("new-column");

参数

名称类型说明
nameString新列的名称

返回

Column - 新创建的列

抛出

Error - 适用于未列出的网页

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

addHostedAttachment(blob)

向页面添加附件。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

// Create a new blob and attach it. Many useful functions also return
// blobs file uploads, URLFetch
var blob = Utilities.newBlob("Here is some data", "text/plain", "data.txt");

// Note that the filename must be unique or this call will fail
page.addHostedAttachment(blob);

参数

名称类型说明
blobBlobSource附件的数据

返回

Attachment - 新创建的连接

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

addHostedAttachment(blob, description)

向页面添加附件。此版本的函数提供说明。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

// Create a new blob and attach it. Many useful: functions also return
// blobs file uploads, URLFetch
var blob = Utilities.newBlob("Here is some data", "text/plain", "data.txt");

// Note that the filename must be unique or this call will fail
page.addHostedAttachment(blob, "Some newly created data");

参数

名称类型说明
blobBlobSource附件的数据
descriptionString附件说明

返回

Attachment - 新创建的连接

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

addListItem(values)

将列表项添加到列表中。仅适用于列表页面。

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

var page = site.getChildByName("listpage");
// Only valid on List pages. Check for the type like so:
//     if(page.getPageType() == SitesApp.PageType.LIST_PAGE))
// Returns only one item
page.addListItem([ "John", "Smith", "123 Main St"]);

参数

名称类型说明
valuesString[]每列的值

返回

ListItem - 新创建的 ListItem

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

addWebAttachment(title, description, url)

将网络附件添加到页面中。仅适用于文件箱式页面。

网络附件是链接,实际上并非由 Google 协作平台托管。

var site = SitesApp.getSite("example.com", "mysite");
// fetch the child - this must be a File Cabinet page
// to programmatically check this, do a comparison:
//    if(page.getPageType() == SitesApp.PageType.FILE_CABINET_PAGE)
var page = site.getChildByName("files");
page.addWebAttachment("Google Robots file",
                      "This is Google's robots.txt file",
                      "http://www.google.com/robots.txt");

参数

名称类型说明
titleString附件的标题
descriptionString附件说明
urlString附加的文件的网址

返回

Attachment - 新创建的连接

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

createAnnouncement(title, html)

为此页面创建通知。仅对公告页面有效。

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

// This snippet will only work with announcement pages - this is different
// from a page that is an annoucement (individual announcements). To check
// if this method can be called:
//    if(page.getPageType() == SitesApp.PageType.ANNOUNCEMENTS_PAGE))
var page = site.getChildByName("news");
page.createAnnouncement("Breaking news!", "<h1>Apps Script rocks!</h1>");

参数

名称类型说明
titleString网页标题
htmlString网页内容

返回

Page - 新创建的通知

抛出

Error - 适用于非公告页

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

createAnnouncement(title, html, asDraft)

为此页面创建通知。仅对公告页面有效。

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

// This snippet will only work with announcement pages - this is different
// from a page that is an annoucement (individual announcements). To check
// if this method can be called:
//    if(page.getPageType() == SitesApp.PageType.ANNOUNCEMENTS_PAGE))
var page = site.getChildByName("news");
page.createAnnouncement("Breaking news!",
                        "<h1>Apps Script rocks!</h1>",
                        true);

参数

名称类型说明
titleString网页标题
htmlString网页内容
asDraftBoolean是否将通知设为草稿

返回

Page - 新创建的通知

抛出

Error - 适用于非公告页

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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>");

参数

名称类型说明
titleString网页标题
nameString网页名称
htmlString网页内容

返回

Page - 新创建的 Page

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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>");

参数

名称类型说明
titleString网页标题
nameString网页名称
htmlString网页内容

返回

Page - 新创建的 Page

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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" ]);

参数

名称类型说明
titleString网页标题
nameString网页名称
htmlString网页内容
columnNamesString[]用于列表的列名称

返回

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);

参数

名称类型说明
titleString网页标题
nameString网页名称
templatePage模板页面

返回

Page - 新创建的 Page

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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>");

参数

名称类型说明
titleString网页标题
nameString网页名称
htmlString网页内容

返回

Page - 新创建的 Page

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

deletePage()

删除此页面。

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

// Delete ALL the pages!
var pages = site.getAllDescendants();
for(var i in pages) {
  pages[i].deletePage();
}

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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());
}

参数

名称类型说明
optionsObject下面的“高级参数”部分定义了 JavaScript 对象字段

高级参数

名称类型说明
typePageType[]仅获取此类网页
startInteger从此处开始结果
maxInteger结果数上限(默认为 200 条)
includeDraftsBoolean是否要包含草稿页(默认为 false)
includeDeletedBoolean是否要包含已删除的页面(默认为 false)
searchString仅返回与此查询匹配的页面

返回

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

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getAnnouncements()

获取此页面上的公告。仅对公告页面有效。

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

// This snippet will only work with announcement pages - this is different
// from a page that is an annoucement (individual announcements). To check
// if this method can be called:
//    if(page.getPageType() == SitesApp.PageType.ANNOUNCEMENTS_PAGE))
var page = site.getChildByName("news");
var announcements = page.getAnnouncements();

for(var i in announcements) {
  Logger.log(announcements[i].getHtmlContent());
}

返回

Page[] - 公告数组

抛出

Error - 适用于非公告页

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getAnnouncements(optOptions)

获取此页面上的公告。仅对公告页面有效。

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

// This snippet will only work with announcement pages - this is different
// from a page that is an annoucement (individual announcements). To check
// if this method can be called:
//    if(page.getPageType() == SitesApp.PageType.ANNOUNCEMENTS_PAGE))
var page = site.getChildByName("news");
var announcements = page.getAnnouncements({ start: 0,
                                            max: 20,
                                            includeDrafts: false,
                                            includeDeleted: false,
                                            search: "Breaking" });

for(var i in announcements) {
  Logger.log(announcements[i].getHtmlContent());
}

参数

名称类型说明
optOptionsObject包含高级参数的 JavaScript 对象

高级参数

名称类型说明
startInteger结果的起始索引
maxInteger要返回的结果数上限,默认值为 200,
includeDraftsBoolean是否要包含草稿页(默认为 false)
includeDeletedBoolean是否要包含已删除的页面(默认为 false)
searchString仅返回与此查询匹配的页面

返回

Page[] - 公告数组

抛出

Error - 适用于非公告页

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getAttachments()

获取此页面的附件。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

var attachments = page.getAttachments();
for(var i in attachments) {
  Logger.log(attachments[i].getTitle());
}

返回

Attachment[] - 附件数组

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getAttachments(optOptions)

获取此页面的附件。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

// This returns only one attachment
var attachments = page.getAttachments({ start: 0, max: 1});
for(var i in attachments) {
  Logger.log(attachments[i].getTitle());
}

参数

名称类型说明
optOptionsObject包含可选参数的 JavaScript 对象

高级参数

名称类型说明
startInteger第一个开始返回附件的索引
maxInteger要返回的结果数上限,默认值为 200,

返回

Attachment[] - 附件数组

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getAuthors()

获取网页作者的电子邮件

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
var authors = page.getAuthors();

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

返回

String[] - 作者电子邮件地址数组

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getChildByName(name)

获取特定的子页面。

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

参数

名称类型说明
nameString子页面名称

返回

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());
}

参数

名称类型说明
optionsObject下面的“高级参数”部分定义了 JavaScript 对象字段

高级参数

名称类型说明
typePageType[]仅获取此类网页
startInteger从此处开始结果
maxInteger结果数上限(默认为 200 条)
includeDraftsBoolean是否要包含草稿页(默认为 false)
includeDeletedBoolean是否要包含已删除的页面(默认为 false)
searchString仅返回与此查询匹配的页面

返回

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

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getColumns()

获取列表列。仅适用于列表页面。

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

var page = site.getChildByName("listpage");
// Only valid on List pages. Check for the type like so:
//     if(page.getPageType() == SitesApp.PageType.LIST_PAGE))
var columns = page.getColumns();

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

返回

Column[] - 一组 Column 实例

抛出

Error - 适用于未列出的网页

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getDatePublished()

返回此页面的首次发布日期。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName() + " was published " + page.getDatePublished());

返回

Date - 原始发布日期

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getHtmlContent()

获取网页的 HTML 内容。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getHtmlContent());

返回

String - HTML 内容

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getIsDraft()

返回页面是否处于草稿模式。仅适用于公告。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

Logger.log("Is this Announcement Page a draft?", page.getIsDraft());

返回

Boolean - 网页是否处于草稿模式

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getLastEdited()

返回上次修改日期,其中仅包含内容修改日期。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName() + " was last updated " + page.getLastEdited());

返回

Date - 上次更新网页的日期,仅包括内容修改

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getLastUpdated()

返回上次更新日期,包括移动等非内容更改。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName() + " was last updated " + page.getLastUpdated());

返回

Date - 网页上次内容更新的日期

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getListItems()

获取列表项。仅适用于列表页面。

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

var page = site.getChildByName("listpage");
// Only valid on List pages. Check for the type like so:
//     if(page.getPageType() == SitesApp.PageType.LIST_PAGE))
var items = page.getListItems();

for(var i in items) {
  Logger.log(items[i].getValueByName("Status"));
}

返回

ListItem[] - 一组 ListItem 实例

抛出

Error - 适用于未列出的网页

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getListItems(optOptions)

获取列表项。仅适用于列表页面。

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

var page = site.getChildByName("listpage");
// Only valid on List pages. Check for the type like so:
//     if(page.getPageType() == SitesApp.PageType.LIST_PAGE))
// Returns only one item
var items = page.getListItems({ start:0, max: 1 });

for(var i in items) {
  Logger.log(items[i].getValueByName("Status"));
}

参数

名称类型说明
optOptionsObject可选参数的 JavaScript 对象

高级参数

名称类型说明
startInteger从其开始迭代的第一个索引
maxInteger要返回的结果数上限,默认值为 200,

返回

ListItem[] - 一组 ListItem 实例

抛出

Error - 适用于未列出的网页

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getName()

返回相应页面的名称。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName());

返回

String - 此页面的名称

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getPageType()

将此网页的类型作为 SitesApp.PageType 枚举返回。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
var pageType = page.getPageType();
if(pageType == SitesApp.PageType.WEB_PAGE) {
   Logger.log(page.getName() + " is a Web Page");
}

返回

PageType - 用于指示这是网页、列表、公告还是文件箱式页面的 PageType 枚举

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getParent()

返回此页面的父级。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName() + " parent: " + page.getParent().getName());

返回

Page - 此页面的父页面

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getTextContent()

返回纯文本页面内容。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName() + " content: " + page.getTextContent());

返回

String - 网页的纯文本内容

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getTitle()

返回网页的标题。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getTitle());

返回

String - 此页面的标题

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

getUrl()

获取网页的网址。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getUrl());

返回

String - 网页的网址

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

isDeleted()

返回页面是否已删除。

返回

Boolean - 网页是否已删除

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

isTemplate()

返回此页面是否为可复制模板。

var site = SitesApp.getSite("example.com", "mysite");
var firstTemplate = site.getTemplates()[0];
if(firstTemplate.isTemplate()) {
  Logger.log("This will always return true");
}

返回

Boolean - 此页面是否为模板

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

publishAsTemplate(name)

将此页面发布为可复制的模板。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

// Turn this page into a publishable template
page.publishedAsTemplate("template-name");

参数

名称类型说明
nameString新模板的名称

返回

Page - 新发布的模板

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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());
}

参数

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

返回

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());
}

参数

名称类型说明
queryString要匹配的全文搜索查询
optionsObject下面的“高级参数”部分定义了 JavaScript 对象字段

高级参数

名称类型说明
typePageType[]仅获取此类网页
startInteger从此处开始结果
maxInteger结果数上限(默认为 200 条)
includeDraftsBoolean是否要包含草稿页(默认为 false)
includeDeletedBoolean是否要包含已删除的页面(默认为 false)

返回

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

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

setHtmlContent(html)

设置网页的 HTML 内容。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
page.setHtmlContent("<h1>New Page Content</h1>");

参数

名称类型说明
htmlString新内容

返回

Page - 此页面,用于链接

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

setIsDraft(draft)

设置页面是否处于草稿模式。仅适用于公告。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

// Take the page out of draft mode
page.setIsDraft(false);

参数

名称类型说明
draftBoolean新状态

返回

Page - 此页面,用于链接

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

setName(name)

设置此页面的名称。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
page.setName("new-name");

参数

名称类型说明
nameString新名称

返回

Page - 此页面,用于链接

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

setParent(parent)

设置此页面的父页面。

var site = SitesApp.getSite("example.com", "mysite");
var child = site.getChildByName("childToBeMoved");
var parent = site.getChildByName("newParent");
child.setParent(parent);

参数

名称类型说明
parentPage新的家长

返回

Page - 此页面,用于链接

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

setTitle(title)

设置网页的标题。

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
page.setTitle("New Title");

参数

名称类型说明
titleString新标题

返回

Page - 此页面,用于链接

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • https://sites.google.com/feeds

已废弃的方法