Google Apps Script Documentation - Site Servcies

Googleを追いかけろ！

Class Page
.. Google Sites上のページ。 Google Site内でスクリプトエディタを利用できます。
【サイトを管理】 → 【Apps Scripts】 → 【エディタを立ち上げる】

class Page : Members
member	Type	説明
createAnnouncementsPage	Page	子として新規のお知らせページを作成する
createFileCabinetPage	Page	子として新規のファイルキャビネットページを作成する
createListPage		子として新規のリストページを作成する
createWebPage	Page	子として新規のウェブページを作成する
createPageFromTemplate	Page	テンプレートをもとに子として新しいページを作成する
getChildren	Page [ ]	子としてのすべてのページを返す
getChildByName	Page	指定された名前を持つ子としてのページを返す
getChildByName	Page	指定された名前を持つ子としてのページを返す
search	Page [ ]	クエリ文字列にマッチしたすべての子孫のページを返す
getPageType	PageType	このページのタイプを返す(WEB_PAGE, LIST_PAGE, etc.)
getLastUpdated	Date	このページの最終更新日を取得する
getDatePublished	Date	このページがオリジナルとして公開された日付を返す
getTextContent	String	htmlを取り除かれたプレーンテキストとしてこのページのコンテンツを取得する
getParent	Page	このページの親ページを取得する：サイトのルートページの場合はnullを返す
setParent	Page	このページの親ページを設定する：このページをサイトのルートに移動する場合はnullに設定する
getTitle	String	このページのタイトルを取得する
setTitle	Page	このページのタイトルを設定する
getName	String	このページの名前（ページのURLの部分）を返す
setName	Page	このページの名前を設定する（したがって、そのURLは変更される）
getAuthors	String [ ]	このページの著者のメールを返す
getHtmlContent	String	HTMとしてこのページの内容を返す
setHtmlContent	Page	HTMとしてこのページを設定する
getUrl	String	このページのURLを返す
addHostedAttachment	Attachment	新たにホストされたこのBlobのデータ、コンテンツタイプ、名前を使用した添付ファイルが追加される
addHostedAttachment	Attachment	新たにホストされたこのBlobのデータ、コンテンツタイプ、名前を使用した添付ファイルが追加される(指定された説明テキスト付き)
addWebAttachment	Attachment	新しいWebの添付ファイルを追加する（getPageType（）== FILE_CABINET_PAGEが有効なページのみ）
getAttachments	Attachment	このページのすべての添付ファイル（ホストとWebの両方）を取得する
getComments	Comment [ ]	このページの任意のコメントを返す
addComment	Comment	新規のコメントを追加する
getIsDraft	bool	ドラフトモード（草稿途中）の有無を取得する
setIsDraft	Page	ドラフトモード（草稿途中）の有無を設定する
isTemplate	bool	このページオブジェクトがサイトのページテンプレートかどうかを返す
publishAsTemplate	Page	このページをサイトの新規ページテンプレートとして発行する
deletePage		このページを削除する
getAnnouncements	Page [ ]	このページの子供として任意のお知らせを取得する
createAnnouncement	Page	このページの子供として任意のお知らせを設定する（getPageType() == ANNOUNCEMENTS_PAGEが有効なページのみ）
getColumns	Column [ ]	ページリストのカラムを返す（getPageType() == LIST_PAGEが有効なページのみ）
addColumn	Column	ページリストのカラムを追加する（getPageType() == LIST_PAGEが有効なページのみ）
getListItems	ListItem [ ]	ページリストの行を返す（getPageType() == LIST_PAGEが有効なページのみ）
addListItem	ListItem	ページリストに行を追加する（getPageType() == LIST_PAGEが有効なページのみ）

非推奨メンバー		2010/08/10
getSelfLink	String	このコメント用の Google Data feedのUrlを取得する
getPageName	String	getNameと同義語
setPageName	Page	setNameと同義語
getContent	String	getHtml()と同義語
setContent	Page	setHtmlContent()と同義語
getHtml	String	このページのdivタグで囲まれたHTMLコンテンツを返す
setHtml	Page	setHtmlContent()と同義語
getItems	ListItem[]	getListItems()と同義語
getColumnNames	String [ ]	ページリストのカラム名を返す（getPageType() == LIST_PAGEが有効なページのみ）
setColumnNames	Page	ページリストのカラム名を設定する（getPageType() == LIST_PAGEが有効なページのみ）

