【GAS入門#21】ファイルを開いたら自動実行!onOpen(e)の使い方とカスタムメニュー作成

いよいよ今回から「フェーズ3:自動化・UI拡張・エラー処理」という、GASの真骨頂とも言える応用ゾーンに突入します!

これまでの第1〜20回では、GASのエディタ画面を開いて「実行」ボタンを押すことでプログラムを動かしていました。しかし、実際の業務で「毎回GASのエディタを開いて実行ボタンを押す」のは少し面倒ですよね。

今回学ぶ onOpen(e)(オン・オープン) を使うと、「スプレッドシートを開いた瞬間」にプログラムを自動的に実行させることができます。

スプレッドシートの上部メニューバーに「自分専用のボタン(カスタムメニュー)」を出現させたり、開いた瞬間にメッセージを出したりと、いつものスプレッドシートを「本格的な社内業務ツール」へと劇的に変身させることができます!

プログラミングが初めての方でも1ステップずつ理解できるように、専門用語の解説からコードの1行ずつの意味まで、世界一わかりやすく解説していきます。

1. そもそも onOpen(e) とは?基本概念を超わかりやすく解説

まずは「名前の意味」と「仕組み」から順番に解き明かしていきましょう。

①「トリガー」ってなに?

GASの世界には「トリガー(Trigger)」という言葉がよく登場します。トリガーとは英語で「引き金」という意味です。

「このボタンが押されたら」「毎朝9時になったら」「ファイルが開かれたら」というように、プログラムが動き出す「きっかけ・引き金」のことをトリガーと呼びます。

② onOpen は「特別なシンプルトリガー」

通常、プログラムを特定の日時に自動実行させるには、複雑なスケジュール設定(タイマー設定など)が必要です。

しかし、GASにはあらかじめ「名前を書いておくだけで、特定のイベントを検知して自動実行してくれる仕組み」が用意されています。これを「シンプルトリガー」と言います。

  • onOpen = 「Open(開いた)ときに(on)」自動で動く魔法の関数名

関数名を function onOpen() にしておくだけで、Googleのシステムが「あ、このファイルが開かれたな!」と自動で察知し、中身のコードを実行してくれるのです。

③ カッコの中の (e) ってなに?

コードを書くとき、function onOpen(e) のようにカッコの中に e と書きます。この e の正体は イベントオブジェクト(Event Object) です。

ちょっと難しそうに見えますが、「ファイルが開かれた時の状況データが入った『配達の段ボール箱』」だと思ってください。

ファイルが開かれた瞬間、Googleのシステムが以下のような情報をその段ボール箱(e)に詰めてプログラムに届けてくれます。

  • 誰がファイルを開いたか(ユーザー情報)
  • どんな権限(閲覧のみ・編集可能など)で開いたか
  • どの種類のUI(画面)で開いたか

最初のうちは「この e はお約束として書いておく決まり文句」と覚えておけばOKですが、「開かれた時の裏情報が入っている箱なんだな」とイメージしておくと、将来高度なプログラムを書くときに役立ちます。

2. 【ハンズオン】札幌オフィスの「日常業務ポータル」を作ってみよう!

理論がわかったところで、実際に手を動かして作ってみましょう!

今回は、札幌オフィスのスタッフが日常的に使う「札幌オフィス日常業務ポータル」を作成し、スプレッドシートが開かれた瞬間にオリジナルメニュー(北海道風の便利メニュー)が追加されるプログラムを作ります。

STEP 1:スプレッドシートの準備

  1. ブラウザで Google スプレッドシート を新規作成します。
  2. 左上の「無題のスプレッドシート」をクリックし、ファイル名を 「札幌オフィス日常業務ポータル」 に変更します。
  3. 画面上部メニューの 「拡張機能」 > 「Apps Script」 をクリックします。

STEP 2:コードを入力する

GASのエディタ画面が開いたら、もともと入っている function myFunction() { ... } をすべて消去し、以下のコードをそのままコピー&ペーストしてください。

/**
 * スプレッドシートが開かれたときに自動で実行される関数
 * (シンプルトリガー:onOpen)
 */
