初心者でもわかるGoogle Apps Script活用のススメ

今日からGoogleサイトで使えるGASのコード一覧

SitesAppで使えるGASのコード一覧

本記事では、Google Apps ScriptでGoogleサイトに対して使うことができるSitesAppという処理の一覧表を用意しました。Googleの公式ドキュメントは英語なので、分かりづらいところもありますので、みなさんがそこで挫折しないように日本語で内容が把握できるようにします。

ただし、Googleサイトは、2016年11月22日に新しいバージョンにアップデートされましたが、Google Apps Scriptは新しいバージョンに対応されていません

下記のコードを利用する際は、以前のバージョンに戻して使う必要がありますのでご注意下さい。
※2022年4月現在は以前のバージョンに戻すこともできなくなっています。
新しいGoogleサイトでは、以前まであったスクリプトエディタという項目がメニューにありませんので利用することができません。
ちなみに、2021年5月までは旧バージョンのサイトを作成できたのですが、今現在は作成することもできなくなりました
そのため、下記コードはすでにサイトを旧バージョンで作成済みのファイルでのみ利用できるものとなります。
Google Apps Scriptの公式リファレンスでもSites(Classic)と表記されているため、参考までのレガシー情報となります。

SitesAppの概要

SitesAppとは、Google Apps ScriptでGoogleドキュメントに対する操作を行うコードですが、SitesAppに用意されているメソッドでは、次のような操作を行うことができます。

  • ページへのファイル添付
  • カラムの操作
  • コメントの操作
  • リストの操作
  • ページの操作
  • サイトの操作

クラス名一覧

AttachmentColumnComment
ListItemPageSite

※クリックすると対象場所にジャンプします

クラス別メソッド名一覧

Class Attachment

メソッド名返り値簡単な説明
deleteAttachmentvoid添付ファイルを削除
getAsBlob添付ファイルを任意のファイル形式で取得
getAttachmentTypeAttachmentType添付ファイルのタイプをHOSTED or WEB形式で取得
getBlobBlob添付ファイルをBlobとして取得
getContentTypeString添付ファイルのMIMEタイプを取得
getDatePublishedDate添付ファイルが最初に公開された日を取得
getDescriptionString添付ファイルの説明を取得
getLastUpdatedDate添付ファイルの最終更新日を取得
getParentPage添付ファイルがネストされているページを取得
getTitleString添付ファイル名を取得
getUrlString添付ファイルのダウンロードURLを取得
setContentTypeAttachment添付ファイルのMIMEタイプを設定
setDescriptionAttachment添付ファイルの説明を設定
setFromAttachmentBlobファイルからページにファイルを添付する
setParentAttachment添付ファイルの親ページを設定
setTitleAttachment添付ファイル名を設定
setUrlAttachment添付ファイルのダウンロードURLを設定

Class Column

メソッド名返り値簡単な説明
deleteColumnvoidカラムを削除
getNameStringカラム名を取得
getParentPageカラムが属する親ページを取得
setNameColumnカラムの名前を設定

Class Comment

メソッド名返り値簡単な説明
deleteCommentvoidコメントを削除
getAuthorEmailStringコメント者のメールアドレスを取得
getAuthorNameStringコメント者の名前を取得
getContentStringコメントの内容を取得
getDatePublishedDateコメントがされた日を取得
getLastUpdatedDateコメントの最終更新日を取得
getParentPageコメントの親ページを取得
setContentCommentコメントの内容を設定
setParentCommentコメントの親ページを設定

Class ListItem

メソッド名返り値簡単な説明
deleteListItemvoidリストを削除
getDatePublishedDateリストが最初に公開された日を取得
getLastUpdatedDateリストの最終更新日を取得
getParentPageリストの親ページを取得
getValueByIndexStringカラム番号を指定してリストの値を取得
getValueByNameStringカラム名を指定してリストの値を取得
setParentListItemリストの親ページを設定
setValueByIndexListItemリスト番号を指定してリストの値を設定
setValueByNameListItemリスト名を指定してリストの値を設定

Class Page