method createAnnouncementsPage(title, name, html)

子として新しい発表のページを作成する
( 参考 :createFileCabinetPage,createListPage,createWebPage)

Arguments :
name	Type	説明
title	String	新しいページのタイトル
name	String	新しいページの名前
html	String	新しいページのHTMLコンテンツ

戻り値 :
Type	説明
Page	新たに作成されたAnnouncementページ

method createFileCabinetPage(title, name, html)

子として新しいファイルキャビネットのページを作成する
( 参考 :createAnnouncementsPage,createListPage,createWebPage)

Arguments :
name	Type	説明
title	String	新しいページのタイトル
name	String	新しいページの名前
html	String	新しいページのHTMLコンテンツ

戻り値 :
Type	説明
Page	新たに作成されたキャビネットページ

method createListPage(title, name, html, columnNames)

子として新しいリストのページを作成する
( 参考 :createAnnouncementsPage,createFileCabinetPage,createWebPage)

Arguments :
name	Type	説明
title	String	新しいページのタイトル
name	String	新しいページの名前
html	String	新しいページのHTMLコンテンツ
columnNames	String [ ]	新しいページのリストカラムの名前

戻り値 :
Type	説明
Page	新たに作成されたリストページの名前

method createWebPage(title, name, html)

子として新しいウェブページを作成する
( 参考 :createAnnouncementsPage,createFileCabinetPage,createListPage)

Arguments :
name	Type	説明
title	String	新しいページのタイトル
name	String	新しいページの名前
html	String	新しいページのHTMLコンテンツ

戻り値 :
Type	説明
Page	新たに作成されたリストページの名前

method createPageFromTemplate(title, name, template)

テンプレートをもとに子として新しいページを作成する
( 参考 :createAnnouncementsPage,createFileCabinetPage,createListPage,createWebPage)

Arguments :
name	Type	説明
title	String	新しいページのタイトル
name	String	新しいページの名前
template	Page	コピーすべきテンプレートページ

戻り値 :
Type	説明
Page	新たに作成されたページ

method getChildren(optAdvancedArgs)

子としてのすべてのページを返す
( 参考 :getAllDescendants,getChildByName)

Arguments :
name	Type	説明
optAdvancedArgs	int	未定義

*Advanced Arguments :**
name	Type	説明
type	PageType [ ]	これらのページのタイプだけを取得
start	int	番号が最初のページの結果を返す（初期値は0）
max	int	番号が最大のページの結果を返す（初期値は200）
search	String	このクエリに適合するコメントを返すだけ
includeDrafts	bool	下書きページが含まれるかどうか（初期値はfalse）
includeDeleted	bool	削除ページが含まれるかどうか（初期値はfalse）
search	String	このクエリに適合するコメントを返すだけ

戻り値 :
Type	説明
Page [ ]	要求された子のページ

method getChildByName(name)

指定された名前を持つ子としてのページを返す
( 参考 :getChildren)

Arguments :
name	Type	説明
name	String	返すべき子の名前

戻り値 :
Type	説明
Page	要求された子のページ

method search(query, optAdvancedArgs)

クエリ文字列にマッチしたすべての子孫のページを返す
( 参考 :getAllDescendants,getChildByName,getChildren)

Arguments :
name	Type	説明
query	String	検索クエリ
optAdvancedArgs	Object	未定義

*Advanced Arguments :**
name	Type	説明
type	PageType [ ]	これらのページのタイプだけを取得
start	int	番号が最初のページの結果を返す（初期値は0）
max	int	番号が最大のページの結果を返す（初期値は200）
search	String	このクエリに適合するコメントを返すだけ
includeDrafts	bool	下書きページが含まれるかどうか（初期値はfalse）
includeDeleted	bool	削除ページが含まれるかどうか（初期値はfalse）

