【GAS入門#26】ユーザーに文字入力を促す!Ui.prompt()の使い方と入力値の取得・条件分岐まで徹底解説

「プログラムを実行したときに、ユーザーに好きな文字や数字を入力してもらいたい!」と思うことはありませんか?

例えば、毎回プログラムのコードを開いて文字を書き換えるのではなく、ボタンを押したときに小さなポップアップ画面(ダイアログ)が出てきて、「今日追加するお店の名前を入力してください」と問いかけてくれたら、プログラミングの知識がない同僚でも簡単に使えて便利ですよね。

前回(第25回)は画面にお知らせメッセージを表示する Ui.alert() を学びましたが、今回学習するのは、ユーザーからテキスト入力を受け取ることができる超便利メソッド「Ui.prompt()」 です!

休日のお楽しみである「札幌スープカレー巡りリスト」に、ポップアップ画面から新しいお店をサッと登録する実践コードを作りながら、基本の書き方から入力された文字の取り出し方、キャンセルボタンが押されたときの条件分岐、初心者がハマりやすい落とし穴まで、どこよりも分かりやすく解説していきますね!

1. そもそも Ui.prompt() とは?入力ダイアログの基本

Ui.prompt()(ユーアイ・プロンプト)は、Googleスプレッドシートの画面上に「入力欄付きのポップアップ画面(入力ダイアログ)」を表示し、ユーザーがキーボードで打ち込んだ文字を取得する命令です。

「Ui.alert()」と「Ui.prompt()」の違い

前回学んだ Ui.alert() と今回の Ui.prompt() は、どちらも画面に飛び出るポップアップ画面を作りますが、役割が明確に違います。

項目Ui.alert()(アラート)Ui.prompt()(プロンプト)
主な役割ユーザーに「お知らせ」や「確認」を伝えるユーザーに「文字や数字の入力」を促す
画面の要素メッセージ + ボタン(OK/Cancelなど)メッセージ + 入力ボックス + ボタン
受け取るもの押されたボタンの種類押されたボタン + 入力されたテキスト
例え回覧板(読んでハンコを押すだけ)注文用紙(名前や希望を書き込む)

「受取用の小包(PromptResponse)」でイメージしよう!

Ui.prompt() を実行すると、ユーザーが画面で「文字を入力してOKボタンを押す」というアクションを起こします。

このとき、GASは入力されたテキストと押されたボタンの情報を「PromptResponse(プロンプト・レスポンス)」という1つの小包(オブジェクト)にまとめてプログラムに返してくれます。

私たちは、届いた小包から「どのボタンが押されたかな?」「どんな文字が書かれているかな?」と中身を取り出して使っていくわけです。

2. STEP1:準備!「札幌スープカレー巡りリスト」シートを用意しよう

まずは、GASから操作するための練習用スプレッドシートを作成しましょう!

手順

  1. ブラウザで新しいGoogleスプレッドシートを作成し、ファイル名を 「札幌スープカレー巡りリスト」 にします。
  2. 画面下のシートタブ名を 「中央区エリア」 に変更します。
  3. 1行目に、以下のように見出し(ヘッダー)を入力しておきます。
ABC
1登録日時店舗名メモ
22026/09/20GARAKU和風ダシが効いてて美味しい!
  1. 入力が完了したら、「中央区エリア」のシートを開いた状態(アクティブ)にしておきます。

3. STEP2:【実践】一番シンプルな Ui.prompt() を動かしてみよう!

準備ができたら、さっそくGASのエディタを開いて、最もシンプルな入力ダイアログを表示させてみましょう!

1. コードを入力する

スプレッドシートのメニューバーから 「拡張機能」 > 「Apps Script」 を開き、エディタ画面のコードをすべて消去して、以下のコードを貼り付けます。

function showSimplePrompt() {
  // ① スプレッドシートのUI(画面操作機能)を取得する
  var ui = SpreadsheetApp.getUi();
  
  // ② 入力ダイアログを表示し、結果を「response」という変数(小包)で受け取る
  var response = ui.prompt("おすすめのスープカレー店を入力してください");
  
  // ③ 入力されたテキストを取り出す
  var inputText = response.getResponseText();
  
  // ④ 取り出したテキストをログに表示してみる(第1回で学んだ Logger.log)
  Logger.log("入力された店舗名:" + inputText);
}

2. コードのポイントを解説!

  • SpreadsheetApp.getUi()第25回でお伝えした通り、スプレッドシートの画面上にポップアップを表示させるには、まず画面操作の親玉である Ui オブジェクトを取得する必要があります。
  • ui.prompt("メッセージ")指定したメッセージ付きの入力ダイアログを画面に呼び出します。
  • response.getResponseText()ユーザーが入力欄に打ち込んだ文字を、文字列として取り出す専用の命令です。

3. 保存して実行する

  1. エディタ上部の 「保存(フロッピーディスクのアイコン)」 をクリックします。
  2. 実行する関数が showSimplePrompt になっていることを確認し、「実行」 ボタンをクリックします。
  3. スプレッドシートの画面タブに移動してみてください。

