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

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

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

承認モードが ScriptApp.AuthMode.NONE のときに承認が必要な操作を行おうとすると、エラーが発生します。これにより、アドオン メニューが表示されなくなる可能性があります。

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

function onOpen(e) {
  // Or DocumentApp, SlidesApp, or FormApp.
  var menu = SpreadsheetApp.getUi().createAddonMenu();
  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();
}