メソッド名返り値簡単な説明
addColumnColumn新しいカラムをリストに追加
addHostedAttachmentAttachmentページに添付ファイルを追加
addListItemListItemリストに項目を追加
addWebAttachmentAttachmentページにファイルURLでファイルを添付
createAnnouncementPageページにお知らせを追加する
createAnnouncementsPagePage新しいお知らせページを作成
createFileCabinetPagePage新しいファイルキャビネットページを作成
createListPagePage新しいリストページを作成
createPageFromTemplatePageテンプレートから新しいページを作成
createWebPagePage新しいサイトを作成
deletePagevoidページを削除
getAllDescendantsPage[]子ページを取得(最大200ページ)
getAnnouncementsPage[]ページのお知らせを取得
getAttachmentsAttachment[]ページの添付ファイルを取得
getAuthorsString[]ページオーナーのメールアドレスを取得
getChildByNamePageページ名で特定の子ページを取得
getChildrenPage[]子ページを取得(最大200ページ)
getColumnsColumn[]リストのカラムを取得
getDatePublishedDateページが公開された日を取得
getHtmlContentStringページの内容をHTML形式で取得
getIsDraftBooleanページが下書きかどうか取得
getLastEditedDateページの最終更新日を取得(内容変更のみ)
getLastUpdatedDateページの最終更新日を取得(コンテンツの移動など、内容変更以外を含む)
getListItemsListItem[]リストの項目を取得
getNameStringページ名を取得
getPageTypePageTypeページタイプをSitesApp.PageType型として取得
getParentPageページの親ページを取得
getTextContentStringページのコンテンツをテキストとして取得
getTitleStringページのタイトルを取得
getUrlStringページのURLを取得
isDeletedBooleanページが削除済みかどうか取得
isTemplateBooleanページがコピー可能かどうか取得
publishAsTemplatePageコピー可能なテンプレートとしてページを公開する
searchPage[]検索クエリに合致する子ページを取得(最大200ページ)
setHtmlContentPageページのHTMLを設定
setIsDraftPageページを下書きモードに設定
setNamePageページ名を設定
setParentPageページの親ページを設定
setTitlePageページ名を設定

Class Site

メソッド名返り値簡単な説明
addEditorSiteサイトの編集者を追加
addEditorsSite複数のユーザーをサイトの編集者に追加
addOwnerSiteウェブサイトのオーナーを追加
addViewerSiteサイトの閲覧者を追加
addViewersSite複数のユーザーをサイトの閲覧者に追加
createAnnouncementsPagePageお知らせページを作成
createFileCabinetPagePageファイル格納ページを作成
createListPagePage新しいリストページを作成
createPageFromTemplatePageテンプレートから新しいページを作成
createWebPagePage新しいページを作成
getAllDescendantsPage[]子ページを取得(最大200ページ)
getChildByNamePageファイル名で特定の子ページを取得
getChildrenPage[]子ページを取得(最大200ページ)
getEditorsUser[]サイトの編集者を取得
getNameStringサイト名を取得
getOwnersUser[]サイトのオーナーを取得
getSummaryStringサイトのサマリーを取得
getTemplatesPage[]テンプレートページをすべて取得
getThemeStringサイトのテーマを取得
getTitleStringサイトのタイトルを取得
getUrlStringサイトのURLを取得
getViewersUser[]サイトの閲覧者とコメント者を取得
removeEditorSite編集者をサイトから削除
removeOwnerSiteメールアドレスを指定して、サイトから特定のオーナーを削除
removeViewerSiteサイトの閲覧者とコメント者を削除
searchPage[]検索クエリに合致する子ページを取得(最大200ページ)
setSummarySiteサイトのサマリーを設定
setThemeSiteサイトのテーマを設定
setTitleSiteサイトのタイトルを設定

列挙型一覧

PageTypeAttachmentType

※クリックすると対象場所にジャンプします

列挙型名一覧

列挙型のメソッドを利用するときには、基本的には『SitesApp.列挙型名.プロパティ名』の形で利用します。
例えば、AttachmentTypeのWEBを設定したい場合は、『SitesApp.AttachmentType.WEB』という形で記述します。

Enom AttachmentType

プロパティタイプ説明
WEBEnom
HOSTEDEnom

Enom PageType

プロパティタイプ説明
WEB_PAGEEnum
LIST_PAGEEnum
ANNOUNCEMENTEnum
ANNOUNCEMENTS_PAGEEnum
FILE_CABINET_PAGEEnum
Exit mobile version