GAS（Google Apps Script）の関数・メソッド・クラス一覧【2024年】

GAS（Google Apps Script）はさまざまなGoogleサービスと連携でき、多くの作業を自動化できます。しかし実際に実装しようと思うと、どのような「クラス(class)」や「関数(function)」、「メソッド(method)」が用意されているのか分からず、苦戦している人も多いのではないでしょうか？

そこで今回は「GAS（Google Apps Script）の関数・メソッド一覧」というテーマで解説します。

GASのリファレンスは下記の記事を参照ください。

GAS（Google Apps Script）の関数・メソッド・クラス一覧

Googleスプレッドシートで使えるGASの関数一覧

SpreadsheetAppクラス

メソッド	仕様
createメソッド	スプレッドシートを生成
getActiveSpreadsheetメソッド	アクティブなスプレッドシートのオブジェクトを生成
getActiveSheetメソッド	アクティブなシートのオブジェクトを生成
openByIdメソッド	IDで指定したスプレッドシートのオブジェクトを生成

Spreadsheetクラス

メソッド	仕様
addMenuメソッド	メニューを追加
getIdメソッド	スプレッドシートIDを取得
getUrlメソッド	スプレッドシートのURLを取得
getNameメソッド	スプレッドシートのタイトル名を取得
getSheetByNameメソッド	タブ名で指定したシートオブジェクトを取得

Sheetクラス

メソッド	仕様
appendRowメソッド	行を追加
deleteRowsメソッド	行を削除
insertRowsメソッド	行を挿入
getLastRowメソッド	最終行の行数を取得
appendColumnメソッド	列を追加
deleteColumnsメソッド	列を削除
insertColumnsメソッド	列を挿入
getLastColumnメソッド	最終列の列数を取得
clearContensメソッド	セル値をすべてクリア
getDataRangeメソッド	すべてのセル値を配列で取得
getNameメソッド	シート名を取得
getRangeメソッド	セル範囲のRangeオブジェクトを取得
newChartメソッド	新しいチャート（グラフ）を生成
insertChartメソッド	チャート（グラフ）を挿入

Rangeクラス

メソッド	仕様
activateAsCurrentCellメソッド	指定したセルをカレントセルにする
clearメソッド	セル値をクリア（書式含む）
clearContentメソッド	セル値をクリア（書式含まない）
getA1Notationメソッド	セル範囲の座標を取得
getActiveCellメソッド	アクティブなセルを取得
getColumnメソッド	指定した列を取得
getLastColumnメソッド	最終列を取得
getRowメソッド	指定した行を取得
getLastRowメソッド	最終行を取得
getValueメソッド	セルの値を取得
getValuesメソッド	セル範囲の値を配列で取得
offsetメソッド	隣接するセル範囲を取得
setValueメソッド	セルの値を挿入
setValuesメソッド	セル範囲の値を配列で挿入

EmbeddedChartBuilderクラス

メソッド	仕様
addRangeメソッド	データ範囲を設定
asAreaChartメソッド	グラフタイプを面グラフに設定
asBarChartメソッド	グラフタイプを縦棒グラフに設定
asColumnChartメソッド	グラフタイプを棒グラフに設定
asLineChartメソッド	グラフタイプを折れ線グラフに設定
asScatterChartメソッド	グラフタイプを散布図グラフに設定
buildメソッド	chartオブジェクトの生成を実行
setChartTypeメソッド	チャートタイプを設定
setColorsメソッド	グラフの色を設定
setOptionメソッド	グラフのオプションを設定
setPositionメソッド	グラフの挿入位置を設定

EmbeddedChartクラス

メソッド	仕様
getBlobメソッド	Blobオブジェクトを取得

Googleドキュメントで使えるGASの関数一覧

DocumentAppクラス

メソッド	仕様
getActiveDocumentメソッド	スクリプトに紐付いたDocumentのオブジェクトを生成
openByUrlメソッド	URLで指定したDocumentのオブジェクトを生成
openByIdメソッド	Idで指定したDocumentのオブジェクトを生成

Documentクラス

メソッド	仕様
getNameメソッド	Documentのタイトルを取得
getBodyメソッド	Document本文のオブジェクトを取得

Bodyクラス

メソッド	仕様
getTextメソッド	Document本文のテキストを取得
setTextメソッド	Document本文にテキストを挿入
replaceTextメソッド	Document本文のテキストに置換処理

Googleカレンダーで使えるGASの関数一覧

CalendarAppクラス

メソッド	仕様
getDefaultCalendarメソッド	実行者のGoogleカレンダーオブジェクトを取得
getCalendarByIdメソッド	IDで指定したGoogleカレンダーオブジェクトを取得

Calendarクラス

メソッド	仕様
createEventメソッド	カレンダーイベントを生成する
getEventsメソッド	任意の時間内にあるカレンダーイベントをすべて取得する
getEventsForDayメソッド	任意の日付にあるカレンダーイベントをすべて取得する
getNameメソッド	カレンダー名を取得する

Eventクラス

メソッド	仕様
getIdメソッド	カレンダーIDを取得する
getDescriptionメソッド	カレンダーの説明を取得する
getStartTimeメソッド	カレンダーの開始時刻を取得する
getEndTimeメソッド	カレンダーの終了時刻を取得する
getLocationメソッド	カレンダーの位置情報を取得する
getTitleメソッド	カレンダーのタイトルを取得する
setTitleメソッド	カレンダーのタイトルを挿入する

Googleフォームで使えるGASの関数一覧

