onOpen / onEditなどで出るエラーの対処方法 – Google Apps Script・スプレッドシート

2022年3月21日2022年4月4日

Google Apps Scriptでは関数名にonOpenやonEditなどを使えば、スプレッドシートが開かれたときや編集されたときにスクリプトを走らせることが可能です。

が、なぜかエラーが出たりスクリプトが無反応だったりするがあるんですよね。コードは間違っていないはずなのに。

今回はこれらシンプルトリガーでスクリプトが動かない原因と対処方法を解説します。

自分がハマったから記録残したいだけなんですけどね。いわゆる個人ブログの備忘録ってヤツ！　有能かは知らん。

原因はいろいろ考えられるけれど

実のところ、関数名をつけるだけでトリガーとなるonOpen / onEditはシンプルトリガーと呼ばれるもの。

// スプレッドシートを開くと発火するトリガー
function onOpen() {
  Browser.msgBox('Hello, how low')
}

// 値を編集すると発火するトリガー
function onEdit() {
  Browser.msgBox('Hello, how low')
}

上記はあくまでも一例で、ほかonInstall()、onSelectionChange()、doGet()、doPost()を含めて全6種類。

シークレットもあるよ！　うそだよ！

（シークレットはウソですが、結構コロコロ変わるので増減する可能性はあり）

で、肝心の原因ですけど、主に考えられるのは下記。

（ただしdoGetとdoPost除く）

解決方法

一番簡単な解決方法はシンプルトリガーをやめてインストーラブルトリガーを利用すること。

インストーラブルトリガーはどういうイベントでスクリプトが走るかを別途設定する必要があります。

その代わり、コンテナバインドじゃなくても使えたり、関数名を自由に設定できたり、定期的に自動で動かしたりできたりといろいろ便利。

（ただ、シンプルトリガーと同じく読み取り専用の場合はNG）

インストーラブルトリガーの使い方

インストーラブルトリガーはスクリプト上に書き込むのではなく、Google Apps Scriptのプロジェクト上で設定するトリガーです。

下記手順で設定します。

1. 左側にある時計マークのトリガー
2. 右下の＋トリガーを追加
3. もろもろ設定する

右下の「＋トリガーを追加」をクリック。

そのまんま、「実行する関数を選択する」にはトリガーで実行させたい関数を設定。

「イベントの種類を選択」の箇所にスクリプトが発火するタイミングを設定します。

起動時はonOpen()と同じくスプシを開いたとき。編集時はonEdit()と同じくスプシに変更が行われたとき。

インストーラブルトリガーをスクリプトで仕込むことも可能

インストーラブルトリガーをスクリプトでセットすることもできます。さすがGAS。

トリガーをセットするスクリプトの例

let ss = SpreadsheetApp.getActiveSpreadsheet();

let functionName = 'exampleFunction'; // ①セットしたい関数の名前

function exampleFunction() {
  Browser.msgBox('スクリプト発火！')
}

function init() {
  try{
    let triggers = ScriptApp.getProjectTriggers();
    let target = triggers.findIndex(trigger => trigger.getHandlerFunction() === functionName);
    
    if(target !== -1) {
      Browser.msgBox('すでにトリガー登録済みです');
      return 0;
    }
    
    ScriptApp.newTrigger(functionName)
    .forSpreadsheet(ss)
    .onEdit() // ② トリガーを設定 例：onEdit()は編集時 / onOpen()は起動時（スプシを開いた時）
    .create();
    
  }catch(e){
    // エラー
    Logger.log(e);
    Browser.msgBox('下記エラーが出ました¥n' + e);
  }
}

主に編集が必要なのは①と②。

3行目①の変数部分にはインストーラブルトリガーセットしたい関数名を入れてください。トリガー設定画面で設定する「実行する関数を選択する」の箇所です。

21行目②はonOpen、onEditなどトリガーイベントの種類を入れてください。トリガー設定画面の「イベントの種類を選択」の箇所です。

ちなみに本コードは下記AGOHACKさんのサイトを参考にしました。

あと、トリガーの部分はGASレファレンスサイトで公開しているトリガービルダーを使うと色々作れます。

（公式が英語なのでGoogle翻訳にURLぶちこんで日本語に翻訳しています）

AGOHACK

AGOHACK [GAS] ボタンクリックでトリガーを設定する方法

Google Apps Scriptレファレンス トリガービルダー