GoogleAppsScript(GAS)の便利な関数一覧まとめ【2023最新】

Google Apps Script（GAS）で使用できる便利な関数一覧を紹介します。

GASは、Googleのさまざまなサービスを自動化したり、カスタマイズしたりするためのスクリプト言語です。本記事では、GASの主要なクラスとそのメソッド(関数)をまとめました。

関数一覧の目次から調べたい項目をクリックしてダイレクトアクセスすると便利です。

Googleスプレッドシートを操作するための関数一覧

スプレッドシートの作成、編集、保存など、シート全体の操作が可能です。データの追加、削除、整形など効率的に行える便利なメソッドをまとめました。

SpreadsheetAppクラス

スプレッドシートの取得と設定

メソッド名	概要
getActiveSpreadsheet()	現在アクティブなスプレッドシートを返す。
setActiveSheet(sheet)	スプレッドシートにアクティブ シートを設定する。
openById(id)	指定された ID のスプレッドシートを開く。
openByUrl(url)	指定された URL でスプレッドシートを開く。
open(file)	指定したファイル オブジェクトに対応するスプレッドシートを開く。
create(name)	指定した名前で新しいスプレッドシートを作成する。
create(name, rows, columns)	指定された名前と、行数と列数を指定した新しいスプレッドシートを作成する。
flush()	保留中のスプレッドシートの変更をすべて適用する。
addMenu()	カスタムメニューをスプレッドシートに追加する。

【GAS】指定のスプレッドシートを開く方法(ID,URL,ファイルで特定)Google Apps Script(GAS)を使用してスプレッドシートを開くメソッドを紹介します。アクティブなスプレッドシートの取得から特定のIDやURL、ファイルを使用したスプレッドシートの開き方まで、効果的な方法を解説します。...

Spreadsheetクラス

スプレッドシート操作

メソッド名	概要
copy()	スプレッドシート名をコピーする
rename()	スプレッドシート名を変更する
setActiveSheet()	シートをアクティブにする
getUrl()	スプレッドシートのURLを取得する
getId()	スプレッドシートのIDを取得する
getName()	スプレッドシート名を取得する
getNumSheets()	スプレッドシートのシートの数を取得する

シート操作

メソッド名	概要
getActiveSheet()	アクティブなシートを取得する
getSheets()	スプレッドシートのすべてのシートを取得する
getSheetByName()	指定のシート名のシートを取得する
insertSheet([name,index])	指定のindexに新しいシートを挿入する
duplicateActiveSheet()	アクティブなシートを複製する
deleteSheet(sheet)	sheetを削除する
deleteActiveSheet()	アクティブなシートを削除する

GAS（Google Apps Script）でシートを取得・複製・削除する方法Google Apps Script（GAS）を使用してGoogle スプレッドシート内のシートを取得、複製、削除する方法を詳しく解説します。具体的なコードサンプルと注意すべきポイントも紹介します。...

Sheetクラス

セル値の取得と設定

メソッド名	概要
clearContents()	セルの内容をクリアする。
setValue()	セルに値を設定する。
getValue()	セルの値を取得する。
getValues()	セル範囲内の値を2次元配列として取得する。
setValues(values)	セル範囲に2次元配列の値を設定する。

【GAS】setValueの解説|スプレッドシートのセルに変数や配列の値を入れる方法Google Apps Script（GAS）でスプレッドシートのセルに値を入れる方法を紹介。setValueとsetValuesの違いについて図解と共に詳しく解説します。一つのセルに値を設定する方法から、配列を利用して複数のセルに一括で値を書き込む方法についても解説します。...

セルの範囲取得

メソッド名	概要
getRange()	指定された範囲を表す Range オブジェクトを取得する。
getActiveCell()	アクティブなセルを表す Range オブジェクトを取得する。
getActiveRange()	アクティブな範囲を表す Range オブジェクトを取得する。
getDataRange()	データが入力されている範囲を取得する。

【GAS】getRangeの解説|スプレッドシートのセル範囲の指定【図解付き】Google Apps ScriptのgetRange()メソッドは、列全体や複数範囲等、変数を駆使してデータを操作する関数です。この記事では、離れたセルからデータを取得する方法や最終行を効率的に扱う方法を始め、様々なデータ取得方法を詳しく解説します。...