戻り値 :
Type	説明
Page [ ]	検索クエリ（オプションの引数によって修正された）と一致するすべての子のページ

method getPageType()

このページのタイプを返す(WEB_PAGE, LIST_PAGE, etc.)

戻り値 :
Type	説明
PageType	このページのタイプ

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var pageType = pages[0].getPageType();

method getLastUpdated()

このページの最終更新日を取得する
( 参考 :getDatePublished)

戻り値 :
Type	説明
Date	このページの最終更新日

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var lastPublished = pages[0].getLastUpdated();

method getDatePublished()

このページがオリジナルとして公開された日付を返す
( 参考 :getLastUpdated)

戻り値 :
Type	説明
Date	このページがオリジナルとして公開された日付

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var datePublished = pages[0].getDatePublished();

method getTextContent()

htmlを取り除かれたプレーンテキストとしてこのページのコンテンツを取得する
( 参考 :getHtmlContent)

戻り値 :
Type	説明
String	htmlを取り除かれたプレーンテキストとしてこのページのコンテンツ

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var textContent = pages[0].getTextContent();

method getParent()

このページの親ページを取得する：サイトのルートページの場合はnullを返す
( 参考 :getHtmlContent)

戻り値 :
Type	説明
Page	このページの親ページ:ルートページの場合はnull

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var parent = pages[0].getParent();

method setParent()

このページの親ページを設定する：このページをサイトのルートに移動する場合はnullに設定する
( 参考 :getParent)

Arguments :
name	Type	説明
parent	Page	このページの新しい親

戻り値 :
Type	説明
Page	連結のためのこのページ

サンプル :

//Move Page to the root by setting the parent to null
var page = SitesApp.getSite('example.com', 'mysite').getChildByName('mychildpage');
for (var i = 0; i < page.getChildren().length; i++) {
  var movedPage = page.getChildren()[i].setParent(null);
}

サンプル :

//Move the children of one Page under a different Page
var site = SitesApp.getSite('example.com', 'mysite');
var page = site.getChildByName('childpage1');
var newParent = site.getChildByName('childpage2');
for (var i = 0; i < page.getChildren().length; i++) {
  var movedPage = page.getChildren()[i].setParent(newParent);
}

method getTitle()

このページのタイトルを取得する
( 参考 :setTitle)

戻り値 :
Type	説明
String	このページのタイトル

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var title = pages[0].getTitle();

method setTitle()

このページのタイトルを設定する
( 参考 :getTitle)

Arguments :
name	Type	説明
title	String	このページの新しいタイトル

戻り値 :
Type	説明
Page	連結のためのこのページ

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var page = pages[0].setTitle('New Page Title');

method getName()

このページの名前（ページのURLの部分）を返す
( 参考 :setName)

戻り値 :
Type	説明
String	このページの名前

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var name = pages[0].getName();

method setName()

このページの名前を設定する（したがって、そのURLは変更される）
( 参考 :getName)

Arguments :
name	Type	説明
name	String	このページの新しい名前

戻り値 :
Type	説明
Page	連結のためのこのページ

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var page = pages[0].setName('newname');

method getAuthors()

このページの著者のメールを返す

戻り値 :
Type	説明
String [ ]	このページの著者のメール

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var authors = pages[0].getAuthors()

method getHtmlContent()

HTMとしてこのページの内容を返す
( 参考 :getTextContent,setHtmlContent)

戻り値 :
Type	説明
String	このページのHTMLコンテンツ

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var content = pages[0].getHtmlContent();

method setHtmlContent()

HTMとしてこのページを設定する
( 参考 :getHtmlContent)

Arguments :
name	Type	説明
html	String	このページのHTMLコンテンツ

戻り値 :
Type	説明
Page	連結のためのこのページ

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var page = pages[0].setHtmlContent('＜div＞some new content＜/div＞');

method getUrl()

このページのURLを返す

戻り値 :
Type	説明
String	このページのURL

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var url = pages[0].getUrl();

method addHostedAttachment(blob)

