【GAS入門#23】コードから自動実行を設定&解除!ScriptApp.newTrigger() と ScriptApp.deleteTrigger() の使い方

前回までの記事(第21回・第22回)では、ファイルを開いたときやセルを書き換えたときに自動で動く「シンプルトリガー(onOpen や onEdit)」について学びましたね。 「プログラムが勝手に動いてくれる」という自動化の楽しさを感じていただけたのではないでしょうか?

しかし、実務で自動化を進めていると、こんな要望が必ず出てきます。

  • 「毎朝9時に、自動でデータを集計してレポートを作成してほしい!」
  • 「指定した日時になったら、1回だけリマインド通知を送りたい!」
  • 「ボタンを1回押したら、裏で『毎週月曜日の朝に動く定期実行タスク』をセットしたい!」
  • 「処理が終わったり、期限が切れたりしたら、仕掛けたタイマーを自動で解除したい!」

これらを可能にするのが、今回学習する ScriptApp.newTrigger() と ScriptApp.deleteTrigger() です!

これまではGASのエディタ画面にある「時計マーク(トリガー設定画面)」から手動でポチポチと設定していたタイマーを、すべてプログラム(コード)の中から自由自在に作成・削除できるようになります。

今回も札幌オフィスの日常をテーマに、コードの仕組みから実践例、初心者が必ずハマる落とし穴まで、どこよりも丁寧に分かりやすく解説していきますね!

1. そもそも「コードからトリガーを操作する」ってどういうこと?

まずは、今回扱う機能の全体像とイメージを整理しておきましょう。

手動設定とコード実行(動的設定)の違い

GASでプログラムを定期実行させる方法には、大きく分けて2種類あります。

項目手動設定(UI画面の時計マーク)コードによる作成(ScriptApp.newTrigger)
設定方法エディタの「トリガー」画面からマウスで操作GASのコード(プログラム)を実行して作成
柔軟性あらかじめ固定された時間・周期しか設定できない「ユーザーが入力した日時」などに合わせて動的に作れる
自動化プログラム内で自動作成・自動削除はできないプログラム内で作成も削除も全自動化できる!
主な用途ずっと同じ時間に動かす日次・月次処理動的なリマインダー、使い捨てタイマー、システム初期化

手動設定は「毎朝目覚まし時計の針を自分でセットする」ようなものです。

それに対して、今回の ScriptApp.newTrigger() は、「『明日朝7時に目覚ましをセットして、鳴り終わったら目覚まし自体を片付けておいて!』と、GASのお手伝いロボットに指示を出すコマンド」 だと考えてみてください。

なぜコードから削除(deleteTrigger)する必要があるの?

「トリガーを作るだけなら便利だけど、なぜ削除までコードでやる必要があるの?」と思うかもしれません。

実は、GASには 「1つのプロジェクトで作成できるトリガーの数(1ユーザーあたり20個まで)」 という制限があります。

もしプログラムの中でトリガーを作る処理だけを何度も実行してしまうと、同じタイマーが何十個も重複して作られ、「毎朝9時に同じメールが10通届く」「エラーでプログラムが動かなくなる」 という大事故につながってしまうのです。

だからこそ、「新しいトリガーを作る命令(newTrigger)」 と 「不要なトリガーを消す命令(deleteTrigger)」 はセットでマスターしておく必要があります!

2. コードの文法と書き方を分解してマスターしよう!

少し長めのコードになりますが、仕組みはとてもシンプルです。1つずつ解剖してみましょう。

① トリガーを新しく作る文法:ScriptApp.newTrigger()

ScriptApp.newTrigger("実行したい関数名")
  .timeBased()
  .everyDays(1)
  .atHour(9)
  .create();

