エディタのアドオンのカスタム メニュー

公開されたエディタのアドオンを使用すると、エディタの [拡張機能] メニューの下にカスタム メニュー項目を作成できます。アドオン メニューを挿入するには Ui.createAddonMenu() メソッドを使用し、アイテムを追加するには Menu.addItem() メソッドを使用します。メニューは通常、アドオンの onOpen(e) メソッドで作成します。

ユーザーの操作やアドオンの状態に応じて変化する動的メニューを作成できます。ただし、ユーザーがアドオンを承認する前に、最初のメニューを作成する必要があります。このため、onOpen(e) でメニューを作成する前に、アドオンの認可モードを確認しておく必要があります。アドオンが ScriptApp.AuthMode.NONE にある間は、承認を必要とする操作(スクリプト Properties のチェックなど)を行わないでください。認可モードとライフサイクルの詳細については、認可ライフサイクルをご覧ください。

次の例は、さまざまな認証モードの動的アドオン メニューを作成する方法を示しています。

function onOpen(e) {
  var menu = SpreadsheetApp.getUi().createAddonMenu(); // Or DocumentApp or SlidesApp or FormApp.
  if (e && e.authMode == ScriptApp.AuthMode.NONE) {
    // Add a normal menu item (works in all authorization modes).
    menu.addItem('Start workflow', 'startWorkflow');
  } else {
    // Add a menu item based on properties (doesn't work in AuthMode.NONE).
    var properties = PropertiesService.getDocumentProperties();
    var workflowStarted = properties.getProperty('workflowStarted');
    if (workflowStarted) {
      menu.addItem('Check workflow status', 'checkWorkflow');
    } else {
      menu.addItem('Start workflow', 'startWorkflow');
    }
    // Record analytics.
    UrlFetchApp.fetch('http://www.example.com/analytics?event=open');
  }
  menu.addToUi();
}