Google Workspace-Add-ons erstellen

Hier erfahren Sie, wie Sie Google Workspace-Add‑ons entwerfen, erstellen und veröffentlichen:

  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 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.

Erstellen Sie ein Add-on mit Apps Script oder HTTP. Im Video „Apps Script vs. HTTP endpoints: Which should you choose?“ (Apps Script im Vergleich zu HTTP-Endpunkten: Welche Option sollten Sie wählen?) finden Sie einen Vergleich der beiden Optionen. 🤔“.

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.

Um ein Add-on zu erstellen, müssen Sie sowohl ein Skriptprojekt als auch ein Cloud-Projekt konfigurieren.

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 Ihr Projektdesign an diese Richtlinien anzupassen. Apps Script eignet sich am besten für die einfache Entwicklung persönlicher oder interner Add-ons mit einer kleinen Nutzerbasis. Wenn Ihr Add-on Unterstützung für viele Nutzer, eine niedrige Latenz oder die vollständige Kontrolle über Ihre Infrastruktur erfordert, sollten Sie eine andere Laufzeit in Betracht ziehen.

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

Wenn Sie ein Add-on veröffentlichen, ist ein einzelnes Nutzerkonto der 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

Fügen Sie dem Cloud-Projekt des Add-ons Mitbearbeiter hinzu. So kann Ihr Team jederzeit 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 gestalten und konfigurieren

Legen Sie fest, wie Ihr Add-on aussehen und sich verhalten soll, bevor Sie es entwickeln. Überlegen Sie, welche Anwendungsfälle das Add-on abdeckt. Beginnen Sie mit einem einfachen Design, um erst einmal loslegen zu können, und fügen Sie dann Verbesserungen hinzu.

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

Add-on-Manifest konfigurieren

Implementieren Sie das Design im Add‑on-Manifest. Konfigurieren Sie das Erscheinungsbild und das Verhalten des Add‑ons im Manifest, 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 Code und Funktionen hinzufügen, aktualisieren Sie das Manifest nach Bedarf, um das erforderliche Erscheinungsbild und Verhalten des Add-ons zu definieren.

Darstellung und Verhalten der Google Chat App konfigurieren

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

Add-on erstellen

Implementieren Sie eine kartenbasierte Benutzeroberfläche für das Add-on. Verwenden Sie Card service oder geben Sie, wenn Sie eine andere Programmiersprache verwenden, formatiertes JSON für die Benutzeroberfläche zurück, damit sie als Karten gerendert wird.

Implementieren Sie alle im Add-on-Manifest angegebenen Triggerfunktionen. Wenn Ihr Add-on über OAuth eine Verbindung zu einem Drittanbieterdienst herstellt, konfigurieren Sie OAuth für diesen Dienst.

Karten erstellen

Definieren Sie die Benutzeroberfläche eines Add-ons, indem Sie Card-Objekte erstellen und Widgets hinzufügen. 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. Das Add-on kann auch neue Karten als Reaktion auf Nutzeraktionen erstellen und anzeigen.

Erstellen Sie in Apps Script Karten mit der Klasse CardBuilder. Für jede Karte ist ein CardHeader und mindestens ein CardSections erforderlich. Füllen Sie jeden Kartenabschnitt mit den einzelnen Widgets, aus denen die 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, rufen Sie CardBuilder.build auf, um das entsprechende Card-Objekt zu erstellen.

Verwenden Sie integrierte Apps Script-Dienste](/apps-script/guides/services/) wie CalendarApp, um Informationen abzurufen, die auf den Add-on-Karten angezeigt werden sollen. Daten aus Diensten verwenden, die nicht von Google stammen.

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

Bauauftrag

Beginnen Sie beim Erstellen einer Karte oben. Verwenden Sie diese Reihenfolge:

  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 Kartenbereich hinzu.

Wenn Sie einer Karte oder einem Kartenabschnitt ein Widget hinzufügen, fügen Sie tatsächlich eine Kopie dieses Widgets hinzu. Änderungen, die Sie nach dem Hinzufügen am Widget-Objekt vornehmen, werden nicht auf der endgültigen Karte berücksichtigt.

Universal Actions

Verwenden Sie universelle Aktionen, um kontextunabhängige Funktionen bereitzustellen. Universelle Aktionen sind Menüelemente, die unabhängig von der Karte in der Add-on-Benutzeroberfläche verfügbar sind. Alle definierten universellen Aktionen werden im Kartenmenü des Add-ons angezeigt.

Weitere Informationen finden Sie unter Universelle Aktionen.

OAuth-Bereiche des Add-ons überprüfen

Bereiche definieren die Aktionen, die das Add-on im Namen eines Nutzers ausführen kann. Add-ons sollten nur die Bereiche haben, die für ihre Funktion erforderlich sind.

Legen Sie in Add-on-Projekten die Add-on-Bereiche fest, damit das Add-on die am wenigsten restriktiven Bereiche verwendet, die möglich sind. Definieren Sie die 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, um sein Aussehen und Verhalten in den gehosteten Anwendungen zu testen, die es erweitert. Prüfen Sie, ob sich das Add-on in verschiedenen Kontexten und bei 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, können andere Nutzer darauf zugreifen. Bevor Sie die Publikation veröffentlichen, sollten Sie die Veröffentlichungen – Übersicht lesen. Die Veröffentlichung ist ein komplexer Prozess, der Vorbereitung erfordert.

Google Workspace-Add‑ons werden im Google Workspace Marketplace veröffentlicht. Öffentlich verfügbare Add-ons müssen vor der Veröffentlichung überprüft werden.

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