ドット(.)でつないで命令を鎖のように繋げていく「ビルダーパターン」という書き方をします。

  1. ScriptApp.newTrigger("関数名")「今からこの関数を自動実行するタイマーを作るよ!」と宣言します。関数名は必ず " "(ダブルクォーテーション)で囲む のがポイントです。
  2. .timeBased()「時間主導型(タイマー機能)のトリガーにするよ!」という指定です。
  3. .everyDays(1) または .everyWeeks(1) など「1日おき」「1週間おき」といった実行周期を指定します。
  4. .atHour(9)「午前9時台に実行してね!」と時間を指定します(※GASの仕様上、9時00分ピッタリではなく、9時〜10時の間のどこかで実行されます)。
  5. .create()「以上の設定でトリガーを正式に作成・保存して!」という最後の決定ボタンです。

② 既存のトリガーを削除する文法:ScriptApp.deleteTrigger()

// 1. このプロジェクトに存在するすべてのトリガーを取得する
var triggers = ScriptApp.getProjectTriggers();

// 2. ループ処理(繰り返し)で1つずつ削除する
for (var i = 0; i < triggers.length; i++) {
  ScriptApp.deleteTrigger(triggers[i]);
}
  1. ScriptApp.getProjectTriggers()現在設定されているトリガーを「配列(お弁当箱)」の形でまとめて持ってきます。
  2. ScriptApp.deleteTrigger(トリガーオブジェクト)取得したトリガーを指定して消去します。引数には「関数名の文字列」ではなく「トリガーそのもの(オブジェクト)」を渡す 点に注意しましょう!

3. STEP1:準備!「札幌オフィス_朝の定期チェック表」を作成しよう

それでは、実際に動くコードを作成してみましょう!

今回は、札幌オフィスの朝の業務を想定した「毎朝の定期チェック表」を用意します。

手順

  1. ブラウザで新しいGoogleスプレッドシートを作成し、ファイル名を 「札幌オフィス_朝の定期チェック表」 にします。
  2. 画面下のシートタブ名を 「実行ログ」 に変更します。
  3. 1行目に見出しとして、以下のように入力しておきます。
AB
1実行日時ステータス

入力できたら、「実行ログ」シートを開いた状態(アクティブ)にしておきましょう。

4. STEP2:【実践】ScriptApp.newTrigger() で「毎朝9時」のタイマーをコードから作成してみよう!

まずは、プログラムを実行して、管理画面にトリガーを自動作成させてみます。

1. コードを入力する

スプレッドシートのメニューバーから 「拡張機能」 > 「Apps Script」 を開き、最初から書いてあるコードを消して、以下のプログラムを貼り付けます。

// 【自動実行させたい本処理】(毎朝9時に呼ばれる関数)
function sendMorningReport() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var sheet = ss.getSheetByName("実行ログ");
  
  // 実行した日時とメッセージをシートの末尾に追記する(第7回で学んだappendRow!)
  sheet.appendRow([new Date(), "朝の定期レポート作成完了(札幌オフィス)"]);
}

// 【トリガー作成用関数】(この関数を1回実行してタイマーをセットする)
function setDailyTrigger() {
  // 1. 重複防止のため、既存の同名トリガーがあれば先に削除しておく
  deleteTriggerByName("sendMorningReport");
  
  // 2. 毎朝9時〜10時の間に「sendMorningReport」を実行するトリガーを作成
  ScriptApp.newTrigger("sendMorningReport")
    .timeBased()
    .everyDays(1)
    .atHour(9)
    .create();
    
  Logger.log("「sendMorningReport」の毎朝9時トリガーを正常に作成しました!");
}

// 【安全対策】指定した関数名のトリガーだけを削除する便利関数
function deleteTriggerByName(functionName) {
  var triggers = ScriptApp.getProjectTriggers();
  
  for (var i = 0; i < triggers.length; i++) {
    if (triggers[i].getHandlerFunction() === functionName) {
      ScriptApp.deleteTrigger(triggers[i]);
      Logger.log("古いトリガー(" + functionName + ")を削除しました。");
    }
  }
}

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

  • deleteTriggerByName("sendMorningReport");新しくトリガーを作る前に、「すでに同じ名前のトリガーがセットされていないか」をチェックして削除する自作の安全装置 です。これを入れておくことで、誤って何回も実行ボタンを押してもトリガーが無限増殖するのを防げます。
  • triggers[i].getHandlerFunction()トリガーが「どの関数を呼び出す設定になっているか」の名前(文字列)を取得する命令です。これを使って目的のトリガーだけを判別しています。

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

  1. エディタ上部の 「保存(フロッピーアイコン)」 をクリックします。
  2. 実行する関数に setDailyTrigger を選択し、「実行」 ボタンをクリックします。
  3. 初回実行時はGoogleの「承認が必要です」というセキュリティポップアップが出ますので、アクセスを許可してください。

