Websites

Startseiten sind eine neue Google Workspace-Add-on-Funktion, mit der eine oder mehrere nicht kontextabhängige Karten definiert werden können. Nicht kontextabhängige Karten werden verwendet, um eine Benutzeroberfläche anzuzeigen, wenn sich der Nutzer außerhalb eines bestimmten Kontexts befindet, z. B. wenn er sich seinen Gmail-Posteingang ansieht, aber keine Nachricht oder einen Entwurf geöffnet hat.

Auf den Startseiten können Sie nicht kontextbezogene Inhalte anzeigen lassen, so wie die Google-Apps in der Schnellzugriff-Seitenleiste (Google Notizen, Google Kalender und Google Tasks) angezeigt werden. Startseiten können auch als Ausgangspunkt dienen, wenn ein Nutzer dein Add-on zum ersten Mal öffnet. Außerdem eignen sie sich, um neuen Nutzern die Interaktion mit deinem Add-on zu vermitteln.

Du kannst eine Startseite für dein Add-on definieren, indem du sie in deinem Projektmanifest angibst und eine oder mehrere homepageTrigger-Funktionen implementierst (siehe Konfiguration der Startseite).

Sie können mehrere Startseiten haben – eine für jede Hostanwendung, die durch Ihr Add-on erweitert wird. Sie können auch eine gemeinsame Standard-Startseite festlegen, die auf Hosts verwendet wird, für die Sie keine benutzerdefinierte Startseite angegeben haben.

Ihre Add-on-Startseite wird angezeigt, wenn eine der folgenden Bedingungen erfüllt ist:

  • Das Add-on wird nach der Autorisierung zum ersten Mal im Host geöffnet.
  • Wenn der Nutzer von einem Kontextkontext zu einem nicht kontextbezogenen Kontext wechselt, während das Add-on geöffnet ist. Zum Beispiel vom Bearbeiten eines Kalendertermins zum Hauptkalender.
  • Wenn der Nutzer häufig auf die Schaltfläche „Zurück“ klickt, um alle anderen Karten aus den internen Stapeln zu entfernen
  • Wenn eine UI-Interaktion in einer nicht kontextbezogenen Karte zu einem Navigation.popToRoot()-Aufruf führt.

Das Entwerfen einer Startseite ist nicht obligatorisch, wird aber dringend empfohlen. Wenn Sie keine festlegen, wird immer dann eine allgemeine Karte mit Ihrem Add-on-Namen verwendet, wenn ein Nutzer die Startseite aufrufen würde.

Konfiguration der Startseite

In Google Workspace-Add-ons wird das Feld addOns.common.homepageTrigger verwendet, um die Standardstartseite für Add-ons für alle Hostanwendungen im Manifest des Add-ons zu konfigurieren:

    {
      // ...
      "addOns": {
        // ...
        "common": {
          // ...
          "homepageTrigger": {
            "runFunction": "myFunction",
            "enabled": true
          }
        }
      }
    }
  • runFunction: Der Name der Apps Script-Funktion, die vom Google Workspace-Add-on-Framework zum Rendern von Startseiten-Add-on-Karten aufgerufen wird. Diese Funktion ist die Triggerfunktion für die Startseite. Diese Funktion muss ein Array von Card-Objekten erstellen und zurückgeben, die die Benutzeroberfläche der Startseite bilden. Wenn mehr als eine Karte zurückgegeben wird, zeigt die Host-Anwendung die Kartenheader in einer Liste an, aus der der Nutzer auswählen kann (siehe Mehrere Karten zurückgeben).

  • enabled: Gibt an, ob Startseitenkarten für diesen Bereich aktiviert werden sollen. Dieses Feld ist optional und standardmäßig auf true eingestellt. Wenn dieser Wert auf false gesetzt wird, werden Startseitenkarten für alle Hosts deaktiviert, sofern sie nicht für diesen Host überschrieben werden (siehe unten).

Zusätzlich zur allgemeinen Konfiguration sind in den einzelnen Hostanwendungen mit identischer Struktur unter addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger usw. strukturierte Überschreibungen pro Host verfügbar:

    {
      ...
      "addOns": {
        ...
        "common": {
          // By default, call 'buildHomePage' to render homepage content
          // in all hosts. Since calendar.homepageTrigger below overrides
          // this in Calendar and Drive and the homepageTrigger is disabled
          // for Gmail, this homepage function never executes.
          "homepageTrigger": { "runFunction": "buildHomePage" }
        },
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "buildDriveHomepage" }
        }
        "gmail": {
          // Disable homepage add-on content in Gmail.
          "homepageTrigger": { "enabled": false }
        },
        ...
      }
    }

Beachten Sie, dass dies dem folgenden Manifestauszug entspricht:

    {
      ...
      "addOns": {
        ...
        "common": { /* ... */ }, // Omitted a default homepageTrigger specification.
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "myCalendarFunction" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "myDriveFunction" }
        }
        "gmail": { /* ... */ },
        ...
      }
    }

Keiner der homepageTrigger-Abschnitte ist erforderlich. Die für ein Add-on in einem Hostprodukt angezeigte UI hängt jedoch davon ab, ob das entsprechende Manifestfeld vorhanden ist und ob ein verknüpftes homepageTrigger vorhanden ist. Das folgende Beispiel zeigt, welche Add-on-Trigger-Funktionen (falls vorhanden) ausgeführt werden, um eine Startseiten-UI für verschiedene Manifestkonfigurationen zu erstellen:

Ablauf auf der Startseite

Ereignisse auf der Startseite

Beim Aufruf wird die oben beschriebene Trigger-Funktion der Startseite (runFunction) an ein Ereignisobjekt übergeben, das Daten aus dem Aufrufkontext enthält.

Startseiten-Ereignisobjekte enthalten keine Widget- oder Kontextinformationen. Die übergebenen Informationen sind auf die folgenden Felder für allgemeine Ereignisobjekte beschränkt:

Weitere Informationen finden Sie unter Ereignisobjekt.

Andere nicht kontextbezogene Karten

Die Add-on-UI kann zusätzliche nicht kontextbezogene Karten enthalten, die keine Startseiten sind. Deine Startseite könnte beispielsweise eine Schaltfläche zum Öffnen der Karte „Einstellungen“ haben, auf der der Nutzer die Add-on-Einstellungen anpassen kann. Solche Einstellungen sind in den meisten Fällen unabhängig vom Kontext und daher nicht kontextbezogen.

Nicht kontextabhängige Karten werden wie alle anderen Karten 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 findest du unter Navigationsmethoden.