function onOpen(e) {
  // ① スプレッドシートの操作画面(UI)を取得する
  var ui = SpreadsheetApp.getUi();
  
  // ② 上部メニューバーにオリジナルのカスタムメニューを作成して追加する
  ui.createMenu('札幌オフィス業務メニュー')
    .addItem('本日の業務ログを記録', 'recordDailyLog')
    .addSeparator() // メニューの中に「区切り線」を引く
    .addItem('困ったときのヘルプ・マニュアル', 'showHelp')
    .addToUi();
}

/**
 * メニュー「本日の業務ログを記録」をクリックしたときに動く関数
 */
function recordDailyLog() {
  // 現在開いているシートを取得
  var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
  
  // シートの最下行に [日時, オフィス名, 業務内容, 状態] を自動追記
  sheet.appendRow([new Date(), "札幌オフィス", "日次定期チェック業務", "完了"]);
  
  // 画面に完了メッセージを表示
  SpreadsheetApp.getUi().alert("【札幌オフィス】本日の業務ログをシートに追記しました!");
}

/**
 * メニュー「困ったときのヘルプ・マニュアル」をクリックしたときに動く関数
 */
function showHelp() {
  // 画面にヘルプ案内ダイアログを表示
  SpreadsheetApp.getUi().alert("【札幌オフィス ポータルヘルプ】\n\nこのツールは札幌オフィスの日常業務を記録するための専用ポータルです。\n問い合わせ先:札幌総務チーム");
}

入力できたら、エディタ上部の 「保存アイコン(フロッピーディスクのマーク)」 またはキーボードの Ctrl + S(Macは Cmd + S)を押してコードを保存します。

STEP 3:動作を確認する(リロードしてみよう!)

ここで超重要なお知らせがあります!

onOpen は、GASエディタ画面の「実行」ボタンを押してテストしてはいけません!(※理由は後述のトラブルシューティングで解説します)

正しいテスト手順は以下の通りです。

  1. スプレッドシートを開いているブラウザのタブに戻ります。
  2. ブラウザの「再読み込み(リロード)」ボタンを押すか、キーボードの F5 キー(Macは Cmd + R) を押します。
  3. ページが読み込まれて数秒待つと……画面上部のメニューバー(「ヘルプ」の右隣など)に、「札幌オフィス業務メニュー」 という新しい項目がポロッと出現します!

STEP 4:カスタムメニューを使ってみる!

  1. 追加された 「札幌オフィス業務メニュー」 をクリックします。
  2. 「本日の業務ログを記録」 をクリックしてみましょう。
  3. 初めて実行するときは「承認が必要です」という画面が出る場合があるので、画面の指示に従って許可(「詳細」>「安全ではないページに移動」>「許可」)を出します。
  4. 許可を出すとポップアップメッセージが表示され、スプレッドシートの1行目に本日の日付や「札幌オフィス」などのログが自動入力されます!

3. コードの仕組みを1行ずつ徹底解剖!

プログラミング初心者の方が丸暗記にならず応用できるように、先ほどのコードで使った重要な命令を1行ずつ解体して解説します。

var ui = SpreadsheetApp.getUi();
  • SpreadsheetApp:GASの中で「スプレッドシート全体」を扱うための巨大な司令塔(オブジェクト)です。
  • getUi():UIとは「User Interface(ユーザー・インターフェース)」の略で、ボタンやポップアップ、メニューバーなど「人間が画面で操作する部分」のことです。getUi() を実行することで、「画面を操作する準備」を整えています。
ui.createMenu('札幌オフィス業務メニュー')
  .addItem('本日の業務ログを記録', 'recordDailyLog')
  .addSeparator()
  .addItem('困ったときのヘルプ・マニュアル', 'showHelp')
  .addToUi();

ここは「メソッドチェーン」と呼ばれる書き方をしています。ドット(.)で命令を数珠つなぎにして、メニューの形を組み上げています。

  • createMenu('メニュー名'):メニューバーに表示する「一番親となるメニューのタイトル」を作ります。
  • addItem('画面に見せる文字', '実行する関数名'):メニューの中に並ぶボタンを作ります。
    • 第1引数(左側):ユーザーがメニューを開いた時に見える日本語のテキスト
    • 第2引数(右側):クリックされた時に呼び出すGASの関数名(シングルクォーテーションで囲む)
  • addSeparator():メニューの中に「仕切り線(横線)」を引いて見やすく整理します。
  • addToUi():組み立てたメニューを、実際の画面メニューバーに「ガッチャンコ!」と取り付ける命令です。これを最後に書かないと画面に表示されないので注意してください!

