このページは Cloud Translation API によって翻訳されました。

Class Site

非推奨。このクラスは非推奨のため、新しいスクリプトでは使用しないでください。

Google サイトを表すオブジェクト。

Methods

メソッド	戻り値の型	概要
`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`	このサイトのフィード URL を取得します。
`getSiteName()`	`String`	サイトの siteName を返す
`getSummary()`	`String`	ウェブサイトの概要を返す
`getTemplates()`	`Page[]`	すべてのテンプレートページを返します。
`getTheme()`	`String`	サイトのテーマを取得します。
`getTitle()`	`String`	サイトのタイトルを返す
`getUrl()`	`String`	このサイトの URL を取得します。
`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（チェーン用）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`addEditor(user)`

パラメータ

名前	型	説明
`user`	`User`	追加するユーザーの表現。

リターン

Site - この Site（チェーン用）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`addEditors(emailAddresses)`

指定されたユーザー配列を Site の編集者のリストに追加します。いずれかのユーザーがすでに閲覧者のリストに含まれている場合、このメソッドでは閲覧者のリストから除外されます。

パラメータ

名前	型	説明
`emailAddresses`	`String[]`	追加するユーザーのメールアドレスの配列。

リターン

Site - この Site（チェーン用）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`addViewer(emailAddress)`

指定されたユーザーを Site の閲覧者リストに追加します。ユーザーがすでに編集者のリストに登録されている場合、このメソッドは効力がありません。

パラメータ

名前	型	説明
`emailAddress`	`String`	追加するユーザーのメールアドレス。

リターン

Site - この Site（チェーン用）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`addViewer(user)`

パラメータ

名前	型	説明
`user`	`User`	追加するユーザーの表現。

リターン

Site - この Site（チェーン用）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`addViewers(emailAddresses)`

指定されたユーザー配列を Site の閲覧者リストに追加します。編集者のリストに登録済みのユーザーについては、このメソッドは効力を持ちません。

パラメータ

名前	型	説明
`emailAddresses`	`String[]`	追加するユーザーのメールアドレスの配列。

リターン

Site - この Site（チェーン用）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getEditors()`

この Site の編集者のリストを取得します。

リターン

User[] - 編集権限を持つユーザーの配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getViewers()`

この Site の閲覧者とコメント投稿者のリストを取得します。

リターン

User[] - 閲覧またはコメントの権限を持つユーザーの配列。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`removeEditor(emailAddress)`

Site の編集者のリストから指定されたユーザーを削除します。このメソッドは、一般的なアクセス権を持つユーザーのクラスに所属するユーザーが Site にアクセスすることをブロックしません。たとえば、Site がユーザーのドメイン全体と共有されている場合や、Site がユーザーがアクセスできる共有ドライブ内にある場合です。

ドライブファイルの場合、閲覧者リストからもユーザーが削除されます。

パラメータ

名前	型	説明
`emailAddress`	`String`	削除するユーザーのメールアドレス。

リターン

Site - この Site（チェーン用）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`removeEditor(user)`

ドライブファイルの場合、閲覧者リストからもユーザーが削除されます。

パラメータ

名前	型	説明
`user`	`User`	削除するユーザーの表現。

リターン

Site - この Site（チェーン用）。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`removeViewer(emailAddress)`

Site の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。ユーザーが閲覧者やコメント投稿者ではなく編集者の場合、このメソッドは効力を持ちません。また、このメソッドによって、ユーザーが一般的なアクセス権を持つユーザーのクラスに属している場合（たとえば、Site がユーザーのドメイン全体と共有されている場合や、Site がユーザーがアクセスできる共有ドライブ内にある場合）は、Site へのアクセスがブロックされません。

ドライブファイルの場合、編集者のリストからもユーザーが削除されます。

パラメータ

名前	型	説明
`emailAddress`	`String`	削除するユーザーのメールアドレス。

リターン

Site - チェーン用のこの Site。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`removeViewer(user)`

Site の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。ユーザーが閲覧者ではなく編集者の場合、このメソッドは効力がありません。また、Site がユーザーのドメイン全体と共有されている場合や、Site がユーザーがアクセスできる共有ドライブ内にある場合など、一般的なアクセス権を持つユーザーのクラスに所属しているユーザーも、Site にアクセスすることはブロックされません。

ドライブファイルの場合、編集者のリストからもユーザーが削除されます。

パラメータ

名前	型	説明
`user`	`User`	削除するユーザーの表現。

リターン

Site - チェーン用のこの Site。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

サポート終了のメソッド

`addCollaborator(email)`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

新しい共同編集者をサイトに追加する

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

パラメータ

名前	型	説明
`email`	`String`	共同編集者として追加するユーザーのメールアドレス

リターン

Site - チェーン用のサイト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`addCollaborator(user)`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

ウェブサイトに新しい共同編集者を追加します。

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

パラメータ

名前	型	説明
`user`	`User`	共同編集者として追加するユーザー

リターン

Site - チェーン用のサイト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`addOwner(email)`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

ウェブサイトに新しい所有者を追加する

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

パラメータ

名前	型	説明
`email`	`String`	所有者として追加するユーザーのメールアドレス

リターン

Site - チェーン用のサイト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`addOwner(user)`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

ウェブサイトに新しい所有者を追加する

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

パラメータ

名前	型	説明
`user`	`User`	オーナーとして追加するユーザー

リターン

Site - チェーン用のサイト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`createAnnouncement(title, html, parent)`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

新しいお知らせを作成する

パラメータ

名前	型	説明
`title`	`String`	作成するお知らせページのタイトル
`html`	`String`	ページの HTML 本文
`parent`	`Page`	親ページ

リターン

Page - 作成された Page

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`createComment(inReplyTo, html, parent)`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

非推奨です。Page の createComment に置き換えられました。

新しいコメントを作成します。

パラメータ

名前	型	説明
`inReplyTo`	`String`	GData フィードの URL - 意味がなく、壊れている
`html`	`String`	コメントの内容
`parent`	`Page`	コメントが表示される保護者です

リターン

Comment - 新しく作成された Comment

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`createFileCabinetPage(title, name, html)`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

新しいファイルキャビネットページを作成します。1 つの親サイトまたは 1 つのページに 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

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

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

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

非推奨です。Page の createListItem に置き換えられました。

新しい ListItem を作成します。

パラメータ

名前	型	説明
`html`	`String`	アイテムの内容 - 無意味で壊れている
`columnNames`	`String[]`	列名、名前、
`values`	`String[]`	列の値を
`parent`	`Page`	ListPage の親

リターン

ListItem - チェーン用の ListItem。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`createWebAttachment(title, url, parent)`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

非推奨です。Page の createWebAttachment に置き換えられました。

新しいウェブ添付ファイルを作成します。

パラメータ

名前	型	説明
`title`	`String`	添付ファイルのタイトル
`url`	`String`	添付ファイルの URL
`parent`	`Page`	親ページ

リターン

Attachment - チェーン用のこのアタッチメント。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`deleteSite()`

非推奨。このメソッドは現在実装されていないため、今後使用できなくなります。

このサイトを削除します。

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

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getAllDescendants()`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

