Wenn Sie ein neues Google Workspace-Add-on erstellen möchten, folgen Sie dieser allgemeinen Vorgehensweise:
- Richten Sie die Projekte Ihres Add-ons ein und wählen Sie einen Inhaber und Mitbearbeiter aus.
- Gestalten Sie das Erscheinungsbild und das Verhalten des Add-ons.
- Konfigurieren Sie das Projektmanifest des Add-ons oder Bereitstellungsressource.
- Schreiben Sie Code, um das Erscheinungsbild des Add-ons und verhalten.
- Prüfen Sie die OAuth-Bereiche Ihres Add-ons.
- Testen Sie das Add-on in den Hostanwendungen, die es erweitert.
- Veröffentlichen Sie das Add-on.
Projekte des Add-ons einrichten und einen 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 das Add-on in einer anderen Sprache als Apps Script müssen Sie nur ein Google Cloud-Projekt erstellen.
Bevor Sie mit der Entwicklung des Add-ons beginnen, wählen Sie ein einzelnes Nutzerkonto aus, das Inhaber der Projekte sein soll, und legen Sie fest, welche anderen Konten Mitbearbeiter sind. Der Inhaber der Projekte erstellt und verwaltet die Projektdateien. und die zugehörigen Einstellungen, während Mitbearbeiter Sie beim Programmieren und Testen unterstützen können.
Apps Script-Projekte
Sie können die Apps Script-Projektdateien Ihres Add-ons in einem freigegebenen Drive-Ordner erstellen, damit kein einzelnes Konto die alleinige Inhaberschaft hat. Add-on platzieren dass mehrere Mitbearbeiter Zugriff auf des Skriptprojekts.
Wenn Sie ein Add-on veröffentlichen, fungiert ein einzelnes Nutzerkonto als Publisher. Das veröffentlichende Konto muss Bearbeitungszugriff auf das Skript haben Projektinhaber sein, aber sie muss nicht der Inhaber sein.
Informationen zum Erstellen eines Apps Script-Projekts finden Sie unter Script-Projekte.
Google Cloud-Projekte
Wir empfehlen Ihnen, Mitbearbeiter hinzuzufügen zum Add-ons Cloud-Projekt. So hat Ihr Team immer Zugriff auf die Cloud-Einstellungen des Add-ons.
Weitere Informationen zum Erstellen eines Google Cloud-Projekts finden Sie unter Google Cloud-Projekt erstellen.
Design und Verhalten des Add-ons festlegen
Entscheiden Sie, wie das Add-on aussehen soll sollte es sich verhalten, bevor Sie mit der Erstellung beginnen. Überlegen Sie, für welche Anwendungsfälle das Add-on Lösungen bieten soll. Start mit einem einfachen Design, um erst loszulegen, dann weitere Optimierungen vornehmen.
Weitere Informationen finden Sie im Styleguide für Google Workspace-Add-ons. finden Sie Richtlinien zum Entwerfen der Nutzerfreundlichkeit von Add-ons. Nutzererfahrung.
Manifest des Add-on-Projekts konfigurieren
In Apps Script-Projekten ist das Projektmanifest eine spezielle JSON-Datei. Es enthält eine Vielzahl von Details zum Projekt, z. B. die Bibliotheksabhängigkeiten. Für Google Workspace-Add-ons enthält das Manifest auch die grundlegenden Informationen, die die Host-Anwendung benötigt, Add-on korrekt eingerichtet haben.
Unter Manifeste finden Sie ausführliche Informationen zur Konfiguration des des Add-ons in Apps Script.
Wenn Sie dem Add-on Code und Funktionen hinzufügen, bearbeiten Sie die Manifest, um das erforderliche Add-on zu erstellen. Erscheinungsbild und Verhalten.
Add-on programmieren
Sie müssen für das Add-on eine Kartenoberfläche implementieren. Verwenden Sie den Kartendienst von Apps Script oder geben Sie, wenn Sie in einer anderen Programmiersprache schreiben, korrekt formatierte JSON-Daten zurück, damit die Benutzeroberfläche sie als Karten rendern kann.
Außerdem müssen Sie alle im Add-on-Manifest angegebenen Triggerfunktionen implementieren. Wenn Ihr Das Add-on wird mit einem Drittanbieterdienst verbunden, der nicht von Google stammt. müssen Sie OAuth dafür konfigurieren. ebenfalls.
Karten erstellen
Sie definieren die Benutzeroberfläche eines Add-ons, indem Sie Card-Objekte erstellen und mit Widgets füllen. Triggerfunktionen, die angegeben sind in
muss Ihr Manifest entweder
Card-Objekt oder ein Array von
Card-Objekte, die für
verschiedene „Seiten“ der Add-on-Oberfläche. Ihr Add-on kann auch neue Karten erstellen und anzeigen, wenn Nutzeraktionen ausgeführt werden.
In Apps Script erstellen Sie Karten mithilfe der
Klasse CardBuilder. Für jede Karte ist eine CardHeader und eine oder mehrere CardSections erforderlich. Sie sollten
jeden Kartenabschnitt mit den einzelnen Widgets füllen,
Add-on-Oberfläche. Interaktions-Widgets sind in der Regel mit Aktionen verknüpft, um ihr Interaktionsverhalten zu definieren.
Nachdem Sie Ihrer Karte alle Abschnitte und Widgets über die
CardBuilder, Sie müssen
CardBuilder.build()
um das entsprechende Card-Objekt zu erstellen.
Sie können andere integrierte Apps Script-
Dienste wie
CalendarApp zum Abrufen
Informationen, die auf den von Ihnen erstellten Add-on-Karten angezeigt werden.
Sie können Daten verwenden, die aus nicht von Google stammenden Diensten abgerufen wurden.
Wenn das Add-on Zugriff auf APIs von Drittanbietern benötigt, die OAuth erfordern, müssen Sie diesen Dienst konfigurieren und eine Verbindung dazu herstellen. Weitere Informationen finden Sie auf der Leitfaden zum Herstellen einer Verbindung mit Diensten von Drittanbietern .
Bauauftrag
Beim Erstellen einer Karte müssen Sie von oben nach unten vorgehen. Das heißt, Sie müssen diese Bauauftrag:
- Erstellen Sie das Widget.
- Füge das Widget zum Bereich „Karte“ hinzu.
- Wiederholen Sie diesen Schritt, bis der Kartenbereich alle Widgets enthält.
- Fügen Sie der Karte den Kartenabschnitt hinzu.
Dies ist erforderlich, denn beim Hinzufügen eines Widgets zu einer Karte oder einem Kartenbereich eine Kopie dieses Widgets hinzufügen. Alle Änderungen, die Sie am Widget vornehmen nach dem Hinzufügen noch nicht auf der letzten Karte angezeigt.
Universelle Aktionen
Mit universellen Aktionen können Sie kontextunabhängige Funktionen bereitstellen. Universelle Aktionen sind Menüpunkte, 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. Details.
OAuth-Bereiche des Add-ons prüfen
Bereiche definieren, welche Aktionen das Add-on im Namen eines Nutzers übernehmen darf. Es wird empfohlen, dass Add-ons nur Berechtigungen für Aktionen haben, die für ihre Funktion erforderlich sind.
Legen Sie in Add-on-Projekten die Berechtigungen für das Add-on explizit fest, damit es nur die striktesten Berechtigungen verwendet. Sie legen fest, in welchen Bereichen das Add-on verwendet wird das Add-on Manifest herunter.
Weitere Informationen finden Sie unter Bereiche.
Add-on testen
Sie können nicht veröffentlichte Add-ons testen, indem Sie zuerst die nicht veröffentlicht Add-on. 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 wie für Kontexte und Nutzeraktionen.
Weitere Informationen finden Sie unter Google Workspace-Add-ons testen.
Add-on veröffentlichen
Wenn Sie Ihr Add-on veröffentlichen, ist es für andere Nutzer verfügbar. entweder öffentlich oder nur für Nutzer in Ihrer Domain. Lesen Sie sich die Übersicht zur Veröffentlichung durch, bevor Sie mit dem Vorgang beginnen. Die Veröffentlichung ist ein komplexer Prozess, Vorbereitung und Zeit für die Durchführung.
Google Workspace-Add-ons werden im Google Workspace Marketplace veröffentlicht. Öffentlich verfügbar Add-ons müssen eine App-Überprüfung durchlaufen, bevor wenn sie veröffentlicht werden.
Weitere Informationen finden Sie unter Google Workspace-Add-on veröffentlichen.