【GAS入門#24】画面にダイアログやメニューを出す準備!SpreadsheetApp.getUi()の使い方と基本概念

前回までは、GAS(Google Apps Script)の自動実行を支える「トリガー機能」について詳しく学んできました。決まった時間やイベントに合わせてプログラムを勝手に動かせるようになり、自動化の幅が一段と広がりましたよね。

今回からスタートする新しいフェーズでは、「スプレッドシートを使っているユーザーとプログラムが対話する仕組み」 を作っていきます!

たとえば、ボタンを押したときに「本当に削除しますか?」と警告の画面を出したり、文字を入力してもらうポップアップを出したり、スプレッドシートの画面上に自分だけのオリジナルメニューを追加したりする操作です。

そのすべての土台となり、画面操作の「司令塔」を呼び出す超重要命令が、今回解説する SpreadsheetApp.getUi()(スプレッドシート・アップ・ゲット・ユーアイ)です。

「画面に何かを表示する処理」を書くとき、GASでは必ずこの getUi() からスタートします。今回は、札幌オフィスの「北海道スープカレー巡りリスト」を題材にしながら、仕組みや使い方、そして初心者が必ず直面する注意点まで、どこよりも分かりやすく丁寧に解説します!

1. そもそも SpreadsheetApp.getUi() とは?

呪文のように長い名前ですが、意味を分解するととてもシンプルです。

コードの構造を分解してみよう

プログラミングの世界では、ドット(.)で繋いで「誰が(対象)」「何をする(命令)」を指定します。

SpreadsheetApp.getUi()

  • SpreadsheetApp(スプレッドシート・アップ)第2回でも登場した、Googleスプレッドシート全体を管理している親玉(クラス)です。
  • .getUi()(ゲット・ユーアイ)Ui は User Interface(ユーザー・インターフェース) の略です。直訳すると「ユーザーが操作する画面環境を取得してね!」という命令(メソッド)になります。

つまり、「今開いているスプレッドシートの画面操作の窓口(Uiオブジェクト)をGASのプログラムに連れてきて!」 と頼んでいるわけです。

「映画館の受付カウンター」でイメージしてみよう!

スプレッドシートの画面操作は、よく「映画館」に例えられます。

スプレッドシートの概念映画館での例えGASでの主な役割
スプレッドシート(画面全体)映画館の建物ユーザーが作業している場所
Uiオブジェクト(getUi()で取得)総合受付カウンターポップアップやメニューの案内を出す窓口
alert() / prompt() などアナウンス・チケット確認「上映開始です」「お名前を入力してください」といったやり取り

映画館で観客にアナウンスを出したり、チケットの受け答えをしたりしたいとき、まずは「総合受付カウンター(Ui)」を開設する必要がありますよね。

この「受付カウンターを用意する作業」こそが SpreadsheetApp.getUi() なのです。

この受付カウンター(Uiオブジェクト)を取得してはじめて、次のような操作が可能になります。

  1. メッセージボックスを表示する(Ui.alert())
  2. 文字入力フォームを表示する(Ui.prompt())
  3. 独自メニューを上部バーに追加する(Ui.createMenu())
  4. サイドバーやモーダル画面を表示する(Ui.showSidebar() / Ui.showModalDialog())

2. STEP1:準備!「北海道スープカレー巡りリスト」を作成しよう

それでは、実際に手元のスプレッドシートを使って準備をしていきましょう!

手順

  1. 新しいGoogleスプレッドシートを作成するGoogleドライブを開き、「新規」>「Googleスプレッドシート」をクリックします。
  2. ファイル名を変更する画面左上のファイル名を 「北海道スープカレー巡りリスト」 に変更します。
  3. シートにサンプルデータを入力する1行目に見出し、2行目以降に好きなお店のデータを入力してみましょう。
ABC
1店名エリアスパイスおすすめ度
2GARAKU札幌・中央区★★★★★
3奥芝商店札幌・駅前★★★★☆
4ラマイ札幌・豊平区★★★★★
  1. GASのエディタ画面を開く上部メニューの 「拡張機能」>「Apps Script」 をクリックします。

新しいタブでコードエディタが開いたら準備完了です!

3. STEP2:【実践】getUi() を使ってUIオブジェクトを取得してみよう!

まずは、getUi() を使ってUIオブジェクトを取得し、実際に画面にメニューやメッセージを出す簡単なプログラムを書いてみましょう。

