Google Workspace-Add-ons erstellen

Auf dieser Seite finden Sie einen Überblick über das Design, die Entwicklung und die Veröffentlichung von Google Workspace-Add-ons. In dieser Übersicht werden die folgenden Schritte erläutert:

  1. Legen Sie fest, in welchen Google Workspace-Anwendungen Ihr Add-on für Nutzer verfügbar sein soll.
  2. Richten Sie die Projekte Ihres Add-ons ein und wählen Sie einen Inhaber und Mitbearbeiter aus.
  3. Gestalten und konfigurieren Sie das Erscheinungsbild und das Verhalten Ihres Add-ons.
  4. Erstellen Sie das Add-on.
  5. Prüfen Sie die OAuth-Bereiche Ihres Add-ons.
  6. Testen Sie das Add‑on in einer oder mehreren Google Workspace-Anwendungen.
  7. Veröffentlichen Sie das Add-on.

Sie können ein Add-on mit Apps Script oder HTTP erstellen. Einen Vergleich finden Sie im Video „Apps Script vs. HTTP endpoints: Which should you choose? 🤔“.

Google Workspace-Hostanwendungen auswählen

Sie können Google Workspace-Add‑ons so konfigurieren, dass sie in den folgenden Google Workspace-Hostanwendungen angezeigt werden:

  • Gmail
  • Google Kalender
  • Google Chat
  • Google Docs
  • Google Drive
  • Google Meet
  • Google Sheets
  • Google Präsentationen

Informationen zum Entwickeln für Google Workspace-Anwendungen finden Sie unter Google Workspace-Benutzeroberfläche erweitern.

Projekte für das Add-on einrichten und Inhaber und Mitbearbeiter auswählen

Wenn Sie Ihr Add-on in Apps Script erstellen, erstellen Sie sowohl ein Apps Script-Projekt als auch ein Google Cloud-Projekt. Wenn Sie Ihr Add-on in einer anderen Sprache als Apps Script entwickeln, müssen Sie nur ein Google Cloud-Projekt erstellen.

Bevor Sie mit der Add-on-Entwicklung beginnen, sollten Sie ein einzelnes Nutzerkonto auswählen, das die Projekte besitzt, und festlegen, welche anderen Konten Mitbearbeiter sind. Der Inhaber der Projekte erstellt und verwaltet die Projektdateien und die zugehörigen Einstellungen, während Mitbearbeiter beim Programmieren und Testen helfen können.

Apps Script-Projekte

Bevor Sie Ihr Add-on erstellen, sollten Sie sich die Apps Script-Kontingente und -Einschränkungen ansehen, um sicherzustellen, dass Ihr Projektdesign diesen Richtlinien entspricht. Apps Script eignet sich am besten für die einfache Entwicklung persönlicher oder interner Add-ons mit einer kleinen Nutzerbasis. Wenn Sie ein Add-on in großem Maßstab entwickeln möchten, das viele Nutzer verarbeiten muss, eine geringe Latenz erfordert oder volle Kontrolle über Ihre Infrastruktur erfordert, sollten Sie die Entwicklung in einer anderen Laufzeitumgebung in Betracht ziehen.

Sie können die Apps Script-Projektdateien Ihres Add-ons in einer geteilten Ablage erstellen, damit kein einzelnes Konto das alleinige Eigentum hat. Wenn Sie die Add-on-Scriptdatei in einer geteilten Ablage speichern, haben mehrere Mitbearbeiter Zugriff auf das Scriptprojekt.

Wenn Sie ein Add-on veröffentlichen, fungiert ein einzelnes Nutzerkonto als Publisher. Das Veröffentlichungskonto muss Bearbeitungszugriff auf das Scriptprojekt haben, muss aber nicht der Inhaber sein.

Informationen zum Erstellen eines Apps Script-Projekts finden Sie unter Scriptprojekte.

Google Cloud-Projekte

Wir empfehlen, Mitarbeiter zum Cloud-Projekt des Add-ons hinzuzufügen. So kann immer jemand aus Ihrem Team auf die Cloud-Einstellungen des Add-ons zugreifen.

Informationen zum Erstellen eines Google Cloud-Projekts finden Sie unter Google Cloud-Projekt erstellen.

Darstellung und Verhalten des Add-ons entwerfen und konfigurieren

Bevor Sie mit der Entwicklung beginnen, sollten Sie sich überlegen, wie Ihr Add-on aussehen und sich verhalten soll. Überlegen Sie, für welche Anwendungsfälle das Add-on Lösungen bieten soll. Beginnen Sie mit einem einfachen Design, um erst einmal loslegen zu können, und fügen Sie dann weitere Verbesserungen hinzu.

Im Google Workspace-Add-on-Styleguide finden Sie Richtlinien zum Design der Benutzeroberfläche Ihres Add-ons.

Add-on-Manifest konfigurieren

Nachdem Sie Ihr Add‑on entworfen haben, können Sie das Design im Add‑on-Manifest implementieren. Im Manifest konfigurieren Sie das Erscheinungsbild und das Verhalten des Add-ons, einschließlich der Google Workspace-Hostanwendungen, die das Add-on erweitert.

Weitere Informationen finden Sie unter Manifeste für Google Workspace-Add-ons.

Wenn Sie Ihrem Add-on Code und Funktionen hinzufügen, bearbeiten Sie das Manifest nach Bedarf, um das gewünschte Aussehen und Verhalten des Add-ons zu erzielen.

Darstellung und Verhalten der Google Chat App konfigurieren

Wenn Sie ein Add‑on entwickelt haben, das Google Chat erweitert, müssen Sie die Google Chat API verwenden, um das Erscheinungsbild und das Verhalten einer Chat-App zu konfigurieren. Eine Anleitung finden Sie unter Google Chat-App konfigurieren.