4. 知っておくべき!onOpen(e) の制限事項(セキュリティの壁)

「開いた瞬間に自動で動くなら、メールも自動送信できるのでは?」と思うかもしれません。しかし、onOpen(e) にはセキュリティ上の理由から厳格な制限が設けられています。

なぜ制限があるの?

もし悪意のある人が「ファイルを開いた瞬間に、あなたのGoogleドライブのファイルを全削除してメールで外部に送信するスクリプト」を仕組んでいたとしたら、ファイルを開くだけで被害に遭ってしまいますよね。

そのような被害を防ぐため、ユーザーが「実行ボタン」を押していない自動実行(シンプルトリガー)の段階では、危険な操作が禁止されているのです。

onOpen で「できること」と「できないこと」

区分操作内容実行できるか?
できることメニューの追加(createMenu)◯
できることメッセージやダイアログの表示(alert)◯
できること画面のセルを取得・編集する◯
できないことメールを自動送信する(GmailApp)✕ (エラー)
できないこと外部のWebサイトやAPIと通信する(UrlFetchApp)✕ (エラー)
できないこと他のGoogleドライブ上のファイルを開く/書き換える✕ (エラー)

※メール送信などの重い処理や権限が必要な処理を行いたい場合は、「メニューをクリックした先の関数」に処理を書くか、今後の回で学ぶ「インストール可能トリガー」という別の仕組みを使います。

5. 初心者が必ずハマる!「3大トラップ」と解決策

onOpen(e) を使っていて「あれ?動かないぞ?」となったときは、ほぼ100%以下のいずれかが原因です。ハマった時のチェックリストとしてお使いください。

❌ トラップ1:GASエディタの「実行」ボタンを押してしまう

初心者の方が一番やってしまいがちなミスです。

GASエディタで onOpen を選んで「実行」ボタンを押すと、Googleのシステムから (e)(開いた状況のデータ箱)が渡されないため、画面にエラーが出たり、メニューが正しく追加されなかったりします。

【解決策】

onOpen の動作確認は、エディタの実行ボタンではなく、必ずスプレッドシート本体のタブに戻って「画面のリロード(F5)」で行ってください!

❌ トラップ2:関数名のスペルミス(大文字・小文字)

JavaScript / GAS は、大文字と小文字を厳格に区別します。

  • ✕ onopen(Oが小文字になっている)
  • ✕ OnOpen(先頭の O が大文字になっている)
  • ✕ on_open(アンダースコアが入っている)
  • ◯ onOpen(Open の O だけが大文字)

1文字でも大文字・小文字を間違えると、Googleのシステムが「あ、これは自動実行用の onOpen ではないな」と判断してスルーしてしまいます。

❌ トラップ3:addItem にカッコ () を書いてしまう

メニュー追加のコードで、呼び出したい関数名にカッコを付けてしまうミスです。

// ✕【間違い】カッコ () を付けてしまう
.addItem('本日の業務ログを記録', 'recordDailyLog()')

// ◯【正しい】カッコはつけず、関数名だけを文字列で書く
.addItem('本日の業務ログを記録', 'recordDailyLog')

addItem の第2引数は、「関数の名前」をテキスト(文字列)として渡すルールになっています。カッコをつけると正しく認識されないので注意しましょう。

6. まとめ&次回予告

今回は、GASの自動実行の第一歩である onOpen(e) と、それを使ったカスタムメニューの作成方法を解説しました。

今回の重要ポイント

  1. onOpen(e) はファイルが開いたときに自動実行される「シンプルトリガー」
  2. SpreadsheetApp.getUi().createMenu() でオリジナルメニューを作れる
  3. セキュリティ制限のため、onOpen の中でメール送信などは直接できない
  4. 動作テストはエディタの実行ボタンではなく「ブラウザのリロード」で行う

自分だけのメニューがスプレッドシートに表示されると、一気に「プログラミングでツールを作っている感」が出てワクワクしてきますよね!

🚀 次回予告

次回は、同じく自動実行のシンプルトリガー仲間である 「onEdit(e)(フォームやセルが書き換えられたら自動実行)」 を学びます!

「特定のセルが『完了』に変わったら自動で色を変える」「入力された瞬間にチェックする」といった、より高度なリアルタイム自動化に挑戦しますので、どうぞお楽しみに!