画面の中央に、テキスト入力欄のついたダイアログが表示されていますね!

入力ボックスに「ラマイ」と打ち込んで、右下の「OK」ボタンを押してみましょう。

GASのエディタに戻って実行ログを確認すると、以下のように出力されているはずです。

情報    入力された店舗名:ラマイ

ユーザーが画面で入力した文字を、プログラムが見事にキャッチしてくれました!

4. STEP3:超重要!ボタン判定と入力テキストの取り出し方

先ほどのコードは一番シンプルな形でしたが、実務で使う際には致命的な問題があります。

もしユーザーが何も入力せずに「キャンセル」ボタンを押したり、ダイアログの右上にある「×」ボタンで閉じたりした時にも、そのまま処理が進んでしまうのです。

実務で安全に使いこなすために、「押されたボタンの判定」 と 「入力テキストの取り出し」 を組み合わせた完全な構文をマスターしましょう!

Ui.prompt() の書き方(タイトル・説明文・ボタン指定)

Ui.prompt() には、表示させる要素に合わせて3つの書き方(構文)があります。

// パターン①:本文メッセージのみ(OK / キャンセルボタンが自動でつく)
ui.prompt("店舗名を入力してください");

// パターン②:タイトル + 本文メッセージ
ui.prompt("新規登録", "店舗名を入力してください", ui.ButtonSet.OK_CANCEL);

// パターン③:ボタンの種類をカスタマイズ(YES_NO など)
ui.prompt("確認", "本当に削除してよろしいですか?理由を入力:", ui.ButtonSet.YES_NO);

実務で一番よく使うのは、タイトルと本文、ボタンセットを明確に指定するパターン②です。

小包(PromptResponse)からデータを取り出す2つの必須メソッド

Ui.prompt() の戻り値である response 変数からは、次の2つの命令を使ってデータを取り出します。

  1. response.getSelectedButton()ユーザーがどのボタンを押したか(ui.Button.OK や ui.Button.CANCEL など)を取得します。
  2. response.getResponseText()入力欄に書かれたテキストを文字列として取得します。

ボタン判定を取り入れた実践コード

ボタンが押された条件によって処理を振り分ける(条件分岐)コードを書いてみましょう。

function showPromptWithCondition() {
  var ui = SpreadsheetApp.getUi();
  
  // ダイアログを表示(タイトル、説明文、ボタンの種類を指定)
  var response = ui.prompt(
    "スープカレー店の登録",
    "札幌市内でおすすめの店舗名を入力してください:",
    ui.ButtonSet.OK_CANCEL
  );
  
  // 押されたボタンを取得
  var button = response.getSelectedButton();
  // 入力された文字を取得
  var text = response.getResponseText();
  
  // 「OK」ボタンが押された場合の処理
  if (button == ui.Button.OK) {
    ui.alert("「" + text + "」が入力されました!登録を進めます。");
  } 
  // 「キャンセル」ボタンが押された場合の処理
  else if (button == ui.Button.CANCEL) {
    ui.alert("登録がキャンセルされました。");
  } 
  // 右上の「×」ボタンで閉じられた場合の処理
  else {
    ui.alert("画面が閉じられました。");
  }
}

このように if 文を使ってボタンに応じた分岐を作っておけば、キャンセルされた時に無駄な処理が実行されるのを防ぐことができます!

5. STEP4:実務で役立つ応用!入力値をスプレッドシートへ自動追記しよう

それでは、これまで学んだ知識を総動員して、実務や日常でそのまま使える実践的なツールを作成してみましょう!

今回は、「ポップアップで入力された店舗名を、スプレッドシートの最終行へ自動で追記する(第7回 appendRow)」 という連携処理を作成します。

さらに、「文字が空欄のままOKを押された場合のエラーチェック」も組み込んだ親切設計にしてみましょう!

実践コード:新店舗の自動登録ツール

function registerNewStore() {
  var ui = SpreadsheetApp.getUi();
  
  // 1. 入力ダイアログを表示する
  var response = ui.prompt(
    "【札幌スープカレー巡り】新店舗追加",
    "追加したいスープカレーの店名を入力してください:",
    ui.ButtonSet.OK_CANCEL
  );
  
  // 2. 押されたボタンと入力値を取得する
  var button = response.getSelectedButton();
  var storeName = response.getResponseText();
  
  // 3. OKボタンが押された場合のみ処理を行う
  if (button == ui.Button.OK) {
    
    // 【チェック】入力欄が空文字(未入力)でないか確認
    if (storeName === "") {
      ui.alert("⚠️ 店舗名が入力されていません。文字を入力して再度お試しください。");
      return; // 処理をここで中断する
    }
    
    // 4. 開いているシートを取得(第2回・第3回の復習)
    var ss = SpreadsheetApp.getActiveSpreadsheet();
    var sheet = ss.getActiveSheet();
    
    // 5. 本日の日付と店舗名を配列にして末尾に追記(第7回 appendRowの復習)
    var today = new Date();
    sheet.appendRow([today, storeName, "Ui.prompt()から追加"]);
    
    // 6. 完了メッセージを表示(第25回 Ui.alertの復習)
    ui.alert("🎉 登録完了", "「" + storeName + "」をリストに追加しました!", ui.ButtonSet.OK);
    
  } else {
    // キャンセルや×ボタンが押された場合
    ui.alert("処理を中断しました。");
  }
}

