GASでスプレッドシートの拡張機能にアドオンを追加するには「createAddonMenu()
」を利用する。
createAddonMenu()
エディタのアドオン メニューにサブメニューを挿入するために使用できるビルダーを作成します。Menu.addToUi() が呼び出されるまで、メニューは実際には更新されません。スクリプトがアドオンとして実行されている場合、サブメニュー名はウェブストア内のアドオン名と一致します。スクリプトがドキュメントに直接バインドされている場合、サブメニュー名はスクリプトの名前と一致します。詳しくは、メニューガイドをご覧ください。
https://developers.google.com/apps-script/reference/base/ui#createaddonmenu
スプレッドシートの拡張機能にアドオンを追加するGAS実行の様子
createAddonMenu() メソッドを利用して、スプレッドシートの拡張機能にアドオンを追加するGASを実行してみました。
createAddonMenu()を実行することで、
- 拡張機能メニューに独自アドオンをメニューとして表示・実行させる
といった操作が可能です。
スプレッドシートでチェックボックスを全て削除する場合は、以下記事を御覧ください。
参照記事:【GAS】スプレッドシートでチェックボックスを全て削除する
スプレッドシートの拡張機能にアドオンを追加するGAS
//—-拡張機能にアドオンを追加するーー
function onOpen(e){
//SpreadsheetAppを起動・getUiでインターフェイスに追加
SpreadsheetApp.getUi()
//■createAddonMenuで拡張機能の下にアドオンを追加
.createAddonMenu()
//addItemでオリジナル関数test1をメニュー追加
.addItem('アラート表示','test1')
//addToUiでUiに埋め込み
.addToUi();
}
//—-createAddonMenu追加アドオンで実行させる関数ーー
function test1(){
//SpreadsheetAppを起動・getUiでインターフェイスに追加
const ui = SpreadsheetApp.getUi();
//アラートを追加
ui.alert("test1を実行しました");
}
createAddonMenu()の戻り値
Menu - 新しいメニュー ビルダー。
スプレッドシートの拡張機能にアドオンを追加するまとめ
GAS×スプレッドシートの拡張機能にアドオンを追加するならcreateAddonMenu()
メソッドを利用しましょう。
関連記事:【GAS】スプレッドシートの文字の折返しを配列で設定する