Add-on erstellen

Sie müssen eine kartenbasierte Benutzeroberfläche für das Add-on implementieren. Verwenden Sie den Card-Dienst von Apps Script oder geben Sie, wenn Sie in einer anderen Programmiersprache schreiben, korrekt formatierten JSON-Code zurück, damit die Benutzeroberfläche als Karten gerendert wird.

Sie müssen auch alle im Add-on-Manifest angegebenen Triggerfunktionen implementieren. Wenn Ihr Add-on über OAuth eine Verbindung zu einem Drittanbieterdienst herstellt, der nicht von Google stammt, müssen Sie auch OAuth für diesen Dienst konfigurieren.

Karten erstellen

Sie definieren die Benutzeroberfläche eines Add-ons, indem Sie Card-Objekte erstellen und sie mit Widgets füllen. Triggerfunktionen, die in Ihrem Manifest angegeben sind, müssen entweder ein einzelnes Card-Objekt oder ein Array von Card-Objekten zurückgeben, die verschiedene „Seiten“ der Add-on-Benutzeroberfläche darstellen. Ihr Add-on kann auch als Reaktion auf Nutzeraktionen neue Karten erstellen und anzeigen.

In Apps Script erstellen Sie Karten mit der Klasse CardBuilder. Für jede Karte ist ein CardHeader und mindestens ein CardSections erforderlich. Sie sollten jeden Kartenabschnitt mit den einzelnen Widgets füllen, aus denen die Add-on-Benutzeroberfläche besteht. Interaktions-Widgets sind in der Regel mit Aktionen verknüpft, um ihr Interaktionsverhalten zu definieren.

Nachdem Sie alle Abschnitte und Widgets über die CardBuilder der Karte hinzugefügt haben, müssen Sie CardBuilder.build() aufrufen, um das entsprechende Card-Objekt zu erstellen.

Sie können andere integrierte Apps Script-Dienste wie CalendarApp verwenden, um Informationen abzurufen, die auf den Add-on-Karten angezeigt werden sollen. Sie können Daten verwenden, die von Nicht-Google-Diensten abgerufen werden.

Wenn Ihr Add-on Zugriff auf Nicht-Google-APIs benötigt, für die OAuth erforderlich ist, müssen Sie diesen Dienst konfigurieren und eine Verbindung zu ihm herstellen. Weitere Informationen finden Sie im Leitfaden zum Herstellen einer Verbindung zu Nicht-Google-Diensten.

Bauauftrag

Beim Erstellen einer Karte müssen Sie von oben nach unten vorgehen. Das heißt, Sie müssen die folgende Reihenfolge einhalten:

  1. Erstellen Sie das Widget.
  2. Fügen Sie das Widget dem Kartenbereich hinzu.
  3. Wiederholen Sie den Vorgang, bis der Kartenbereich alle seine Widgets enthält.
  4. Fügen Sie der Karte den Kartenabschnitt hinzu.

Das ist erforderlich, weil Sie beim Hinzufügen eines Widgets zu einer Karte oder einem Kartenabschnitt tatsächlich eine Kopie dieses Widgets hinzufügen. Änderungen, die Sie nach dem Hinzufügen am Widget-Objekt vornehmen, werden nicht auf der endgültigen Karte berücksichtigt.

Universal Actions

Mit universellen Aktionen können Sie kontextunabhängige Funktionen bereitstellen. Universelle Aktionen sind Menüelemente, die unabhängig von der angezeigten Karte in der Add-on-Benutzeroberfläche verfügbar sind. Alle definierten universellen Aktionen werden immer im Kartenmenü des Add-ons angezeigt.

Weitere Informationen finden Sie unter Universelle Aktionen.

OAuth-Bereiche des Add-ons überprüfen

Bereiche definieren, welche Aktionen das Add-on im Namen eines Nutzers ausführen darf. Es ist eine Best Practice für Add-ons, nur Bereiche für Aktionen zu haben, die für die Funktion erforderlich sind, und nichts weiter.

In Add-on-Projekten müssen Sie die Add-on-Bereiche explizit festlegen, damit das Add-on die restriktivsten möglichen Bereiche verwendet. Sie definieren die von Ihrem Add-on verwendeten Bereiche im Manifest des Add-ons.

Weitere Informationen finden Sie unter Bereiche.

Add-on testen

Sie können nicht veröffentlichte Add-ons testen, indem Sie sie zuerst installieren. Nach der Installation und Autorisierung können Sie das Add-on in Ihrem Konto verwenden und sein Aussehen und Verhalten in den Hostanwendungen testen, die es erweitert. Sie sollten prüfen, ob sich das Add-on in verschiedenen Kontexten und bei verschiedenen Nutzeraktionen wie erwartet verhält.

Informationen zum Testen Ihres Add-ons finden Sie in den folgenden Anleitungen:

Add-on veröffentlichen

Wenn Sie Ihr Add-on veröffentlichen, ist es für andere verfügbar, entweder öffentlich oder nur für Nutzer in Ihrer Domain. Bevor Sie mit der Veröffentlichung beginnen, sollten Sie sich die Übersicht über die Veröffentlichung ansehen. Die Veröffentlichung ist ein komplexer Prozess, der Vorbereitung und Zeit erfordert.

Google Workspace-Add-ons werden im Google Workspace Marketplace veröffentlicht. Öffentlich verfügbare Add-ons müssen vor der Veröffentlichung eine App-Überprüfung durchlaufen.

Weitere Informationen zum Veröffentlichen von Google Workspace-Add-ons