実行ログに以下のように表示されれば成功です!

情報    古いトリガー(sendMorningReport)を削除しました。
情報    「sendMorningReport」の毎朝9時トリガーを正常に作成しました!

4. 設定されたトリガーを画面で確認してみよう!

本当にコードからトリガーが作られたか、管理画面を覗いてみましょう。

  1. GASのエディタ画面の左側メニューにある 「時計マーク(トリガー)」 アイコンをクリックします。
  2. 一覧画面に、実行する関数が 「sendMorningReport」、イベントのソースが 「時間主導型」、時間ベースのトリガーのタイプが 「日付ベースのタイマー」(時刻:午前9時〜10時)となったトリガーが1件追加されているはずです!

マウスを一切使わず、コードを1回実行しただけでトリガーの設定が完了しました!

5. STEP3:【実践】ScriptApp.deleteTrigger() でトリガーを自動削除してみよう!

今度は、不要になったトリガーをプログラムから綺麗に消去してみましょう。

「もうこのプロジェクトの定期実行はストップしたい」「すべてのタイマーをリセットしたい」という時に使う全削除用関数です。

1. 以下のコードを追記する

エディタの末尾に、以下のコードを追加して保存してください。

// 【全トリガー削除用関数】このプロジェクトのすべてのトリガーを消去する
function clearAllTriggers() {
  // 1. プロジェクトに設定されている全トリガーを取得
  var allTriggers = ScriptApp.getProjectTriggers();
  
  // 2. ループ処理で1つずつ削除
  for (var i = 0; i < allTriggers.length; i++) {
    ScriptApp.deleteTrigger(allTriggers[i]);
  }
  
  Logger.log("合計 " + allTriggers.length + " 個のトリガーをすべて削除しました!");
}

2. 実行して確認する

  1. 実行する関数に clearAllTriggers を選択し、「実行」 をクリックします。
  2. 左メニューの「時計マーク(トリガー)」画面を開き直してみてください。

先ほど作成されたトリガーが一覧からキレイサッパリ消えていれば大成功です!

6. 実務で役立つ応用例!「1回動いたら勝手に消える使い捨てタイマー」

newTrigger と deleteTrigger の真価が発揮されるのが、「指定した時間(例: 10分後)に1回だけ処理を実行し、動いた直後に自分自身のトリガーを削除して後片付けする」 という使い捨て(ワンタイム)タイマーです!

例えば、「今から10分後に札幌オフィスの同僚にリマインドメッセージを送り、送信が終わったらタイマーを自動破棄する」といったスマートな処理が作れます。

// 10分後に1回だけ動かす使い捨てタイマーを仕込む関数
function setOneTimeTimer() {
  // 今から10分後の日時を計算(ミリ秒単位)
  var triggerTime = new Date();
  triggerTime.setMinutes(triggerTime.getMinutes() + 10);
  
  // 指定日時に1回だけ動くトリガーを作成
  ScriptApp.newTrigger("oneTimeTask")
    .timeBased()
    .at(triggerTime)
    .create();
    
  Logger.log("10分後に1回だけ動くタイマーをセットしました!");
}

// 10分後に実際に実行される関数
function oneTimeTask() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var sheet = ss.getSheetByName("実行ログ");
  
  // 本処理を実行
  sheet.appendRow([new Date(), "10分後の使い捨てタスクが実行されました!"]);
  
  // 【後片付け】使い終わった自分自身のトリガーを自動削除!
  deleteTriggerByName("oneTimeTask");
}

