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

公開されたエディタ アドオンでは、エディタの [アドオン] メニューの下にカスタム メニュー項目を作成できます。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();
}