行と列の操作

メソッド名	概要
appendRow()	新しい行を最終行に追加する。
deleteRows()	指定された行を削除する。
insertRows()	指定された行の前に新しい行を挿入する。
insertRowBefore()	特定の行の前に新しい行を挿入する。
insertRowsBefore()	特定の位置に複数行を挿入する。
insertRowAfter()	特定の行の後ろに新しい行を挿入する。
insertRowsAfter()	特定の位置の後ろに複数行を挿入する。
getLastRow()	データが入力されている最終行の行番号を取得する。
appendColumn()	新しい列を最終列に追加する。
deleteColumns()	指定された列を削除する。
insertColumns()	指定された列の前に新しい列を挿入する。
getLastColumn()	データが入力されている最終列の列番号を取得する。

【GAS】スプレッドシートで行を挿入する6つの関数を解説Google Apps Scriptを使用してスプレッドシート内で行を挿入する方法を解説。行の追加に必要な便利な関数を6つ厳選。insertRows()、insertRowBefore()、insertRowsBefore()、insertRowAfter()、insertRowsAfter()およびappendRow()を紹介しています。...

【GAS】スプレッドシートで列を追加|挿入方法の使い分けGoogle Apps Script(GAS)を使用してスプレッドシートのシートに列を挿入、追加する方法を解説していきます。主要な5つの関数(メソッド)の紹介により、列の挿入方法を使い分けられるようになります。...

【GAS】スプレッドシートの削除操作一覧（シート,セル,行,列,書式のクリア）Google Apps Script（GAS）を使用してスプレッドシート内の削除操作について解説します。シートの値や書式、特定の行や列、グラフなどを効率的に削除するための操作方法を具体的なスクリプトや手順とともに紹介します。clear, clearContent, clearFormat, deleteColumn, deleteRowなどの削除操作メソッドを解説しています。...

Rangeクラス

セルの書式設定

メソッド名	概要
setBackground(color)	セルの背景色を設定する。
setFontColor(color)	セルのフォント色を設定する。
setFontFamily(fontFamily)	セルのフォントファミリーを設定する。
setFontSize(size)	セルのフォントサイズを設定する。
setFontWeight(weight)	セルのフォントの太さを設定する。
setFontStyle(style)	セルのフォントスタイルを設定する。
setHorizontalAlignment(alignment)	セルの水平方向の配置を設定する。
setVerticalAlignment(alignment)	セルの垂直方向の配置を設定する。
setNumberFormat(format)	セルの数値の表示書式を設定する。

セルの結合と解除、空白判定

メソッド名	概要
merge()	セル範囲を結合する。
unmerge()	セル範囲の結合を解除する。
isBlank()	セルが空白かどうかを判定する。

【GAS】if文で「セルの値が空白なら」の判定を解説！isBlank()や変数の空文字の判定方法を紹介GASのisBlank()メソッドを駆使して、「セルの値が空白なら」を判定する方法を紹介します。セルが空白であるかどうかを簡潔に判定し、if文やisBlank()メソッド、変数の空文字での判定方法を駆使して処理の進め方を解説しています。...

DocumentApp：Googleドキュメントを操作するための関数一覧

ドキュメントの作成、テキストの編集、スタイルの設定、リストやテーブルの操作など、文書作成に必要な機能が備わっています。

ドキュメントの操作

メソッド名	概要
create(name)	指定された名前で新しいドキュメントを作成します。
openById(id)	指定されたIDのドキュメントを開きます。
openByUrl(url)	指定されたURLのドキュメントを開きます。
getActiveDocument()	現在アクティブなドキュメントを取得します。
getDocumentById(id)	指定されたIDのドキュメントを取得します。

テキストの操作

メソッド名	概要
getText()	ドキュメントの全テキストを取得します。
setText(text)	ドキュメントの全テキストを設定します。
getBody()	ドキュメントの本文を取得します。
getSelection()	ドキュメント内の選択範囲を取得します。
setSelection(element)	ドキュメント内の選択範囲を設定します。

スタイルの操作