このように、「動いたあとに自分で自分を消す」 というロジックを組んでおけば、トリガーの上限枠を圧迫することなく、何回でも安全に時効タスクを予約できます!

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

ScriptApp.newTrigger() や deleteTrigger() を使う際、初心者がハマりやすいトラブルと解決策をまとめました。

トラップ1:実行するたびにトリガーが二重・三重に増殖する

症状

テストで setDailyTrigger() の実行ボタンを5回押したら、毎朝9時に全く同じ処理が5回実行されてしまう。

原因

newTrigger() は、呼び出されるたびに 無条件で新しいトリガーを別物として追加作成 します。「上書き保存」はしてくれません。

対処法

今回紹介したように、newTrigger() を呼ぶ直前に 必ず deleteTriggerByName("関数名") を実行して既存の同名トリガーを削除する 癖をつけましょう!

トラップ2:newTrigger("myFunction()") のようにカッコを書いてエラーになる

症状

Exception: Invalid argument: functionName というエラーが出で動かない。

原因

newTrigger() の引数には、関数名のみを文字列で渡すルールになっています。末尾にカッコ () をつけてしまうとエラーになります。

  • ✕ ScriptApp.newTrigger("sendMorningReport()")
  • ◯ ScriptApp.newTrigger("sendMorningReport")

トラップ3:deleteTrigger() の引数に「関数名の文字列」を渡してしまう

症状

Exception: Cannot find method deleteTrigger(string) というエラーが出る。

原因

deleteTrigger() は、文字列("sendMorningReport")を直接渡されても削除できません。ScriptApp.getProjectTriggers() で取得した トリガーオブジェクトそのもの を渡す必要があります。

  • ✕ ScriptApp.deleteTrigger("sendMorningReport")
  • ◯ ScriptApp.deleteTrigger(triggerObject)

トラップ4:atHour(9) に指定したのに「午前9時ピッタリ」に動かない

症状

9時00分に動くはずが、9時24分や9時45分に実行される。

原因

これはGASの不具合ではなく 仕様 です。

GASの時間主導型トリガーは、サーバーの負荷を分散させるため、指定した時間帯(例:9時〜10時の1時間枠)のどこかでランダムに実行される仕組みになっています。

秒単位・分単位でピッタリの時間に動かしたい用途には向きませんので、「9時台のどこかで動けばOK」という業務設計にしておくのがコツです。

トラップ5:トリガーの上限数(20個制限)に達してしまう

症状

Exception: This script has too many triggers. Area limit: 20 と出でトリガーが作れなくなる。

原因

Googleアカウントの制約上、1つのGASプロジェクト内で作成できるトリガーは 最大20個まで です。

不要になったトリガーを deleteTrigger() で消さずに放置していると、あっという間に上限に達してしまいます。

使い終わったトリガーは必ず削除するコードを書いておきましょう!

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

今回は、コードから自動実行を設定・解除する ScriptApp.newTrigger() と ScriptApp.deleteTrigger() を学びました。

今日の重要ポイント

  1. ScriptApp.newTrigger("関数名") で、コード内からタイマーを動的に自動生成できる!
  2. トリガーを作る前は、重複を防ぐために既存トリガーを消す(deleteTrigger)のが鉄則!
  3. 使い捨てタスクは「処理の最後に自分自身のトリガーを削除する」ことでスマートに運用できる!
  4. GASの時間主導型トリガーは指定時間から少しズレて実行される(1時間の幅がある)仕様を押さえておく!

これで、手動設定に頼らず、プログラムだけで完全自動化のスケジュール管理ができるようになりましたね!

さて、自動化の仕組みが整ってきたところで、次回(第24回)はユーザーとの対話形式(UI)を拡張する SpreadsheetApp.getUi() に進みます!

「処理を実行してもよろしいですか?」「はい / いいえ」といったポップアップ画面(ダイアログ)を表示させ、ユーザーの操作に応じて処理を分岐させる、より本格的なアプリ開発に挑戦していきましょう。お楽しみに!