FormAppクラス

メソッド	仕様
createメソッド	Googleフォームを生成
createTextValidationメソッド	テキストバリデーションオブジェクトを生成

Formクラス

メソッド	仕様
addCheckboxItemメソッド	チェックボックス要素を生成
addListItemメソッド	プルダウン要素を追加
addMultipleChoiceItemメソッド	ラジオボタン要素を追加
addTextItemメソッド	記述式の質問要素を追加
getIdメソッド	フォームのIDを取得
setDescriptionメソッド	フォームの説明を挿入

CheckboxItemクラス

メソッド	仕様
setChoiceValuesメソッド	選択項目を設定する
setRequiredメソッド	必須かどうかの設定
setTitleメソッド	タイトルの設定
showOtherOptionメソッド	「その他」を項目に含めるどうかの設定

ListItemクラス

メソッド	仕様
setChoiceValuesメソッド	選択項目を設定
setRequiredメソッド	必須かどうかの設定
setTitleメソッド	タイトルの設定

MultipleChoiceItemクラス

メソッド	仕様
setChoiceValuesメソッド	選択項目を設定
setRequiredメソッド	必須かどうかの設定
setTitleメソッド	タイトルの設定

TextItemクラス

メソッド	仕様
setItemメソッド	テキストを設定
setRequiredメソッド	必須かどうかの設定
setValidationメソッド	回答の検証の設定
setTitleメソッド	タイトルの設定

TextValidationBuilderクラス

メソッド	仕様
buildメソッド	requireTextIsEmailメソッド

Google Driveで使えるGASの関数一覧

DriveAppクラス

メソッド	仕様
getFileByIdメソッド	指定したIDのファイルオブジェクトを生成
getFolderByIdメソッド	指定したIDのフォルダオブジェクトを生成
getRootFolderメソッド	ルートレベルのフォルダーオブジェクトを生成

Folderクラス

メソッド	仕様
addFileメソッド	フォルダにファイルを追加する
createFileメソッド(内容)	内容からファイルを生成
createFileメソッド(Blob)	Blobからファイルを生成
getNameメソッド	ファイル名を取得
setNameメソッド	ファイル名を挿入
removeFileメソッド	ファイルを削除

Fileクラス

メソッド	仕様
getBlobメソッド	Blobオブジェクトを生成
getNameメソッド	ファイル名を取得
getUrlメソッド	ファイルのURLを取得

Gmailで使えるGASの関数一覧

GmailAppクラス

メソッド	仕様
createDraftメソッド	メールの下書きを作成する
getThreadメソッド	スレッドオブジェクトを取得する
getMessagesForThreadsメソッド	メッセージをスレッドごと配列として取得する
moveThreadsToArchiveメソッド	スレッドごとアーカイブする
searchメソッド	メールを検索する
sendEmailメソッド	メールを送信する

GmailThreadクラス

メソッド	仕様
getPermalinkメソッド	スレッドのパーマリンクを取得する

GmailMessageクラス

メソッド	仕様
getAttachmentsメソッド	メールの添付ファイルをすべて取得する
getDateメソッド	メールの送信日を取得する
getFromメソッド	メールの送信元を取得する
getIdメソッド	メールIDを取得する
getPlainBodyメソッド	メール本文のテキストを取得する
getReplyToメソッド	メールの返信先を取得する
getSubjectメソッド	メールの件名を取得する
markReadメソッド	既読メールかどうか判定する
isStarredメソッド	メールにスターが付いているか判定する
starメソッド	メールにスターを付ける
unstarメソッド	メールからスターを外す

GmailAttachmentクラス

メソッド	仕様
getNameメソッド	添付ファイルのファイル名を取得

JavaScript組み込みのGAS関数一覧

Arrayオブジェクト

メソッド	仕様
indexOfメソッド	配列の先頭の要素から検索をする
lastIndexOfメソッド	配列の末尾の要素から検索をする
lengthプロパティ	配列・文字列の要素数を数える
pushメソッド	配列の最後に要素を追加する
someメソッド	配列の要素が関数を満たすかを判定する
spliceメソッド	配列の任意の場所に要素を追加する

Stringオブジェクト

メソッド	仕様
matchメソッド	特定の文字列が含まれているか判定する
replaceメソッド	文字列中の特定パターンを置換文字列と置換する
sliceメソッド	文字列から一定の長さだけ抽出する
splitメソッド	文字列を特定の文字で分割する

Dateオブジェクト

メソッド	仕様
getFullYearメソッド	年の値を取得する
getMonthメソッド	月の値を取得する
getDateメソッド	日の値を取得する
getDayメソッド	曜日の値を取得する
getHoursメソッド	時の値を取得する
getMinutesメソッド	分の値を取得する
getSecondsメソッド	秒の値を取得する
getTimeメソッド	年月日時分秒の値を取得する
setFullYearメソッド	年の値を挿入する
setMonthメソッド	月の値を挿入する
setDateメソッド	日の値を挿入する
setHoursメソッド	時の値を挿入する
setMinutesメソッド	分の値を挿入する
setSecondsメソッド	秒の値を挿入する

Mathオブジェクト

メソッド	仕様
randomメソッド	乱数を生成する
floorメソッド	小数点以下の桁を切り捨てる

まとめ

今回は「GAS（Google Apps Script）の関数・メソッド一覧」というテーマで解説しました。

「クラス・オブジェクトの構造はこうなっているのか」「関数の書式はこうなっているのか」など、辞書代わりにお役に立てれば幸いです。

では、また。