新たにホストされたこのBlobのデータ、コンテンツタイプ、名前を使用した添付ファイルが追加される
( 参考 :addWebAttachment,getAttachments)

Arguments :
name	Type	説明
blog	Blob	この新しい添付ファイルのデータ、コンテンツタイプ、名前を含むBolbオブジェクト

戻り値 :
Type	説明
Attachment	新たに作成された添付ファイル

method addHostedAttachment(blob, description)

新たにホストされたこのBlobのデータ、コンテンツタイプ、名前を使用した添付ファイルが追加される(指定された説明テキスト付き)
( 参考 :addWebAttachment,getAttachments)

Arguments :
name	Type	説明
blog	Blob	この新しい添付ファイルのデータ、コンテンツタイプ、名前を含むBolbオブジェクト
description	String	添付ファイルの説明

戻り値 :
Type	説明
Attachment	新たに作成された添付ファイル

method addWebAttachment(title, description, url)

新しいWebの添付ファイルを追加する（getPageType（）== FILE_CABINET_PAGEが有効なページのみ）
( 参考 :addHostedAttachment,getAttachments)

Arguments :
name	Type	説明
title	String	この新しい添付ファイルのタイトル
description	String	添付があればその説明
url	String	このウエブ添付ファイルのURL

戻り値 :
Type	説明
Attachment	新たに作成された添付ファイル

method getAttachments(optAdvancedArgs)

このページのすべての添付ファイル（ホストとWebの両方）を取得する
( 参考 :addWebAttachment,addHostedAttachment)

Arguments :
name	Type	説明
optAdvancedArgs	Object	未定義

*Advanced Arguments :**
name	Type	説明
start	int	最初の番号で返されるべき結果（初期値は0）
max	int	最大の番号で返されるべき結果（初期値は200）

戻り値 :
Type	説明
Attachment	新たに作成された添付ファイル

サンプル :

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments();

var pages = SitesApp.getSite('example.com', 'mysite').getChildren();
var attachments = pages[0].getAttachments({start: 1, max: 5});

method getComments(optAdvancedArgs)

このページの任意のコメントを返す
( 参考 :addComment)

Arguments :
name	Type	説明
optAdvancedArgs	Object	未定義

*Advanced Arguments :**
name	Type	説明
start	int	最初の番号で返されるべき結果（初期値は0）
max	int	最大の番号で返されるべき結果（初期値は200）
search	String	このクエリに適合するコメントのみ返す

戻り値 :
Type	説明
Comment[ ]	このページのコメント

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var comments = pages[0].getComments();
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var comments = pages[0].getComments({search: 'some string'});
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var comments = pages[0].getComments({start: 1, max: 5});

method addComment(comment)

新規のコメントを追加する
( 参考 :getComments)

Arguments :
name	Type	説明
comment	String	新しいコメントの内容

戻り値 :
Type	説明
Comment[ ]	新しく作成されたコメント

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var comment = pages[0].addComment('some string');

method getIsDraft()

ドラフトモード（草稿途中）の有無を取得する
( 参考 :setIsDraft)

戻り値 :
Type	説明
bool	このページが下書きかどうか

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var isDraft = pages[0].getIsDraft();

method setIsDraft()

ドラフトモード（草稿途中）の有無を設定する
( 参考 :getIsDraft)

Arguments :
name	Type	説明
draft	bool	ページを下書きにすべきかどうか

戻り値 :
Type	説明
Page	連結すべきページ

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var page = pages[0].setIsDraft(true);

method isTemplate()

このページオブジェクトがサイトのページテンプレートかどうかを返す
( 参考 :publishAsTemplate)

戻り値 :
Type	説明
bool	このページがテンプレートかどうか

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var isTemplate = pages[0].isTemplate();

method publishAsTemplate(name)

このページをサイトの新規ページテンプレートとして発行する
( 参考 :isTemplate)

Arguments :
name	Type	説明
name	String	新しいテンプレートの名前

戻り値 :
Type	説明
Page	新しく発行されたテンプレート

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); var page = pages[0].publishAsTemplate('templatename');

method method deletePage()

このページを削除する