メソッド名	概要
getFontFamily()	フォントファミリーを取得します。
setFontFamily(fontFamily)	フォントファミリーを設定します。
getFontSize()	フォントサイズを取得します。
setFontSize(size)	フォントサイズを設定します。
getForegroundColor()	テキストの前景色（文字色）を取得します。

リストの操作

メソッド名	概要
getLists()	ドキュメント内のリストのリストを取得します。
getListById(listId)	指定されたIDのリストを取得します。
createList()	新しいリストを作成します。
removeList(listItem)	指定されたリストを削除します。
clear()	ドキュメントの内容をクリアします。

テーブルの操作

メソッド名	概要
getTables()	ドキュメント内のテーブルのリストを取得します。
getTableById(tableId)	指定されたIDのテーブルを取得します。
createTable(rows, columns)	新しいテーブルを作成します。
removeTable(table)	指定されたテーブルを削除します。
replaceText(searchPattern, replacement)	テキストを検索して置換します。

画像の操作

メソッド名	概要
getImages()	ドキュメント内の画像のリストを取得します。
getImageById(imageId)	指定されたIDの画像を取得します。
createImage(blob)	新しい画像を作成します。
removeImage(image)	指定された画像を削除します。
replaceText(searchPattern, image)	テキストを検索して画像で置換します。

共有とアクセスの操作

メソッド名	概要
addEditor(emailAddress)	ドキュメントにエディターとしてユーザーを追加します。
removeEditor(emailAddress)	ドキュメントからエディターとしてのユーザーを削除します。
addViewer(emailAddress)	ドキュメントにビューアーとしてユーザーを追加します。
removeViewer(emailAddress)	ドキュメントからビューアーとしてのユーザーを削除します。
addCommenter(emailAddress)	ドキュメントにコメント投稿者としてユーザーを追加します。

その他の操作

メソッド名	概要
getId()	ドキュメントのIDを取得します。
getEditors()	ドキュメントのエディターのリストを取得します。
getSharingAccess()	ドキュメントの共有設定を取得します。
addBookmark(position)	ブックマークを追加します。
removeBookmark(bookmark)	指定されたブックマークを削除します。

FormApp：Google フォームを操作するための関数一覧

アンケートやフォームの作成、質問項目の追加、回答の取得など、フォーム作成と回答の管理を容易に行えます。

フォームの操作

メソッド名	概要
create(name)	指定された名前で新しいフォームを作成します。
openById(id)	指定されたIDのフォームを開きます。
openByUrl(url)	指定されたURLのフォームを開きます。
getActiveForm()	現在アクティブなフォームを取得します。
getForms()	ユーザーのフォームのリストを取得します。

質問項目の操作

メソッド名	概要
addTextItem()	テキスト質問項目をフォームに追加します。
addMultipleChoiceItem()	複数選択肢質問項目をフォームに追加します。
addCheckboxItem()	チェックボックス質問項目をフォームに追加します。
addListItem()	リスト質問項目をフォームに追加します。
addScaleItem()	スケール質問項目をフォームに追加します。

回答の操作

メソッド名	概要
getResponses()	フォームの回答のリストを取得します。
getResponse(responseId)	指定された回答IDの回答を取得します。
submitForm(responses)	フォームに回答を送信します。
deleteAllResponses()	フォームの全ての回答を削除します。
deleteResponse(responseId)	指定された回答IDの回答を削除します。

レスポンスの操作

メソッド名	概要
getRespondentEmail()	フォームの回答者のメールアドレスを取得します。
withItemResponse(response)	指定された回答を取得します。
getItemResponses()	フォームの回答のリストを取得します。
getTimestamp()	回答のタイムスタンプを取得します。
getGradableItemResponses()	評定可能な質問の回答のリストを取得します。

共有とアクセスの操作

メソッド名	概要
setAcceptingResponses(acceptingResponses)	フォームの回答を受け付けるかどうかを設定します。
setDestination(email)	フォームの回答の送信先を設定します。
setConfirmationMessage(message)	フォームの回答を送信した後の確認メッセージを設定します。
setCollectEmail(collect)	メールアドレスの収集を設定します。
setAllowResponseEdits(allowEdits)	フォームの回答の編集を許可するかどうかを設定します。

その他の操作