最大 200 ページまでの子孫ページ（直接的および間接的）の配列を取得します。

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

リターン

Page[] - 直接的および間接的な子ページの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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[] - 指定されたタイプの直接的および間接的な子ページの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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} インスタンスの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getChildByName(name)`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

特定の子ページを取得します。

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

パラメータ

名前	型	説明
`name`	`String`	子ページの名前

リターン

Page - 子ページ

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getChildren()`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

子ページの配列を取得します（最大 200 ページ）。

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

リターン

Page[] - 直接の子ページの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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[] - 指定されたタイプの直接の子ページの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスを含む配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getName()`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

サイトの名前を返す

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

リターン

String - この Site インスタンスの名前

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスを含む配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getSelfLink()`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

このサイトのフィード URL を取得します。

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

リターン

String - このサイトのフィードの URL

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getSiteName()`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

サイトの siteName を返す

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

リターン

String - サイトの siteName

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getSummary()`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

ウェブサイトの概要を返します。

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

リターン

String - このサイトの概要

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスを含む配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getTheme()`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

サイトのテーマを取得します。

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

リターン

String - このサイトのテーマ

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getTitle()`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

サイトのタイトルを返します。

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

リターン

String - このサイトのタイトル

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`getUrl()`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

このサイトの URL を取得します。

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

リターン

String - この Site インスタンスの URL

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 インスタンスの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 - メソッドチェーンのサイトインスタンス

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 - メソッドチェーンのサイトインスタンス

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 - メソッドチェーンのサイトインスタンス

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 - メソッドチェーンのサイトインスタンス

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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[] - 指定されたタイプの直接的および間接的な子ページの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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[] - 指定されたタイプの直接的および間接的な子ページの配列

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 - メソッドチェーンのサイト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds

`setTheme(theme)`

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

サイトのテーマを設定します。

テーマは有効なテーマ文字列である必要があります。網羅的なリストを取得するには、テストメソッドを記述し、無効な値を setTheme() に渡します。このスクリプトはサービスエラーをスローし、使用可能なテーマの完全なリストを返します。利用可能なテーマのリストは [サイトを管理]->[テーマ]でも確認できますテーマ名の文字列は、通常小文字ではテーマページのテーマ名と同じですが、スペースと特殊文字は除きます。たとえば「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 - メソッドチェーンのサイト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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 - メソッドチェーンのサイト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://sites.google.com/feeds