本頁面由 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 網站的「檔案櫃」頁面清單。
`getListItems()`	`ListItem[]`	擷取指定 Google 網站的網站清單項目清單。
`getListPages()`	`Page[]`	擷取指定 Google 協作平台的網站清單網頁清單。
`getName()`	`String`	傳回網站名稱
`getOwners()`	`User[]`	擷取網站的擁有者清單
`getSelfLink()`	`String`	擷取這個網站的資訊提供網址。
`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 網站的「檔案櫃」頁面清單。

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()`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

擷取這個網站的動態消息網址。

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

回攻員

String：這個網站動態消息的網址

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

https://sites.google.com/feeds

`getSiteName()`

已淘汰。此函式已淘汰，不應在新的指令碼中使用。

傳回網站的 siteName

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

回攻員

String：網站的名稱

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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:Water」(水域) 的字串會是「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