Auf dieser Seite wird beschrieben, wie Sie das Google Workspace Marketplace SDK verwenden, um Ihre App im Google Workspace Marketplace zu konfigurieren und zu verwalten.
Damit Ihre App verwendet werden kann, müssen Sie sie im Marketplace SDK einrichten. Das Marketplace SDK ist ein Toolkit, mit dem Sie Ihre App auf dem Marketplace erstellen und verwalten können. Mit dem Marketplace SDK können Sie Marketplace-Einstellungen verwalten, z. B.:
- Ob Ihre App für eine bestimmte Google Workspace-Organisation (eine private App) oder für alle Marketplace-Nutzer (eine öffentliche App) verfügbar ist
- Die Arten von Marketplace-Nutzern, die Ihre App installieren können
- Mit welchen Google Workspace-Anwendungen Ihre App verknüpft wird
- Die von Ihrer App benötigten OAuth-Bereiche
- Informationen dazu, wer die App entwickelt und gewartet hat
Unabhängig davon, ob Sie Ihre App privat oder öffentlich veröffentlichen, müssen Sie das Marketplace SDK verwenden, um Ihre App im Marketplace zu verwalten.
Marketplace SDK aktivieren
Aktivieren Sie das Marketplace SDK in Ihrem Google Cloud-Projekt, falls noch nicht geschehen.
Cloud-Projekt in der Google Cloud Console öffnen
Öffnen Sie das Cloud-Projekt, das Sie für dieses Beispiel verwenden möchten, falls es noch nicht geöffnet ist:
- Rufen Sie in der Google Cloud Console die Seite Projekt auswählen auf.
- Wählen Sie das Google Cloud-Projekt aus, das Sie verwenden möchten. Klicken Sie alternativ auf Projekt erstellen und folgen Sie der Anleitung auf dem Bildschirm. Wenn Sie ein Google Cloud-Projekt erstellen, müssen Sie möglicherweise die Abrechnung für das Projekt aktivieren.
Marketplace SDK aktivieren
Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren. Sie können eine oder mehrere APIs in einem einzelnen Google Cloud-Projekt aktivieren.Aktivieren Sie in der Google Cloud Console das Google Workspace Marketplace SDK.
Konfigurationseinstellungen für Ihre App festlegen
In der folgenden Referenz werden die Einstellungen beschrieben, die auf der Seite App-Konfiguration des Marketplace SDK verfügbar sind.
Auswählen, wer Ihre App sehen und installieren kann
Wenn Sie Ihre App konfigurieren, geben Sie mit den folgenden Einstellungen die Nutzer an, die auf Ihre App zugreifen können:
- Sichtbarkeit der App: Wenn Sie eine App in einer Google Workspace-Organisation veröffentlichen, können Sie festlegen, ob Ihr App-Eintrag nicht aufgeführt, für alle Nutzer in Ihrer Organisation oder für alle Nutzer von Google Workspace sichtbar sein soll.
- Installationseinstellungen: Gibt an, ob die App nur von Google Workspace-Administratoren installiert werden kann.
Unabhängig von den Einstellungen, die Sie in Ihrem App-Eintrag angeben, können Nutzer, die zu einer Google Workspace-Organisation gehören, Ihre App möglicherweise nicht finden, installieren oder verwenden, je nach den Einstellungen, die von ihren Administratoren festgelegt wurden. Administratoren können die Verfügbarkeit Ihrer App auf folgende Weise beeinflussen:
- Sie können festlegen, ob ihre Nutzer Apps im Marketplace sehen und Apps in ihrem Namen installieren dürfen.
- Mit einer Zulassungsliste können Sie Apps für Ihre Organisation verwalten und kuratieren. Wenn Sie eine App für eine Organisation entwickeln, die Zulassungslisten verwendet, fragen Sie einen Administrator, ob die App auf die Zulassungsliste gesetzt werden kann.
- Bestimmte Google Workspace-Anwendungen deaktivieren, z. B. den Zugriff auf Google Chat, Google Chat-Apps oder beides entfernen. In diesen Fällen können Nutzer Ihre App nicht über den Marketplace installieren.
Sichtbarkeitseinstellungen für Apps
Die Option Sichtbarkeit der App wird angezeigt, wenn Sie ein Google Workspace-Konto verwenden, das von Ihrem Arbeitgeber oder Ihrer Bildungseinrichtung erstellt wurde. Wenn Sie ein Privatnutzerkonto verwenden (ein Konto, das auf „@gmail.com“ endet), können Sie nur öffentlich veröffentlichen.
- Öffentlich: Die App kann von Personen außerhalb Ihrer Domain gefunden und installiert werden. Wenn Sie die öffentliche Sichtbarkeit auswählen, überprüft und genehmigt Google Ihren App-Eintrag, bevor er veröffentlicht wird.
- Privat: Nur Personen in Ihrer Domain können Ihre App finden und installieren.
Wenn Sie die Option Nicht gelistet auswählen, wird der App-Eintrag nicht in den Browser- oder Suchergebnissen angezeigt. Nutzer können nur über die direkte URL auf die Store-Seite der App zugreifen.
Wenn Sie einschränken möchten, in welchen Ländern und Regionen Ihre App verfügbar ist, können Sie das beim Erstellen des Store-Eintrags im Bereich Vertrieb festlegen.
Einstellungen für die App-Installation
Mit der Option Installationseinstellungen wird festgelegt, ob Nutzer oder Google Workspace-Administratoren Ihre App über Ihre Store-Eintragsseite im Marketplace installieren können.
- Einzelinstallation und Installation durch Administrator (Standard): Die App kann von einzelnen Nutzern oder von Administratoren für ihre Domain, Organisationseinheit oder eine Gruppe von Nutzern installiert werden. Die Domainrichtlinien eines Nutzers können die Installation einer App verhindern, auch wenn einzelne Installationen aktiviert sind.
- Nur Administratorinstallation: Die App kann nur von Administratoren für ihre Domain, Organisationseinheit oder eine Gruppe von Nutzern installiert werden. Ihre App wird nur in den Google Workspace Marketplace-Suchergebnissen für Administratoren und Personen angezeigt, die nicht in ihrem Google-Konto angemeldet sind. Wählen Sie diese Option aus, wenn für Ihre App eine Domaininstallation erforderlich ist.
Allgemeine Installations- und Sichtbarkeitseinstellungen
In der folgenden Tabelle sind einige der gängigen App-Konfigurationsoptionen für die Installation und Sichtbarkeit zusammengefasst:
| Vorgesehene App-Nutzer | Einstellung für die Sichtbarkeit der App | Einstellung App-Installation | Wer kann meine App installieren? | Wer kann meine App verwenden? | |
|---|---|---|---|---|---|
| Für Apps, die für eine Google Workspace-Organisation entwickelt wurden | |||||
| Bestimmte Nutzer in Ihrer Organisation | Privat und Nicht gelistet | Einzelinstallation und Installation durch Administrator | Falls zulässig, alle Nutzer in Ihrer Organisation, die die URL des App-Eintrags haben. | Falls zulässig, alle Nutzer in Ihrer Organisation, die die URL des App-Eintrags haben. | |
| Meine Organisation | Privat | Einzelinstallation und Installation durch Administrator | Falls zulässig, jede Person in Ihrer Organisation. | Falls zulässig, jede Person in Ihrer Organisation. | |
| Meine Organisation | Privat | Nur Administratoren | Administratoren | Nutzer, die die App von ihrem Administrator installiert haben. | |
| Für Apps, die Nutzern außerhalb einer bestimmten Google Workspace-Organisation zur Verfügung stehen | |||||
| Nutzer in Google Workspace-Organisationen | Öffentlich | Nur Administratoren | Administratoren | Nutzer, die die App von ihrem Administrator installiert haben. | |
| Alle Google Workspace-Nutzenden | Öffentlich | Einzelinstallation und Installation durch Administrator |
|
|
|
Ermitteln, wie Ihre App in Google Workspace-Anwendungen eingebunden wird
Mit der Option App-Integrationen können Sie die Google Workspace-Dienste auswählen, mit denen Ihre App oder Ihr Add‑on verwendet werden soll, z. B. ein Google Workspace-Add‑on oder eine Google Chat-App. Sie müssen mindestens eine Option auswählen. In einigen Fällen können Sie mehrere App-Integrationen in Ihren App-Eintrag aufnehmen. Weitere Informationen finden Sie unter App-Integrationen zusammen auflisten.
Für jedes Google Workspace-Add‑on wird auf der Seite der veröffentlichte Status für jedes unterstützte Hostprodukt angezeigt. So können Sie nachvollziehen, welche Integrationen Ihren Nutzern zur Verfügung stehen. Folgende Status der App-Integration sind möglich:
Unsaved: Sie haben eine Integration hinzugefügt oder geändert, die Änderungen aber nicht auf dem Tab „App-Konfiguration“ gespeichert.Draft: Ihre Änderungen wurden gespeichert, aber noch nicht veröffentlicht.Under review: Sie haben Ihre aktualisierte App-Integration zur Überprüfung eingereicht.Published: Ihre App-Integration ist im Marketplace-Eintrag enthalten.
Je nachdem, welche App-Integrationen Sie auswählen, müssen Sie möglicherweise weitere Informationen angeben und relevante APIs in Ihrem Google Cloud-Projekt aktivieren. In der folgenden Tabelle wird die zusätzliche Einrichtung beschrieben, die für die einzelnen Optionen erforderlich ist:
Google Workspace-Add‑on
Wenn Sie ein Google Workspace-Add‑on veröffentlichen möchten, müssen Sie die Bereitstellungs-ID des Add‑ons angeben.
So finden Sie die Bereitstellungs-ID in Apps Script:
- Öffnen Sie Ihr Google Workspace-Add‑on im Apps Script-Editor.
- Klicken Sie auf Bereitstellen > Bereitstellungen verwalten.
- Klicken Sie unter der Bereitstellungs-ID auf Kopieren.
So finden Sie die Bereitstellungs-ID für ein HTTP-Add-on:
- Klicken Sie auf der Seite „App-Konfiguration“ unter „Google Workspace-Add-on“ auf HTTP- oder andere Bereitstellungen> Bereitstellung auswählen.
- Wählen Sie die Bereitstellung aus, die Sie veröffentlichen möchten.
- Klicken Sie auf Auswählen.
Editor-Add-on (Google Docs, Google Sheets, Google Präsentationen, Google Formulare)
Wenn Sie ein Editor-Add-on veröffentlichen möchten, müssen Sie die Projekt-Script-ID und die Version angeben, die Sie veröffentlichen möchten.
So finden Sie die Projekt-Script-ID:
- Öffnen Sie das Add-on im Apps Script-Editor.
- Klicken Sie links auf Projekteinstellungen .
- Kopieren Sie unter „IDs“ die Script-ID.
So finden Sie die Version:
- Öffnen Sie das Add-on im Apps Script-Editor.
- Klicken Sie rechts oben auf Bereitstellen> Bereitstellungen verwalten.
- Die Versionsnummer finden Sie unter „Konfiguration“.
Google Chat App
Informationen zum Veröffentlichen einer interaktiven Google Chat-App finden Sie in der folgenden Dokumentation:
- Wenn Sie Ihre Chat-App als Add‑on erstellt haben, müssen Sie die Add‑on-Einstellungen in der Chat API konfigurieren. Eine Anleitung finden Sie in der Google Workspace-Add‑on-Dokumentation unter Chat-App konfigurieren.
- Wenn Sie Ihre Chat-App mit Interaktionsereignissen erstellt haben, müssen Sie die Einstellungen für Interaktionsereignisse in der Chat API konfigurieren. Eine Anleitung finden Sie in der Chat API-Dokumentation unter Interaktionsereignisse empfangen und darauf reagieren.
- Wenn Sie Ihre Chat-App mit der automatischen Konfiguration von AppSheet erstellt haben, veröffentlichen Sie sie gemäß der Anleitung in der AppSheet-Dokumentation unter Chat-App mit automatischer Konfiguration freigeben.
Drive-App
Wenn Sie eine Drive-App veröffentlichen möchten, müssen Sie die Google Drive API aktivieren und konfigurieren.
Web-App
Wenn Sie eine Webanwendung veröffentlichen möchten, müssen Sie die universelle Navigations-URL angeben. Das ist die URL, die im Google-Apps-Menü auf die Webanwendung verweist. Ihre Web-App muss in der Produktion sein und voll funktionsfähig sein.
Wenn Sie die Seite „Store-Eintrag“ ausfüllen, müssen Sie zusätzliche Symbole mit einer Größe von 96 × 96 und 48 × 48 Pixeln angeben.
Wenn Sie Ihre Web-App in Apps Script erstellt haben, gehen Sie so vor, um die URL der universellen Navigationsleiste zu erhalten:
- Öffnen Sie Ihr Google Workspace-Add‑on im Apps Script-Editor.
- Klicken Sie auf Bereitstellen > Neues Deployment.
- Klicken Sie unter „Typ auswählen“ auf Web-App.
- Füllen Sie die Optionen aus und klicken Sie auf Bereitstellen.
- Klicken Sie auf Kopieren.
Zugriffsebene für Ihre App angeben
Geben Sie unter OAuth-Bereiche eine vollständige Liste der OAuth 2.0-Bereiche an, die für Ihre App erforderlich sind. Die hier eingegebenen OAuth-Bereiche müssen mit den Bereichen übereinstimmen, die Sie auf Ihrem OAuth-Zustimmungsbildschirm und gegebenenfalls im Apps Script-Manifest anzeigen.
Wenn Sie mehr als eine App-Integration einbinden, müssen Sie die Bereiche jeder Integration auf der Seite „Marketplace SDK App Configuration“ und in Ihrem OAuth-Zustimmungsbildschirm hinzufügen.
Verwenden Sie immer die kleinstmöglichen Bereiche. Nehmen Sie beispielsweise nicht den vollständigen Drive-Bereich auf, wenn Sie nur einen schreibgeschützten Bereich benötigen.
Weitere Informationen zu Apps Script-Projekten finden Sie unter Autorisierungsbereiche.
Informationen zum App-Entwickler angeben
Geben Sie unter Entwicklerinformationen Kontaktdaten und andere Details ein. Diese Felder werden auf der Seite Store-Eintrag Ihrer App angezeigt.
| Felder | |
|---|---|
| Händlerstatus |
Aufgrund von Verbraucherschutzgesetzen müssen Verbraucher mit Wohnsitz im Europäischen Wirtschaftsraum (EWR) darüber informiert werden, ob ein Händler auf dem Marktplatz ein Händler oder ein Nicht-Händler ist:
Wenn Sie keine Angaben machen, wird auf der Seite Store-Eintrag Ihrer App „Händlerstatus nicht angegeben“ angezeigt. |
| Name des Entwicklers | Der Name, der als Autor der App angezeigt werden soll. Wenn Sie ein Händler sind, geben Sie Ihren Firmennamen oder rechtsgültigen Namen an. |
| Postanschrift des Entwicklers |
Erforderlich für Händler. Wird nicht für Nutzer ohne Händlerkonto erhoben. Der Standort Ihres Unternehmens. Geben Sie eine gültige Postanschrift ein, unter der Sie erreichbar sind. |
| URL der Entwicklerwebsite | Die Website, auf der Sie (oder Ihre Organisation) als Entwickler beschrieben werden. |
| E‑Mail-Adresse des Entwicklers |
Die E-Mail-Adresse, die als Kontaktpunkt verwendet werden soll. Sie ist nicht in Ihrem App-Eintrag enthalten. Achten Sie darauf, dass diese E‑Mail-Adresse immer aktuell ist, da sie für Folgendes verwendet wird:
|
| URL der Anwendungswebsite | Optional. Die Website, auf der Ihre App genauer beschrieben wird. |
App-Konfigurationseinstellungen im Marketplace SDK speichern
Speichern Sie die App-Konfiguration im Marketplace SDK. Verwenden Sie dazu die Informationen aus dem vorherigen Abschnitt:
Rufen Sie in der Google Cloud Console die Seite App-Konfiguration des Marketplace SDK auf:
Füllen Sie die einzelnen Abschnitte basierend auf den Informationen aus, die Sie im vorherigen Abschnitt ermittelt haben.
Klicken Sie auf Entwurf speichern.
Optional können Sie Analysen zur App-Nutzung in Google Analytics abrufen. Fügen Sie dazu eine Google Analytics-ID im Marketplace SDK hinzu.
- Rufe den Tab Analytics auf.
- Geben Sie Ihre Google Analytics-ID ein.
- Klicken Sie auf Speichern.
Fehlerbehebung
In diesem Abschnitt werden häufige Probleme beschrieben, die auftreten können.
Erforderliche Berechtigungen fehlen beim Veröffentlichen von Apps auf dem Marketplace
Sie können keine Apps auf dem Marketplace veröffentlichen, da Versuche, die Anwendung auf der Seite „App-Konfiguration“ des Marketplace SDK zu konfigurieren, mit der folgenden Fehlermeldung fehlschlagen:
You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update
Dieser Fehler tritt auf, wenn die Marketplace SDK API aktiviert ist und eine andere IAM-Rolle als Editor oder Owner verwendet wird.
Führen Sie einen der folgenden Schritte aus, um den Fehler zu beheben:
Bitten Sie den Projektinhaber, dem Konto mit den fehlenden Berechtigungen die Rolle
roles/appmetadata.workspaceMarketplaceAppConfigurationAdminzuzuweisen, damit die App im Marketplace SDK konfiguriert und verwaltet werden kann.Bitten Sie den Projektinhaber, einer benutzerdefinierten Rolle über die Seite IAM & Verwaltung > Rollen in der Google Cloud Console fehlende Berechtigungen hinzuzufügen. Weisen Sie dem Konto mit den fehlenden Berechtigungen dann die benutzerdefinierte Rolle zu.
Für die Veröffentlichung von Apps kann das primitive
roles/editoroderroles/ownerverwendet werden. In der Dokumentation IAM sicher verwenden wird dies jedoch als schlechte Vorgehensweise betrachtet, da der Bearbeitungszugriff auf andere Ressourcen im Projekt nicht einfach eingeschränkt werden kann.