Class Page

addColumn(name)

Add a new column to the list. Only valid for list pages.

 

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

Parameters

Return

Column — the newly created column

addComment(content)

Add a comment to the page.

 

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

 page.addComment("This is a comment created automatically by a script using the account " +
                 "of the user running the script");
 

Parameters

Return

Comment — the newly created comment

addHostedAttachment(blob)

Add an attachment to the page.

 

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

Parameters

Return

Attachment — the newly created attachment

addHostedAttachment(blob, description)

Add an attachment to the page. This version of the function allows for a 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");
 

Parameters

Return

Attachment — the newly created attachment

addListItem(values)

Add a list item to the list. Only valid for list pages.

 

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

Parameters

Return

ListItem — the newly created ListItem

addWebAttachment(title, description, url)

Add a web attachment to the page. Only valid for file cabinet pages. Web attachments are links - they are not actually hosted by Google Sites.

 

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

Parameters

Return

Attachment — the newly created attachment

createAnnouncement(title, html)

Create an announcements for this page. Only valid for announcement pages.

 

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

Parameters

Return

Page — the newly created Announcements

createAnnouncement(title, html, asDraft)

Create an announcements for this page. Only valid for announcement pages.

 

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

Parameters

Return

Page — the newly created Announcements

createAnnouncementsPage(title, name, html)

Create a new announcements page. Note that a parent site or page cannot have more than 500 child pages.

 

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

Parameters

Return

Page — the newly created Page

createFileCabinetPage(title, name, html)

Create a new file-cabinet page. Note that a parent site or page cannot have more than 500 child pages.

 

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

Parameters

Return

Page — The newly created Page

createListPage(title, name, html, columnNames)

Create a new list page. Note that a parent site or page cannot have more than 500 child pages.

 

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

Parameters

Return

Page — The newly created Page

createPageFromTemplate(title, name, template)

Create a new page from a template. Note that a parent site or page cannot have more than 500 child pages.

 

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

Parameters

Return

Page — the newly created Page

createWebPage(title, name, html)

Create a new web page. Note that a parent site or page cannot have more than 500 child pages.

 

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

Parameters

Return

Page — The newly created Page

deletePage()

Deletes this page.

 

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

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

getAllDescendants()

Gets an array of descendant pages (direct and indirect), up to a limit of 200 pages.

 

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

Return

Page[] — an array of direct and indirect child pages

getAllDescendants(options)

Gets an array of descendant pages, with optional advanced arguments.

 

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

Parameters

Advanced parameters

Return

Page[] — an array of direct and indirect child pages of the given type

getAnnouncements()

Get the announcements for this page. Only valid for announcement pages.

 

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

Return

Page[] — an array of Announcements

getAnnouncements(optOptions)

Get the announcements for this page. Only valid for announcement pages.

 

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

Parameters

Advanced parameters

Return

Page[] — an array of Announcements

getAttachments()

Get the attachments for this page.

 

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

Return

Attachment[] — an array of Attachments

getAttachments(optOptions)

Get the attachments for this page.

 

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

Parameters

Advanced parameters

Return

Attachment[] — an array of Attachments

getAuthors()

Get the emails of the authors of the page

 

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

Return

String[] — an array of author email addresses

getChildByName(name)

Gets a particular child page.

 

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

Parameters

Return

Page — the child page

getChildren()

Gets an array of child pages, up to a limit of 200 pages.

 

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

Return

Page[] — an array of direct child pages

getChildren(options)

Gets an array of child pages, with optional advanced arguments.

 

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

Parameters

Advanced parameters

Return

Page[] — an array of direct child pages of the given type

getColumns()

Get the columns for the list. Only valid for list pages.

 

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

Return

Column[] — an array of Column instances

getComments()

Get the comments for this page.

 

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

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

Return

Comment[] — an array of Comments.

getComments(optOptions)

Get the comments for this page.

 

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

 // Return only one comment
 var comments = page.getComments({ start:0, max: 1});
 for(var i in comments) {
   Logger.log(comments[i].getContent());
 }
 

Parameters

Advanced parameters

Return

Comment[] — an array of Comments.

getDatePublished()

Return the date this page was first published.

 

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

Return

Date — the date of original publication

getHtmlContent()

Get the HTML content of the page.

 

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

Return

String — the html content

getIsDraft()

Returns whether the page is in draft mode. Only valid for announcements.

 

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

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

Return

Boolean — whether the page is in draft mode

getLastEdited()

Return the last edit date, which includes only content edits.

 

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

Return

Date — the date the page was last updated, including only content edits

getLastUpdated()

Return the last updated date, which includes non-content changes like moving.

 

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

Return

Date — the date the page was last updated with non-content changes

getListItems()

Get the list items for the list. Only valid for list pages.

 

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

Return

ListItem[] — an array of ListItem instances

getListItems(optOptions)

Get the list items for the list. Only valid for list pages.

 

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

Parameters

Advanced parameters

Return

ListItem[] — an array of ListItem instances

getName()

Return the page's name.

 

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

Return

String — the name of this page

getPageType()

Return the type of this page as a SitesApp.PageType enum.

 

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

Return

PageType — a PageType enum telling whether this is a Web, List, Announcement or File Cabinet Page

getParent()

Return the parent of this page.

 

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

Return

Page — the parent page of this page

getTextContent()

Returns the plain-text page content.

 

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

Return

String — the plain-text content of the page

getTitle()

Return the page's title.

 

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

Return

String — the title of this page

getUrl()

Get the url of the page.

 

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

Return

String — the url of the page

isDeleted()

Returns whether a page has been deleted.

Return

Boolean — whether the page has been deleted

isTemplate()

Returns whether this page is a copyable template.

 

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

Return

Boolean — whether this page is a template

publishAsTemplate(name)

Publish this page as a copyable template.

 

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

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

Parameters

Return

Page — the newly published template

search(query)

Gets an array of descendant pages that match a search query, up to a limit of 200 pages.

 

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

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

Parameters

Return

Page[] — an array of direct and indirect child pages of the given type

search(query, options)

Gets an array of descendant pages that match a search query, with optional advanced arguments.

 

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

Parameters

Advanced parameters

Return

Page[] — an array of direct and indirect child pages of the given type

setHtmlContent(html)

Set the HTML content of the page.

 

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

Parameters

Return

Page — this Page for chaining

setIsDraft(draft)

Sets whether the page is in draft mode. Only valid for announcements.

 

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

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

Parameters

Return

Page — this Page for chaining

setName(name)

Set this page's name.

 

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

Parameters

Return

Page — this Page for chaining

setParent(parent)

Set the parent of this page.

 

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

Parameters

Return

Page — this Page for chaining

setTitle(title)

Set the page's title.

 

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

Parameters

Return

Page — this Page for chaining