サンプル :
var pages = SitesApp.getSite('example.com', 'mysite').getChildren(); pages[0].deletePage();

method getAnnouncements(optAdvancedArgs)

このページの子供として任意のお知らせを取得する
( 参考 :createAnnouncement)

Arguments :
name	Type	説明
optAdvancedArgs	Object	未定義

*Advanced Arguments :**
name	Type	説明
start	int	最初の番号で返されるべき結果（初期値は0）
max	int	最大の番号で返されるべき結果（初期値は200）
search	String	このクエリに適合するコメントのみを返す
includeDrafts	bool	下書きのページを含むかどうかの有無（初期値はfalse）
includeDeleted	bool	削除されたページを含むかどうかの有無（初期値はfalse）

戻り値 :
Type	説明
Page	このページのお知らせ

サンプル :
var page = SitesApp.getSite('example.com', 'mysite').getChildByName('myannouncements'); var announcements = page.getAnnouncements();
var page = SitesApp.getSite('example.com', 'mysite').getChildByName('myannouncements'); var announcements = page.getAnnouncements({max: 50, includeDeleted: true});
var page = SitesApp.getSite('example.com', 'mysite').getChildByName('myannouncements'); var announcements = page.getAnnouncements({search: 'some string'});

method createAnnouncement(title, html)

このページの子供として任意のお知らせを設定する（getPageType() == ANNOUNCEMENTS_PAGEが有効なページのみ）
( 参考 :getAnnouncements)

Arguments :
name	Type	説明
title	String	新しいお知らせのタイトル
html	String	お知らせのHTMLコンテンツ

戻り値 :
Type	説明
Page	新しく作成されたお知らせ

サンプル :
var page = SitesApp.getSite('example.com', 'mysite').getChildByName('myannouncements'); var announcement = page.createAnnouncement('my title', '＜div＞some HTML＜/div＞');

method getColumns()

ページリストのカラムを返す（getPageType() == LIST_PAGEが有効なページのみ）
( 参考 :addColumn)

戻り値 :
Type	説明
column[ ]	このページリストのためのカラム

サンプル :
var page = SitesApp.getSite('example.com', 'mysite').getChildByName('mylistpage'); var columns = page.getColumns();

method addColumn(name)

ページリストのカラムを追加する（getPageType() == LIST_PAGEが有効なページのみ）
( 参考 :getColumn)

Arguments :
name	Type	説明
name	String	新しいカラムの名前

戻り値 :
Type	説明
Column	新しく作成されたカラム

サンプル :
var page = SitesApp.getSite('example.com', 'mysite').getChildByName('mylistpage'); var column = page.addColumn('new column name');

method getListItems()

ページリストの行を返す（getPageType() == LIST_PAGEが有効なページのみ）
( 参考 :addListItem)

戻り値 :
Type	説明
ListItem	このページリストの行

サンプル :
var page = SitesApp.getSite('example.com', 'mysite').getChildByName('mylistpage'); var items = page.getListItems();

method addListItem(values)

ページリストに行を追加する（getPageType() == LIST_PAGEが有効なページのみ）
( 参考 :getListItems)

Arguments :
name	Type	説明
values	String [ ]	この行のセルのための値

戻り値 :
Type	説明
ListItem	新しく作成された行

サンプル :
var page = SitesApp.getSite('example.com', 'mysite').getChildByName('mylistpage'); var item = page.addColumn(['value 1', 'value 2']);

非推奨メンバー		2010/08/10
getSelfLink	String	このコメント用の Google Data feedのUrlを取得する
getPageName	String	getNameと同義語
setPageName	Page	setNameと同義語
getContent	String	getHtml()と同義語
setContent	Page	setHtmlContent()と同義語
getHtml	String	このページのdivタグで囲まれたHTMLコンテンツを返す
setHtml	Page	setHtmlContent()と同義語
getItems	ListItem[]	getListItems()と同義語
getColumnNames	String [ ]	ページリストのカラム名を返す（getPageType() == LIST_PAGEが有効なページのみ）
setColumnNames	Page	ページリストのカラム名を設定する（getPageType() == LIST_PAGEが有効なページのみ）