メソッド名	概要
getItems()	フォームの全ての質問項目のリストを取得します。
getItemById(id)	指定されたIDの質問項目を取得します。
deleteAllItems()	フォームの全ての質問項目を削除します。
deleteItem(item)	指定された質問項目を削除します。
moveItem(item, toIndex)	指定された質問項目を指定された位置に移動します。

CalendarApp：Google カレンダーを操作するための関数一覧

イベントの追加、削除、予定の取得など、カレンダーのスケジュール管理が可能です。日程調整やイベント作成に使うメソッドをまとめてます。

カレンダーの操作

メソッド名	概要
getCalendars()	ユーザーのカレンダーのリストを取得します。
getCalendarById(id)	指定されたIDのカレンダーを取得します。
createCalendar(name)	指定された名前で新しいカレンダーを作成します。
createAllDayEvent(title, date)	指定されたタイトルと日付で新しい終日イベントを作成します。
createEvent(title, startTime, endTime)	指定されたタイトルと開始時刻、終了時刻で新しいイベントを作成します。

イベントの操作

メソッド名	概要
getEvents(startTime, endTime)	指定された時間範囲内のイベントのリストを取得します。
getEventById(id)	指定されたIDのイベントを取得します。
createEventFromDescription(description)	指定された説明を使用して新しいイベントを作成します。
createEventFromTemplate(title, startTime, endTime, options)	指定されたテンプレートから新しいイベントを作成します。

予定の操作

メソッド名	概要
getAllDayEventsForDay(date)	指定された日付の終日イベントのリストを取得します。
getEventsForDay(date)	指定された日付のイベントのリストを取得します。
getEventsForWeek(date)	指定された日付を含む週のイベントのリストを取得します。

共有とアクセスの操作

メソッド名	概要
getOwnedCalendars()	ユーザーが所有するカレンダーのリストを取得します。
getOwnedCalendarById(id)	ユーザーが所有する指定されたIDのカレンダーを取得します。
shareCalendar(calendar, emailAddress, accessLevel)	指定されたカレンダーを指定されたメールアドレスとアクセスレベルで共有します。

その他の操作

メソッド名	概要
getDefaultCalendar()	ユーザーの既定のカレンダーを取得します。
getCalendarById(id)	指定されたIDのカレンダーを取得します。
getCalendarsByName(name)	指定された名前のカレンダーのリストを取得します。
createAllDayEvent(title, date)	指定されたタイトルと日付で新しい終日イベントを作成します。

DriveApp：Google ドライブを操作するための関数一覧

フォルダとファイルの作成、検索、ゴミ箱の操作など、ドライブ内のファイル管理やストレージの使用状況を管理できます。

フォルダとファイルの操作

メソッド名	概要
getFolders()	ユーザーのルートフォルダ内のフォルダのリストを取得します。
getFolderById(id)	指定されたIDのフォルダを取得します。
getFoldersByName(name)	指定された名前のフォルダのリストを取得します。
createFolder(name)	指定された名前で新しいフォルダを作成します。
getFiles()	ユーザーのルートフォルダ内のファイルのリストを取得します。
getFileById(id)	指定されたIDのファイルを取得します。
getFilesByName(name)	指定された名前のファイルのリストを取得します。
createFile(name, content)	指定された名前とコンテンツで新しいファイルを作成します。

ストレージの操作

メソッド名	概要
getStorageLimit()	ユーザーのストレージ容量上限を取得します。
getStorageUsed()	ユーザーが使用しているストレージ容量を取得します。

ゴミ箱の操作

メソッド名	概要
getTrashedFiles()	ゴミ箱内のファイルのリストを取得します。
getTrashedFolders()	ゴミ箱内のフォルダのリストを取得します。
getTrashedFilesByName(name)	ゴミ箱内の指定された名前のファイルのリストを取得します。
getTrashedFilesByType(mimeType)	ゴミ箱内の指定されたMIMEタイプのファイルのリストを取得します。
getTrashedFilesByDate(date)	ゴミ箱内の指定された日付に更新されたファイルのリストを取得します。

検索とフィルタリングの操作

メソッド名	概要
searchFiles(params)	指定された条件に基づいてファイルを検索します。
searchFolders(params)	指定された条件に基づいてフォルダを検索します。