1. コードを入力する

エディタ画面に元々書かれているコードをすべて消去し、以下のコードを貼り付けます。

function setupUserInterface() {
  // ① スプレッドシートの画面操作窓口(UIオブジェクト)を取得する
  var ui = SpreadsheetApp.getUi();
  
  // ② ログ画面に取得できたか出力してみる
  Logger.log("取得したUIオブジェクト: " + ui);
  
  // ③ 取得したUIオブジェクトを使って、上部メニューにオリジナル項目を追加してみる
  ui.createMenu("★スープカレー部")
    .addItem("おすすめ店舗をチェック", "showNotification")
    .addToUi();
}

// メニューから呼び出される関数の準備
function showNotification() {
  var ui = SpreadsheetApp.getUi();
  ui.alert("本日のおすすめは『GARAKU』の和風だしスープカレーです!");
}

2. コードを1行ずつ丁寧に解説!

  • var ui = SpreadsheetApp.getUi();本日の主役です!SpreadsheetApp から getUi() を呼び出し、変数 ui に画面操作の司令塔を格納しています。
  • ui.createMenu("★スープカレー部")取得した ui に対して .createMenu() を呼び出すことで、スプレッドシートの上部メニューバー(「ファイル」「編集」などの並び)に新しいメニューを作成しています。
  • .addItem("おすすめ店舗をチェック", "showNotification")メニューの中に表示するボタン名と、押したときに実行する関数名(showNotification)を指定しています。
  • .addToUi()作成したメニューを、実際の画面(UI)にガッチャンコと反映・追加する命令です。

3. 保存して実行してみよう!

  1. 画面上部の 「保存アイコン(フロッピーディスク)」 を押します。
  2. 実行する関数が setupUserInterface になっていることを確認し、「実行」 ボタンをクリックします。
  3. 初回実行時はGoogleのセキュリティチェック(承認画面)が出るので、画面の指示に従って「許可」を行ってください。第2回記事で解説した手順と同じです。

実行完了後、スプレッドシートのタブ画面に戻ってみましょう!

スプレッドシートのメニューバーの右端に、「★スープカレー部」 という新しいメニューが追加されているはずです!

そのメニューをクリックし、「おすすめ店舗をチェック」 を選ぶと、画面中央に「本日のおすすめは…」というポップアップメッセージが表示されます!

4. 初心者が絶対につまずく!5大トラップと完全対処法

SpreadsheetApp.getUi() は非常に便利な命令ですが、GASを学び始めた方が必ず一度は引っかかる有名な落とし穴が存在します。エラーで焦らないよう、ここでしっかり対策を押さえておきましょう!

トラップ1:Cannot call SpreadsheetApp.getUi() from this context と叱られる

これが GAS学習者の中で圧倒的No.1のエラー です!

【原因】

getUi() は 「今まさに画面を開いて操作している人間がいること」 を前提とした命令です。

そのため、以下のような「人が画面を開いていない状態」でプログラムが動いた場合、画面が存在しないため getUi() が失敗してこのエラーが発生します。

  • 時間主導型トリガー(タイムトリガー)(例:毎朝8時に自動実行)
  • フォーム送信時トリガー(画面を開かずにバックグラウンド実行される場合)
  • Web App(doGet / doPost)としての実行

【解決策】

タイマー設定で定期実行させる自動化コードの中では、getUi() や ui.alert() などの画面表示処理を使わないように設計しましょう!

バックグラウンド処理の通知には、画面ポップアップではなく Gmail送信(第31回予定) や Slack / LINE通知(第75回〜第76回予定) を活用するのが鉄則です。

トラップ2:スタンドアロンスクリプトで実行してエラーになる

【原因】

第2回や第3回でも触れましたが、GASには2つのタイプがあります。

  1. コンテナバインドスクリプト(スプレッドシートの「拡張機能」から作成)
  2. スタンドアロンスクリプト(Googleドライブの「新規」から直接作成した単体ファイル)

SpreadsheetApp.getUi() は、「親となるスプレッドシートの画面」が存在するコンテナバインドスクリプトでしか動か meせん。スタンドアロンスクリプトで実行すると、紐づく画面がないためエラー(または null)になります。

【解決策】

画面操作やカスタムメニューを作りたい場合は、必ず 操作したいスプレッドシートの「拡張機能」>「Apps Script」からエディタを開く 習慣をつけましょう!

