Websites

Startseiten sind eine neue Add-on-Funktion für Google Workspace, mit der Sie eine oder mehrere nicht kontextbezogene Karten definieren können. Nicht kontextbezogene Karten werden verwendet, um eine Benutzeroberfläche anzuzeigen, wenn sich der Nutzer nicht in einem bestimmten Kontext befindet, z. B. wenn er seinen Gmail-Posteingang ansieht, aber keine Nachricht oder einen Entwurf geöffnet hat.

Auf Startseiten können Sie nicht kontextbezogene Inhalte anzeigen, genau wie bei den Google-Apps in der Seitenleiste mit Schnellzugriff (Google Notizen, Google Kalender und Google Tasks). Startseiten können auch als Ausgangspunkt dienen, wenn ein Nutzer das Add-on zum ersten Mal öffnet. Sie sind nützlich, um neuen Nutzern beizubringen, wie sie mit dem 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 Startseitenkonfiguration).

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

Die Startseite Ihres Add-ons wird angezeigt, wenn eine der folgenden Bedingungen erfüllt ist:

  • Wenn das Add-on zum ersten Mal im Host geöffnet wird (nach der Autorisierung).
  • Wenn der Nutzer von einem Kontextkontext zu einem nicht kontextbezogenen Kontext wechselt, während das Add-on geöffnet ist. z. B. vom Bearbeiten eines Kalendertermins zum Hauptkalender.
  • Wenn der Nutzer häufig genug auf die Schaltfläche „Zurück“ klickt, um alle anderen Karten aus den internen Stapeln zu entfernen.
  • Wenn eine UI-Interaktion auf 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 definieren, wird immer dann eine generische Karte mit Ihrem Add-on-Namen verwendet, wenn ein Nutzer die Startseite aufrufen würde.

Startseite konfigurieren

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

    {
      // ...
      "addOns": {
        // ...
        "common": {
          // ...
          "homepageTrigger": {
            "runFunction": "myFunction",
            "enabled": true
          }
        }
      }
    }
  • runFunction: Der Name der Apps Script-Funktion, die vom Google Workspace-Add-ons-Framework zum Rendern der Add-on-Karten auf der Startseite aufgerufen wird. Diese Funktion ist die Triggerfunktion für die Startseite. Diese Funktion muss ein Array von Card-Objekten erstellen und zurückgeben, aus denen die Startseiten-UI besteht. Wenn mehr als eine Karte zurückgegeben wird, zeigt die Hostanwendung 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 gesetzt. Wenn Sie diesen Wert auf false festlegen, werden Startseitenkarten für alle Hosts deaktiviert, sofern sie für diesen Host nicht überschrieben werden (siehe unten).

Neben der gemeinsamen Konfiguration sind in der Konfiguration jeder Hostanwendung unter addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger usw. auch identisch 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 }
        },
        ...
      }
    }

Dies entspricht dem folgenden Manifestauszug:

    {
      ...
      "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. Welche UI für ein Add-on in einem bestimmten Hostprodukt angezeigt wird, hängt jedoch davon ab, ob das entsprechende Manifestfeld vorhanden ist und ob eine homepageTrigger verknüpft ist. Das folgende Beispiel zeigt, welche Add-on-Triggerfunktionen (falls vorhanden) ausgeführt werden, um eine Startseiten-UI für verschiedene Manifestkonfigurationen zu erstellen:

Ablauf auf der Startseite

Objekte auf der Startseite

Beim Aufruf wird der oben beschriebenen Startseiten-Triggerfunktion (runFunction) ein Ereignisobjekt übergeben, das Daten aus dem Aufrufkontext enthält.

Startseitenereignisobjekte enthalten keine Widget- oder Kontextinformationen. Die weitergegebenen Informationen sind auf die folgenden allgemeinen Ereignisobjektfelder beschränkt:

Weitere Informationen finden Sie unter Ereignisobjekt.

Andere nicht kontextbezogene Karten

Die Add-on-UI kann zusätzliche Karten ohne Kontext enthalten, die keine Startseiten sind. Beispielsweise kann Ihre Startseite eine Schaltfläche enthalten, über die die Karte „Einstellungen“ geöffnet wird, über die 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 kontextbezogene Karten werden wie jede andere Karte erstellt. Der einzige Unterschied besteht darin, durch welche Aktion oder welches Ereignis die Karte generiert und angezeigt wird. Weitere Informationen zum Erstellen von Übergängen zwischen Karten finden Sie unter Navigationsmethoden.