Benutzerdefinierte Menüs für Editor-Add-ons

Editor-Add-ons veröffentlicht können unter dem Menü Erweiterungen des Editors benutzerdefinierte Menüpunkte erstellen. Sie können fügen Sie ein Add-on-Menü mithilfe der Methode Ui.createAddonMenu() und fügen Sie Elemente über die Menu.addItem() . Menüs werden normalerweise in der onOpen(e)-Methode des Add-ons erstellt.

Achtung: Mit nicht veröffentlichten Add-ons können auch benutzerdefinierte Menüs der obersten Ebene erstellt werden. Diese werden jedoch automatisch in das Menü Add-ons verschoben, wenn das Add-on veröffentlicht wird. Dies kann zu einer nicht beabsichtigten Nutzererfahrung führen. Wenn Sie das Add-on veröffentlichen möchten, verwenden Sie immer Ui.createAddonMenu(), um das Add-on-Menü zu definieren.

Sie können dynamische Menüs erstellen, die sich je nach Nutzerinteraktion oder Add-on ändern Bundesstaat. Add-ons müssen jedoch ein anfängliches Menü erstellen, bevor das Add-on verwendet wird. vom Nutzer autorisiert wurde. Daher müssen Sie die Einstellungen des Add-ons Autorisierungsmodus bevor Sie Menüs in onOpen(e) erstellen. Versuchen Sie nicht, Maßnahmen zu ergreifen. die eine Autorisierung erfordert (z. B. Überprüfung des Skripts Properties) solange sich das Add-on in ScriptApp.AuthMode.NONE befindet. Weitere Informationen finden Sie in der Autorisierungslebenszyklus finden Sie weitere Informationen zu den Autorisierungsmodi und zum Lebenszyklus.

Warnung: Wenn Sie versuchen, Aktionen auszuführen, für die eine Autorisierung erforderlich ist, während der Autorisierungsmodus ScriptApp.AuthMode.NONE ist, führt dies zu einem Fehler. Dieses kann verhindern, dass Ihre Add-on-Menüs angezeigt werden.

Das folgende Beispiel zeigt, wie Sie ein dynamisches Add-on-Menü für verschiedene Autorisierungsmodi:

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();
}