トラップ3:getUi() 単体で動かしても画面には何も起きない

「getUi() を実行したのに、画面に何も出ない…」と悩む初心者の方がよくいます。

【原因】

getUi() はあくまで 「受付カウンターを開設した(オブジェクトを準備した)」段階 にすぎません。

受付を開いただけで、まだ「アナウンス(alert)」も「質問(prompt)」も出していない状態なので、見た目上は何も変化が起きないのが正常です。

【解決策】

var ui = SpreadsheetApp.getUi(); で準備した後に、必ず ui.alert(...) や ui.createMenu(...) などの具体的に画面を動かす命令をセットで呼び出しましょう!

トラップ4:大文字・小文字のタイポ(getUI や getui)

JavaScript(GAS)は大文字と小文字を厳密に区別します。

  • ✕ SpreadsheetApp.getUI() (Iが大文字)
  • ✕ SpreadsheetApp.getui() (uiが小文字)
  • ◯ SpreadsheetApp.getUi() (Uが大文字、iが小文字)

【解決策】

手入力せずに、SpreadsheetApp.get... まで打ったときに画面に表示される 予測変換(補完機能) を Enter キーで決定して入力するのが最も確実です。

トラップ5:Spreadsheet オブジェクトと Ui オブジェクトを混同してしまう

// ✕ 間違いな書き方
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.alert("こんにちは"); // エラーになります!

// ◯ 正しい書き方
var ui = SpreadsheetApp.getUi();
ui.alert("こんにちは");

alert() や prompt() は、スプレッドシート(ss)が持っている命令ではなく、Ui オブジェクト(ui)が持っている命令 です。

「セルやシートの操作は Spreadsheet / Sheet」「画面ポップアップやメニューの操作は Ui」と役割をハッキリ分けることが、エラーを防ぐ最大のコツです!

5. ちょっと応用!第21回 onOpen(e) と組み合わせて起動時に自動メニュー追加

第21回で学んだ シンプルトリガー onOpen(e) を覚えているでしょうか?

ファイルを開いた瞬間に自動実行される特別な関数です。

この onOpen(e) の中で SpreadsheetApp.getUi() を使うと、「スプレッドシートを開くだけで、自分専用のオリジナルメニューが勝手に画面上部に追加される」 という実践的な仕組みが作れます!

実践コード

// スプレッドシートを開いたときに自動実行される関数
function onOpen(e) {
  var ui = SpreadsheetApp.getUi();
  
  // オリジナルメニューの作成
  ui.createMenu("寿司・スープカレーナビ")
    .addItem("今日のおすすめ店を表示", "showRecommendation")
    .addSeparator() // 区切り線を入れる
    .addItem("シートの入力データをクリア", "clearSheetData")
    .addToUi();
}

function showRecommendation() {
  var ui = SpreadsheetApp.getUi();
  ui.alert("本日の札幌オフィスおすすめランチ:『スパイス研乃』のチキンカレー!");
}

function clearSheetData() {
  var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
  // 第8回で学んだ clearContent() で中身だけクリア!
  sheet.getRange("A2:C10").clearContent();
  
  var ui = SpreadsheetApp.getUi();
  ui.alert("指定範囲のデータをクリアしました!");
}

このコードを保存しておくと、次回からスプレッドシートを開くだけで自動的に「寿司・スープカレーナビ」というメニューが追加されます。

社内ツールやチーム共有シートを作るときに設定しておくと、「誰でも1クリックでGASの機能を呼び出せる」ようになり、非エンジニアの同僚からも大絶賛されますよ!

6. 今回のまとめと次回予告

今回は、GASで画面操作やUI拡張を行うための第一歩となる SpreadsheetApp.getUi() について詳しく解説しました。

今日の重要ポイント

  1. SpreadsheetApp.getUi() は画面操作の司令塔(Uiオブジェクト)を取得する命令
  2. ダイアログ(alert)、入力フォーム(prompt)、カスタムメニュー作成の起点となる
  3. 時間トリガーなどのバックグラウンド実行(画面がない環境)ではエラーになるので注意する
  4. 必ずコンテナバインドスクリプト(スプレッドシートから作成)で利用する
  5. onOpen(e) と組み合わせることで、開いた瞬間に自動でカスタムメニューを設置できる

次回予告

画面操作の「司令塔」を呼び出せるようになったので、次回はいよいよ画面上にメッセージをポコンと表示させる本格的なUI操作に入ります!