Websites

Startseiten sind eine neue Funktion für Google Workspace-Add-ons. mit der sich eine oder mehrere nicht kontextbezogene Karten definieren lassen. Nicht kontextbezogene Karten werden verwendet, um eine Benutzeroberfläche anzuzeigen, wenn der Nutzer außerhalb eines bestimmten Kontextes, z. B. wenn der Nutzer seinen Gmail-Posteingang sieht aber keine Nachricht oder einen Entwurf geöffnet hat.

Auf Startseiten können nicht kontextbezogene Inhalte präsentiert werden, Google-Apps in der Seitenleiste für schnellen Zugriff (Google Notizen, Google Kalender und Google Tasks). Startseiten können auch als Einstieg dienen, wenn ein Nutzer Ihr Add-on zum ersten Mal öffnet. Diese sind nützlich für den Unterricht. 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 Projekt angeben Manifest und eine oder mehrere homepageTrigger-Funktionen implementieren (siehe Startseitenkonfiguration).

Sie können mehrere Startseiten haben, eine für jede Hostanwendung, die Ihr Add-on enthält. erweitert. Sie können auch eine einzige allgemeine Standardstartseite definieren, die wird auf Hosts verwendet, bei denen Sie keine benutzerdefinierte Startseite angegeben haben.

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

  • Wann 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. Vom Bearbeiten eines Kalendertermins bis zum Hauptkalender.
  • Wenn Nutzende häufig genug auf die Schaltfläche „Zurück“ klicken, alle anderen Karten aus den internen Stacks herausziehen.
  • Wenn eine Interaktion auf der Benutzeroberfläche auf einer nicht kontextbezogenen Karte zu einer Navigation.popToRoot() aufrufen.

Das Design einer Startseite ist nicht obligatorisch, wird aber dringend empfohlen. Wenn Sie keine angeben, wird eine generische Karte der den Namen Ihres Add-ons enthält, wird immer dann verwendet, zur Startseite.

Konfiguration der Startseite

Für Google Workspace-Add-ons wird die addOns.common.homepageTrigger zum Konfigurieren des standardmäßigen (nicht kontextbezogenen) Add-ons auf der Startseite für alle Host-Anwendungen im Add-on Manifest:

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

  • runFunction: Der Name der Apps Script-Funktion, die vom Das Google Workspace-Add-on-Framework ruft zum Rendern von Add-on-Karten auf der Startseite auf. Diese Funktion ist die Triggerfunktion für die Startseite. Diese Funktion muss und ein Array von Card zurückgeben. -Objekte, aus denen die Startseiten-UI besteht. Wenn mehr als eine Karte zurückgegeben wird, Host-Anwendung zeigt die Karten-Header in einer Liste an, die der Nutzer auswählen kann von (siehe Mehrere Karten zurückgeben.

  • enabled: Gibt an, ob Startseitenkarten für diesen Bereich aktiviert werden sollen. Dieses ist optional und entspricht standardmäßig true. Wenn Sie diesen Wert auf false festlegen, Startseitenkarten, die für alle Hosts deaktiviert werden (sofern für diese nicht überschrieben wird) host; siehe unten).

Neben der allgemeinen Konfiguration gibt es auch identische Überschreibungen pro Host, die in den config, unter addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger, und so weiter:

    {
      ...
      "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. Die für das Projekt eines Add-ons in einem Hostprodukt je nachdem, ob das Add-on entsprechenden Manifest-Feld und ob ein zugehöriges homepageTrigger Das folgende Beispiel zeigt, welche Add-on-Triggerfunktionen werden ausgeführt (falls vorhanden), um eine Startseite für ein anderes Manifest zu erstellen. Konfigurationen:

Ablauf der Startseite

Startseitenereignisobjekte

Wenn die oben beschriebene Triggerfunktion für die Startseite (runFunction) aufgerufen wird, hat ein Ereignisobjekt übergeben. mit Daten aus dem Aufrufkontext.

Startseitenereignisobjekte enthalten keine Widget- oder Kontextinformationen. die ist auf Folgendes beschränkt: Common event Object Felder:

Weitere Informationen finden Sie unter Ereignisobjekt.

Andere nicht kontextbezogene Karten

Ihre Add-on-Benutzeroberfläche kann zusätzliche nicht kontextbezogene Karten enthalten, die nicht Startseiten. Beispiel: Ihre Startseite verfügt über eine Schaltfläche, mit der ein „Einstellungen“ Karte, auf der der Nutzer die Add-on-Einstellungen anpassen kann, z. B. wäre in den meisten Fällen unabhängig vom Kontext und somit nicht kontextbezogen.

Nicht kontextbezogene Karten werden wie jede andere Karte erstellt. ist der einzige Unterschied welche Aktion oder welches Ereignis generiert und die Karte angezeigt wird. Weitere Informationen finden Sie unter Navigationsmethoden finden Sie weitere Informationen zum Erstellen von Übergängen zwischen Karten.