Google Apps Script(GAS)でスプレッドシートにオリジナルメニューを追加する

Google Apps Script(GAS)でスプレッドシートにオリジナルメニューを追加する

はじめに

この記事では、Google Apps Script(GAS)を利用し、スプレッドシートにオリジナルメニューを追加する方法について説明します。
前半に当社開発ツールを利用するお客様に対してのマニュアルを掲載し、後半に開発者向けにオリジナルメニューを追加する方法を掲載しています。

当社が作成したツールを使用するにあたってマニュアルに記載していた内容を、こちらに公開しておくことにしました。
既にありふれた情報ではありますが、自社が編集できる、一般公開できる場所に記載しておくことを目的としています。

使い方

当社開発ツールを利用するお客様は、下記の場所でオリジナルメニューを実行できます。

なお、対象のスプレッドシートで初めて実行する際は、下記を参照して、スクリプトの承認をしてください。
https://zenn.dev/kzautomation/articles/9e1595f65420be

スクリプト

下記の例では、オリジナルメニューとして、自動処理の設定、解除をそれぞれ行うメニューを追加しています。
スクリプトエディタを開くことなく、自動処理関数のトリガー設定をすることを想定しています。

originalMenu.js

function onOpen() {
  const ui = SpreadsheetApp.getUi();
  const menu = ui.createMenu('オリジナルメニュー');
  menu.addItem('自動処理設定', 'setAuto');
  menu.addItem('自動処理解除', 'removeAuto');
  menu.addToUi();
}

/**
 * 自動処理設定
 */
function setAuto(){
  ...
}

/**
 * 自動処理解除
 */
function removeAuto(){
  ...
}

addItem の関数にて、第一引数にメニュー名として表示される文字列を指定し、第二引数には、実行する関数名を指定します。
仕組み上、呼び出す関数は引数を取れないため、引数を取る関数を呼び出す場合は、別の関数を指定し、その関数内で引数を取る関数を呼び出すようにします。