コードの解説と動かし方

  1. storeName === "" で「文字が何も入力されていない状態」を検知し、警告メッセージを出して return; で処理をストップさせています。
  2. OKボタンが押され、文字が正しく入力されている場合のみ、sheet.appendRow() が実行されてシートの最下行に「現在日時」「店舗名」「メモ」が美しく追加されます。

スプレッドシート上に「図形ボタン(第8回参照)」を作成し、この registerNewStore 関数を割り当てておけば、シートを開いてボタンを押すだけで、誰でも簡単にお店を追加できるようになります!

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

Ui.prompt() を使う際、ビギナーの方がよく遭遇するエラーや思い通りに動かないトラップを5つ厳選しました。ここで予習してトラブルを未然に回避しましょう!

トラップ1:SpreadsheetApp.getUi() を呼び忘れてエラーになる

// ✕ エラーになる書き方(uiが定義されていない)
var response = Ui.prompt("入力してください");

// ◯ 正しい書き方
var ui = SpreadsheetApp.getUi();
var response = ui.prompt("入力してください");

Ui は自動で用意されている変数ではありません。必ず最初に SpreadsheetApp.getUi() で呼び出して変数に入れてから使いましょう。

トラップ2:getResponseText() を忘れ、小包(Object)をそのまま表示してしまう

// ✕ 間違った書き方
var storeName = response; // 小包そのものが入っている
ui.alert("入力値:" + storeName); // 「入力値:PromptResponse」と表示されてしまう!

// ◯ 正しい書き方
var storeName = response.getResponseText(); // 中身のテキストを取り出す!

prompt() が返すのは「PromptResponse」という小包(オブジェクト)です。中の文字列を取り出すには、必ず末尾に .getResponseText() をつけましょう。

トラップ3:数値として使いたいのに「文字列」として取得される

ユーザーが入力ボックスに「500」と数字を入力しても、getResponseText() で取得されるのはテキストの “500”(文字列) です。

そのまま足し算をしようとすると、"500" + 100 = "500100" となってしまいます。

数値として計算に使いたい場合は、以下のように Number() や parseInt() を使って数値に変換しましょう!

var inputText = response.getResponseText();
var price = Number(inputText); // 文字列を数値データに変換!

トラップ4:キャンセルを押された時の処理を書いておらず空データが追加される

ボタンの判定(getSelectedButton() == ui.Button.OK)を行わずに appendRow() などを実行してしまうと、ユーザーが「あ、やっぱりやめた」とキャンセルを押したにもかかわらず、空欄のデータがシートに追加されてしまいます。

必ず if (button == ui.Button.OK) の中でメインの処理を行うように癖をつけましょう!

トラップ5:GASエディタから直接実行して「Uiが見つかりません」となる

GASのエディタ画面で「実行」を押した際、スプレッドシートの画面側にダイアログが表示されるため、エディタ画面だけを見ていると「何も起きない?」と錯覚することがあります。

また、時間主導型トリガー(毎朝〇時に自動実行など)で Ui.prompt() を動かそうとすると、画面を開いている人間がいないためエラーになります。UI系の命令は、あくまで「人間がスプレッドシートを開いて操作している時」 専用の命令だと覚えておきましょう。

7. 今回のまとめ&次回予告

今回は、ユーザーからテキストの入力を受け取る Ui.prompt() について解説しました。

今日の重要ポイントおさらい

  1. Ui.prompt() は入力ボックス付きのポップアップ画面を表示する命令
  2. 結果は PromptResponse オブジェクト(小包)として返ってくる
  3. response.getSelectedButton() で押されたボタン(OK/Cancel)を判定する
  4. response.getResponseText() で入力されたテキストを取り出す
  5. 未入力チェック(storeName === "")や数値変換(Number())を行うとより安全!

これで、プログラムの一方通行な処理ではなく、ユーザーと対話しながらデータをインプットするインタラクティブなシステムが作れるようになりましたね!

さて、Ui.alert() や Ui.prompt() は手軽で非常に便利ですが、「もっと広い入力画面を作りたい」「複数の入力項目(店名・スパイス度・価格など)を一度に入力させたい!」 と思うことも出てきますよね。

次回(第27回)は、HTMLを使って自由自在なデザインのオリジナル画面を作成できる Ui.showModalDialog() を解説します!

本格的なWebアプリのようなカスタム入力画面が作れるようになりますので、ぜひお楽しみに!