Websites

Startseiten sind eine Funktion von Google Workspace-Add-ons, mit der Sie eine oder mehrere nicht kontextbezogene Karten definieren können. Nicht kontextbezogene Karten zeigen eine Benutzeroberfläche an, wenn sich der Nutzer außerhalb eines bestimmten Kontexts befindet, z. B. wenn er seinen Gmail-Posteingang ohne eine geöffnete Nachricht oder einen Entwurf aufruft.

Auf Startseiten können Sie nicht kontextbezogene Inhalte anzeigen, ähnlich wie bei den Google-Apps in der Seitenleiste für den Schnellzugriff (Google Notizen, Google Kalender und Google Tasks). Startseiten können auch ein guter Ausgangspunkt sein, wenn ein Nutzer Ihr Add-on zum ersten Mal öffnet. Sie sind hilfreich, um neuen Nutzern zu zeigen, wie sie mit Ihrem Add-on interagieren können.

Sie können eine Startseite für Ihr Add-on definieren, indem Sie sie in Ihrem Projektmanifest angeben und eine oder mehrere homepageTrigger Funktionen implementieren (siehe Startseite konfigurieren).

Sie können mehrere Startseiten haben, eine für jede Hostanwendung, die Ihr Add-on erweitert. Sie können auch eine gemeinsame Standardstartseite definieren, die in Hosts verwendet wird, in denen Sie keine benutzerdefinierte Startseite angegeben haben.

Die Startseite Ihres Add-ons wird in folgenden Fällen angezeigt:

  • Wenn das Add-on zum ersten Mal im Host geöffnet wird (nach der Autorisierung).
  • Wenn der Nutzer von einem kontextbezogenen zu einem nicht kontextbezogenen Kontext wechselt, während das Add-on geöffnet ist. Zum Beispiel von der Bearbeitung eines Kalenderereignisses zum Hauptkalender.
  • Wenn der Nutzer so oft auf die Schaltfläche „Zurück“ klickt, dass alle anderen Karten aus den internen Stacks entfernt werden.
  • Wenn eine UI-Interaktion auf einer nicht kontextbezogenen Karte zu einem Navigation.popToRoot-Aufruf führt.

Es wird empfohlen, eine Startseite zu entwerfen. Wenn Sie keine definieren, wird immer dann eine generische Karte mit dem Namen Ihres Add-ons verwendet, wenn ein Nutzer zur Startseite navigiert.

Startseite konfigurieren

Google Workspace-Add-ons verwenden das addOns.common.homepageTrigger Feld, um den Standardinhalt des Add-ons für die Startseite (nicht kontextbezogen) für Hostanwendungen im Add-on-Manifest zu konfigurieren:

{
  "addOns": {
    "common": {
      "homepageTrigger": {
        "runFunction": "myFunction",
        "enabled": true
      }
    }
  }
}

  • runFunction: Der Name der Google Apps Script-Funktion, die vom Google Workspace-Add-on-Framework aufgerufen wird, um Add-on-Karten für die Startseite zu rendern. Diese Funktion ist die Homepage-Triggerfunktion. Diese Funktion muss ein Array von Card Objekten erstellen und zurückgeben, aus denen die Benutzeroberfläche der Startseite besteht. Wenn mehr als eine Karte zurückgegeben wird, werden die Kartenüberschriften in der Hostanwendung in einer Liste angezeigt, aus der der Nutzer auswählen kann (siehe Mehrere Karten zurückgeben).

  • enabled: Gibt an, ob Homepage-Karten für diesen Bereich aktiviert werden sollen. Dieses Feld ist optional und hat standardmäßig den Wert true. Wenn Sie diese Option auf false setzen, werden Homepage-Karten für alle Hosts deaktiviert, es sei denn, sie werden für diesen Host überschrieben (siehe Hostspezifische Konfiguration).

Damit ein Host die gemeinsame Startseite verwenden kann, müssen sowohl addOns.common.homepageTrigger als auch die Ressource der obersten Ebene des Hosts im Add-on Manifest vorhanden sein. Wenn addOns.gmail beispielsweise nicht im Manifest vorhanden ist, wird das Add-on für Gmail deaktiviert und zeigt keine Startseite oder andere Funktionen in diesem Host an.

Zusätzlich zur gemeinsamen Konfiguration sind in der Konfiguration jeder Hostanwendung identisch strukturierte Überschreibungen pro Host unter addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger und anderen hostspezifischen Triggern verfügbar.

Im folgenden Beispiel wird ein Manifest gezeigt, in dem ein gemeinsamer Homepage-Trigger definiert ist, der jedoch mit benutzerdefinierten Funktionen für Google Kalender und Google Drive überschrieben und für Gmail deaktiviert ist. In dieser Konfiguration wird die gemeinsame buildHomePage-Funktion nie ausgeführt, da sie entweder überschrieben oder der Host deaktiviert ist.

{
  ...
  "addOns": {
    ...
    "common": {
      "homepageTrigger": { "runFunction": "buildHomePage" }
    },
    "calendar": {
      "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
    },
    "drive": {
      "homepageTrigger": { "runFunction": "buildDriveHomepage" }
    },
    "gmail": {
      "homepageTrigger": { "enabled": false }
    },
    ...
  }
}

Der folgende Manifestauszug entspricht dem vorherigen Beispiel, obwohl der Standard-homepageTrigger und die Gmail-Konfiguration weggelassen wurden:

{
  "addOns": {
    "common": {},
    "calendar": {
      "homepageTrigger": { "runFunction": "myCalendarFunction" }
    },
    "drive": {
      "homepageTrigger": { "runFunction": "myDriveFunction" }
    },
    "gmail": {},
    ...
  }
}

Keiner der homepageTrigger-Abschnitte ist erforderlich. Die Benutzeroberfläche, die für ein Add-on in einem Hostprodukt angezeigt wird, hängt vom Vorhandensein des entsprechenden Manifestfelds und davon ab, ob ein zugehöriger homepageTrigger vorhanden ist. Im folgenden Beispiel wird gezeigt, welche Add-on-Triggerfunktionen ausgeführt werden, um eine Benutzeroberfläche für die Startseite für verschiedene Manifestkonfigurationen zu erstellen:

Diagramm zum Ausführungsablauf der Triggerfunktion für die Add-on-Startseite

Homepage-Ereignisobjekte

Wenn die zuvor beschriebene Homepage-Triggerfunktion (runFunction) aufgerufen wird , wird ihr ein Ereignisobjekt übergeben, das Daten aus dem Aufrufkontext enthält.

Homepage-Ereignisobjekte enthalten keine Widget- oder Kontextinformationen. Die übergebenen Informationen sind auf die folgenden allgemeinen Ereignisobjekt felder beschränkt:

Weitere Informationen finden Sie unter Ereignisobjekt.

Weitere nicht kontextbezogene Karten

Die Benutzeroberfläche Ihres Add-ons kann zusätzliche nicht kontextbezogene Karten enthalten, die keine Startseiten sind. Auf Ihrer Startseite kann beispielsweise eine Schaltfläche vorhanden sein, mit der eine Karte „Einstellungen“ geöffnet wird, um Add-on-Einstellungen anzupassen. Solche Einstellungen sind in der Regel kontextunabhängig.

Nicht kontextbezogene Karten werden wie jede andere Karte erstellt. Der einzige Unterschied besteht darin, welche Aktion oder welches Ereignis die Karte generiert und anzeigt. Weitere Informationen zum Erstellen von Übergängen zwischen Karten finden Sie unter Navigationsmethoden.