Wenn Sie ein neues Google Workspace-Add-on erstellen möchten, folgen Sie dieser allgemeinen Vorgehensweise:
- Projekte des Add-ons einrichten und Inhaber auswählen und Collab-Partner.
- 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 des Add-ons.
- Testen Sie das Add-on im Host-Apps erweitert wird.
- 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 Nutzerkonto, der Eigentümer der Projekte ist, und entscheiden, welche anderen Konten Collab-Partner. 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 das Apps Script Ihres Add-ons erstellen in einer freigegebenen Datei , sodass keine Ein einzelnes Konto besitzt die alleinige Inhaberschaft. Add-on platzieren dass mehrere Mitbearbeiter Zugriff auf des Skriptprojekts.
Wenn Sie ein Add-on veröffentlichen, agiert ein einzelnes Nutzerkonto als Verlag oder Webpublisher. Das veröffentlichende Konto muss Bearbeitungszugriff auf das Skript haben Projektinhaber sein, aber dieser 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 zu den Add-ons Cloud-Projekt. So hat Ihr Team immer Zugriff auf die Cloud-Einstellungen des Add-ons.
Informationen zum Erstellen eines Google Cloud-Projekts finden Sie unter Google Cloud-Projekt erstellen.
Erscheinungsbild und Funktionsweise des Add-ons entwerfen
Entscheiden Sie, wie das Add-on aussehen soll sollte es sich verhalten, bevor Sie mit der Erstellung beginnen. Überlegen Sie, in welchen Anwendungsfällen sollte es Lösungen bieten. 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 ein spezielles JSON-Format, -Datei. Er gibt eine Vielzahl von Details zum Projekt an, z. B. seine Bibliothek. Abhä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 eine kartenbasierte Schnittstelle für die Add-on. Apps Script verwenden Wenn du eine andere Codesprache verwendest, kannst du den Kartendienst JSON richtig formatiert ist, damit die Schnittstelle als Karten dargestellt werden kann.
Außerdem müssen Sie alle Trigger implementieren, Funktionen, die in den des Add-on-Manifests. 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 und füllen sie mit
Widgets. 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
können Sie mit dem Add-on auch neue Karten
auf Nutzeraktionen.
In Apps Script erstellen Sie Karten mithilfe der
Klasse CardBuilder. Jedes
Karte erfordert CardHeader
und mindestens
CardSections Sie sollten
jeden Kartenabschnitt mit den einzelnen Widgets füllen,
Add-on-Oberfläche. Interaktion
Widgets
normalerweise mit Aktionen verknüpft,
ihr Interaktionsverhalten.
Nachdem Sie 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 sollen.
Sie können Daten verwenden, die aus nicht von Google stammenden Diensten abgerufen wurden.
Wenn Ihre Google Workspace-Add-ons Zugriff auf APIs von Drittanbietern benötigen, die OAuth erfordern, haben Sie muss konfiguriert und eine Verbindung zu diesem Dienst hergestellt werden. Weitere Informationen hierzu finden Sie im Abschnitt Verbindung zu Leitfaden für Drittanbieterdienste für erhalten Sie weitere Informationen.
Bauauftrag
Beim Erstellen einer Karte müssen Sie von oben nach oben aufbauen. Das heißt, Sie müssen diese Bauauftrag:
- Erstellen Sie das Widget.
- Fügen Sie das Widget zum Bereich „Karte“ hinzu.
- Wiederholen Sie den Vorgang, bis der Kartenbereich alle Widgets enthält.
- Fügen Sie der Karte den Bereich „Karte“ 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 nicht auf der letzten Karte angezeigt.
Universelle Aktionen
Sie können universelle Aktionen verwenden. um kontextunabhängige Funktionen bereitzustellen. Universelle Aktionen sind Menüelemente die in der Add-on-Benutzeroberfläche verfügbar sind, unabhängig davon, welche Karte angezeigt. Alle definierten universellen Aktionen werden immer in der das Kartenmenü des Add-ons.
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 ist ein Best Practice für Add-ons, dass sie nur Bereiche für Aktionen haben, nur funktionieren, wenn sie funktionieren.
Legen Sie in Add-on-Projekten explizit das Attribut Add-on Umfang, um sicherzustellen, Das Add-on verwendet den Umfang mit der geringsten Berechtigung möglich. 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 unveröffentlichte Add-ons testen, indem Sie zunächst die nicht veröffentlicht Add-on. Nach der Installation und Autorisierung können Sie das Add-on verwenden in Ihrem Konto und testen Sie Darstellung und Verhalten in den Host-Anwendungen, 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. Vor der Veröffentlichung lesen Sie bitte die Publikationsübersicht. 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 im Hilfeartikel Google Workspace-Add-on veröffentlichen für erhalten Sie weitere Informationen.