共有とアクセスの操作

メソッド名	概要
addEditor(emailAddress)	指定したメールアドレスのユーザーを編集者としてファイルに追加します。
removeEditor(emailAddress)	指定したメールアドレスのユーザーを編集者から削除します。
addViewer(emailAddress)	指定したメールアドレスのユーザーを閲覧者としてファイルに追加します。
removeViewer(emailAddress)	指定したメールアドレスのユーザーを閲覧者から削除します。
addCommenter(emailAddress)	指定したメールアドレスのユーザーをコメント投稿者としてファイルに追加します。
removeCommenter(emailAddress)	指定したメールアドレスのユーザーをコメント投稿者から削除します。
addViewer(emailAddress)	指定したメールアドレスのユーザーを閲覧者としてファイルに追加します。
removeViewer(emailAddress)	指定したメールアドレスのユーザーを閲覧者から削除します。

その他の操作

メソッド名	概要
getRootFolder()	ユーザーのルートフォルダを取得します。
getFolderById(id)	指定されたIDのフォルダを取得します。
getFileById(id)	指定されたIDのファイルを取得します。
getFilesForPile(folder)	指定されたフォルダ内のファイルのリストを取得します。
getFoldersForPile(folder)	指定されたフォルダ内のサブフォルダのリストを取得します。

GmailApp：Gmailを操作するための関数一覧

メールの送信、受信、削除、ラベルの設定など、Gmailのメールボックスを直接制御できます。効率的なメール処理のメソッドをまとめてます。

メールの送信と受信

メソッド名	概要
sendEmail(recipient, subject, body)	指定した受信者にメールを送信します。
sendEmail(recipient, subject, body, options)	オプションを指定してメールを送信します。
getInboxThreads()	受信トレッドのリストを取得します。
getInboxThreads(start, max)	指定した範囲の受信トレッドを取得します。
getThreadById(id)	指定したIDに基づいてトレッドを取得します。
getInboxUnreadCount()	受信トレッドの未読数を取得します。

ラベルの操作

メソッド名	概要
getUserLabels()	ユーザーのすべてのラベルを取得します。
getLabelByName(name)	指定した名前のラベルを取得します。
createLabel(name)	指定した名前で新しいラベルを作成します。
getSystemLabel(systemLabel)	システムラベルを取得します。

添付ファイルの操作

メソッド名	概要
getAttachments(thread)	指定したトレッドのすべての添付ファイルを取得します。
getAttachmentBlob(attachment)	指定した添付ファイルのBlobを取得します。
createDraft(recipient, subject, body, options)	下書きを作成します。

下書きの操作

メソッド名	概要
getDrafts()	すべての下書きのリストを取得します。
createDraft(recipient, subject, body, options, attachments)	添付ファイルを指定して下書きを作成します。

スターと重要マークの操作

メソッド名	概要
markMessageImportant(message)	メッセージを重要としてマークします。
starMessage(message)	メッセージにスターを付けます。

共有とアクセスの操作

メソッド名	概要
getInboxThreads()	ユーザーのGmailの受信トレッドを取得します。
getInboxThreads(start, max)	ユーザーのGmailの受信トレッドを指定した範囲で取得します。
getInboxThreads(query)	指定した検索クエリに基づいてユーザーのGmailの受信トレッドを取得します。
getThreadById(id)	指定したIDに基づいてユーザーのGmailのトレッドを取得します。
getUnreadCount()	ユーザーのGmailの未読メール数を取得します。

その他の操作

メソッド名	概要
getAliases()	ユーザーのGmailのエイリアスを取得します。
getEmailAddress()	ユーザーのGmailのメールアドレスを取得します。
markMessageRead(message)	メッセージを既読としてマークします。
markMessageUnread(message)	メッセージを未読としてマークします。
unstarMessage(message)	メッセージのスターを解除します。

まとめ

Google Apps Script（GAS）で利用できる主要な関数一覧を紹介しました。これらのクラスとメソッドを組み合わせて、Googleのさまざまなサービスを自動化したり、カスタマイズしたりすることができます。

GASは、Google Workspaceの生産性を向上させるための強力なツールです。

自分の用途に合ったスクリプトを作成して、作業を効率化しましょう！