Diese Seite enthält alle Informationen zum Erstellen und Konfigurieren von Google Cloud-Projekten für Classroom-Add-ons. Google Cloud-Projekte werden verwendet, um die Einmalanmeldung (SSO) von Google über OAuth 2.0 (Google SSO) zu implementieren, Anfragen von Ihrem Add-on zu autorisieren und den Eintrag eines Add-ons im Google Workspace Marketplace-Store zu verwalten.
Allgemeine Informationen zum Veröffentlichen eines Add-ons im Marketplace finden Sie unter App veröffentlichen.
Google Cloud-Projekt erstellen
Es gibt zwei Projekttypen, die erstellt werden können: ein privates Projekt für die Entwicklung und ein öffentliches Projekt, das für Endnutzer erreichbar ist. Die Labels „öffentlich“ und „privat“ beziehen sich auf die Sichtbarkeit Ihrer Anwendung im Google Workspace Marketplace. Eine private Marketplace-Anwendung kann nur von Nutzern in der Domain installiert werden, in der sie erstellt wurde, während eine öffentliche Marketplace-Anwendung für jede Google Workspace-Domain verfügbar ist. Dabei muss es sich um zwei separate Anwendungen handeln, da ein Projekt nicht sowohl öffentlich als auch privat sein kann. Öffentliche Anwendungen müssen geprüft und genehmigt werden, bevor sie im Marketplace verfügbar sind.
Allgemeine Informationen zum Erstellen von Google Cloud-Projekten finden Sie unter Google Cloud-Projekt erstellen.
Privates Google Cloud-Projekt erstellen
Dieses private Projekt steht für die Add-on-Anwendung, die für die Entwicklung verwendet wird. Für Nutzer außerhalb der Domain, in der sie erstellt wurde, ist sie nicht zugänglich. Allerdings muss sie vor der Installation nicht genehmigt werden. Google empfiehlt daher, dieses Projekt zum Entwickeln und Testen Ihres Add-ons in einer kontrollierten Umgebung zu verwenden.
Sie benötigen Zugriff auf eine Google Workspace for Education-Domain mit der Teaching & Learning- oder Plus-Lizenz, um ein privates Projekt zu erstellen. Wenn Sie noch keinen Zugriff auf eine solche Domain haben, führen Sie die folgenden Schritte aus, um eine Google Workspace for Education-Demodomain einzurichten, ein Upgrade auf eine Plus-Lizenz durchzuführen und ihr Zugriff auf die Classroom Add-on API zu gewähren:
- Führen Sie die Schritte zum Beantragen einer Entwicklertestdomain aus.
Erstellen Sie ein neues Google Cloud-Projekt, während Sie in der Demodomain als Administrator angemeldet sind.
Google Cloud-Projekt erstellen
Wenn Sie nicht auf die Google Cloud Console zugreifen oder keine Cloud-Projekte erstellen können, prüfen Sie in der Admin-Konsole Folgendes:
- Rufen Sie die Seite Kontoeinstellungen > Einstellungen für altersabhängigen Zugriff auf und wählen Sie die Option Alle Nutzer in dieser Gruppe oder Organisationseinheit sind mindestens 18 Jahre alt aus.
- Unter Apps > Zusätzliche Google-Dienste:
- Die Google Cloud Platform ist für alle aktiviert.
- Die Einstellungen für die Projekterstellung sind auf Nutzer dürfen Projekte erstellen.
- Die Cloud Shell-Zugriffseinstellungen sind Zugriff auf Cloud Shell erlauben.
Füllen Sie das Formular zum Beantragen eines Upgrades der Demodomain aus und reichen Sie es ein. Wenn Sie dieses Formular senden, bitten Sie Google, Ihre Demodomain auf Google Workspace for Education Plus mit zehn Lizenzen zu aktualisieren und Ihr Cloud-Projekt in die Classroom Add-ons API zu integrieren.
Sie erhalten eine E-Mail, wenn das Upgrade und die Zulassungsliste abgeschlossen sind. Weisen Sie Ihren Testlehrerkonten in der Admin-Konsole Plus-Lizenzen zu. Erstellen Sie unter Verzeichnis > Nutzer Ihre Testkonten für Lehrkräfte oder wählen Sie sie aus. Bestätigen Sie in den Lizenzen jeder Lehrkraft, dass Google Workspace for Education Plus Zugewiesen ist.
Aktivieren Sie die Classroom API in Ihrem Cloud-Projekt.
Aktivieren Sie das Google Workspace Marketplace SDK in Ihrem Cloud-Projekt.
Legen Sie für die App-Konfiguration des Marketplace SDK die Sichtbarkeit der App auf privat fest.
Füllen Sie die Pflichtfelder auf der Seite Store-Eintrag des Marketplace SDK aus und klicken Sie auf VERÖFFENTLICHEN. Nachdem der App-Eintrag veröffentlicht wurde, können Nutzer in der Domain die App im Google Workspace Marketplace finden und installieren, indem sie die auf der Seite des Store-Eintrags angezeigte App-URL besuchen.
Öffentliches Google Cloud-Projekt erstellen
Dieses Projekt repräsentiert die Add-on-Anwendung, auf die Administratoren, Lehrkräfte und Schüler oder Studenten zugreifen können.
Erstellen Sie ein neues Google Cloud-Projekt in Ihrer Produktionsdomain.
Aktivieren Sie die Classroom API in Ihrem Cloud-Projekt.
Aktivieren Sie das Google Workspace Marketplace SDK in Ihrem Cloud-Projekt.
Legen Sie für die App-Konfiguration des Marketplace SDK die Sichtbarkeit der App auf Öffentlich fest und klicken Sie das Kästchen Nicht aufgeführt an.
Geben Sie die Cloud-Projekt-ID oder die Cloud-Projektnummer an Ihren Google-Partner weiter, um das Projekt auf die Zulassungsliste für Add-ons zu setzen. Dadurch erhält das Projekt Zugriff auf die neuen Add-on-Funktionen der Classroom API.
Füllen Sie die Pflichtfelder auf der Seite Store-Eintrag des Marketplace SDK aus und klicken Sie auf VERÖFFENTLICHEN.
Ihre Anwendung wird vom Google Workspace Marketplace-Team überprüft. Die Kommunikation mit Ihnen erfolgt über die im Marketplace SDK angegebene Entwickler-E-Mail-Adresse. Nachdem die App genehmigt wurde, entfernen Sie das Häkchen aus dem Kästchen Nicht gelistet, damit Lehrkräfte und Administratoren sie im Marketplace finden können.
oauth 2.0
Für den Zugriff auf die Classroom API ist eine Einwilligung für den Zugriff auf Nutzerdaten erforderlich. Diese erhalten Sie, indem Sie für den angemeldeten Nutzer Google-Zugriff auf OAuth-Bereiche anfordern und ein Token erhalten, mit dem anschließend API-Aufrufe an Google Classroom erfolgen können. Bereiche müssen im Store-Eintrag des Google Workspace Marketplace so konfiguriert werden, dass der Domainadministrator bei der Installation des Add-ons im Namen der Nutzer der Domain eine Einwilligung erteilen kann.
Eine detaillierte Liste aller verfügbaren Bereiche und deren Verwendung finden Sie auf der Seite OAuth-Bereiche für Google APIs. Allgemeine Informationen zur OAuth-Konfiguration finden Sie in der Workspace-Dokumentation auf der Seite „OAuth konfigurieren“.
Nutzerberechtigungen
Ihre Web-App sollte mindestens einen der folgenden Bereiche anfordern:
https://www.googleapis.com/auth/userinfo.email, wodurch eine Anwendung die E-Mail-Adresse des Nutzers sehen kann.https://www.googleapis.com/auth/userinfo.profileermöglicht einer Anwendung, personenbezogene Daten wie das Porträt, den Vor- und Nachnamen sowie andere personenbezogene Daten abzurufen, die der Nutzer öffentlich zugänglich gemacht hat.
Nachdem ein Nutzer einen dieser Bereiche in Ihrem Add-on autorisiert hat, wird er durch den Abfrageparameter login_hint identifiziert. Dieser Parameter wird an eine beliebige URL Ihrer Web-App übergeben, wenn ein iFrame geöffnet wird. Wenn ein Nutzer einen dieser Bereiche nicht autorisiert hat, wird stattdessen der Parameter hd (gehostete Domain) an die URLs Ihrer Webanwendung übergeben.
login_hint und hd sind OpenID Connect-Standardparameter, die Sie optional an Google weitergeben können, wenn Sie Google Log-in verwenden oder ein OAuth-Token anfordern. Sie sollen die Autorisierung für den Endnutzer vereinfachen.
Umfang der Classroom-Add-ons
Die folgenden Umfänge gelten speziell für Classroom-Add-ons:
https://www.googleapis.com/auth/classroom.addons.teacherermöglicht den Zugriff auf alle API-Methoden.https://www.googleapis.com/auth/classroom.addons.studentermöglicht den Zugriff zum Starten von Validierungs- und Anhanglesevorgängen.
Auch wenn ein gültiges OAuth-Zugriffstoken die Anmeldedaten des Nutzers angibt, sind API-Aufrufe durch zusätzliche Anforderungen gesteuert:
- Bei allen Methoden muss der Nutzer eine Lehrkraft oder ein Schüler/Student des Kurses sein, der mit
courseIdin der Anfrage angegeben ist. - Der Nutzer muss eine Lehrkraft sein, um Anhänge erstellen, aktualisieren, löschen und benoten zu können.
- Anrufe für einen bestimmten Google Classroom-Beitrag werden durch die folgenden Prüfungen eingeschränkt.
- Wenn ein Add-on bereits mindestens einen Anhang für einen Beitrag hat, können Anfragen für Folgendes gesendet werden:
- Validierung des iFrame-Starts
- Lese-, Aktualisierungs- und Löschvorgänge für Anhänge
- Updates zu diesem Beitrag benoten
- Wenn der iFrame für die Anhangerkennung zum ersten Mal geöffnet wird, hat das Add-on möglicherweise noch keinen Anhang im Beitrag. Es wird ein
addOnToken-Abfrageparameter angegeben, der für Anfragen für Folgendes verwendet werden kann:- Anhang unter dem Beitrag wird erstellt (
addOnTokenist erforderlich) - Startvalidierung (
addOnTokenwird validiert, falls angegeben und ist erforderlich, wenn das Add-on keinen vorhandenen Anhang für den Beitrag hat)
- Anhang unter dem Beitrag wird erstellt (
- Wenn ein Add-on bereits mindestens einen Anhang für einen Beitrag hat, können Anfragen für Folgendes gesendet werden:
OAuth-Überprüfung
Ein Classroom-Add-on greift über Google APIs auf die Daten von Google-Nutzern zu.
Weitere Informationen zum Überprüfungsprozess finden Sie in den häufig gestellten Fragen zur OAuth API-Überprüfung.
Google Workspace Marketplace-Eintrag
Wenn Sie im Rahmen dieses Early Access-Programms einen Marketplace-Store-Eintrag für Classroom-Add-ons erstellen, müssen Sie einige Dinge beachten.
Allgemeine Informationen zur Konfiguration des Google Workspace Marketplace SDK finden Sie unter Google Workspace Marketplace SDK aktivieren und konfigurieren und Google Workspace Marketplace-Store-Eintrag erstellen.
Hinweise zum Auflisten
Im Marketplace SDK Store-Eintrag Ihres öffentlichen Google Cloud-Projekts sind der Name und die Beschreibungen Ihrer Anwendung für Endnutzer angegeben. Sie können diese Details in mehreren Sprachen unter App-Details angeben.
Beachten Sie bei Ihren Einträgen folgende Richtlinien:
Unter App-Details:
Vermeiden Sie Satzzeichen im Anwendungsnamen. Verwenden Sie beispielsweise Mein Add-on von meinem Unternehmen statt „Mein Unternehmen: Mein Add-on“ oder „Mein Add-on von meinem Unternehmen“.
Die Kurzbeschreibung und die Detaillierte Beschreibung sollten nicht exakt denselben Text enthalten.
Achten Sie darauf, dass Sie einen Wert für das Feld Pricing ausgewählt haben. Dieses Feld enthält die Optionen Kostenlos, Mit einer kostenlosen Testversion bezahlt, Mit kostenlosen Funktionen bezahlt und Kostenpflichtige. Sie müssen den Kostenbetrag nicht im Marketplace-Eintrag angeben.
Achten Sie darauf, dass Sie einen Wert für das Feld Kategorie ausgewählt haben. Akademische Ressourcen oder Tools für Lehrkräfte und Administratoren sind gute Wahlmöglichkeiten für ein Classroom-Add-on.
Weitere Informationen finden Sie in der Beschreibung der App-Details des Marketplace.
Unter Grafikinhalte:
Bereitgestellte Grafikinhalte sind nicht verschwommen und entsprechen den Größen, die in den Google Workspace Marketplace-Standards angegeben sind.
Alle bereitgestellten Screenshots zeigen eine genaue Darstellung Ihrer Add-on-Nutzung.
Unter Supportlinks:
- Prüfen Sie, ob Sie einen Link zu den Nutzungsbedingungen Ihrer Anwendung angegeben haben.
Achte darauf, dass du die Google API-Branding-Richtlinien einhältst, die zulässige Namen und Beschreibungen umfassen.
Wenn Sie sich in Ihrem Eintrag auf ein Google-Produkt beziehen, verwenden Sie dessen Namen in dem Format, das in der Liste der Marken angegeben ist. Achten Sie darauf, das Markensymbol (TM) einzufügen, falls es angegeben ist. Verwenden Sie Google DocsTM und nicht „Google Docs“.
Einbindung in die Lizenzierungs- und Abrechnungsdienste von Google
Wenn Sie Ihre Google Workspace Marketplace-Anwendungen in die Lizenzierungs- und Abrechnungsdienste von Google einbinden möchten, rufen Sie die Marketplace API auf.
Installationseinstellungen
Add-ons können zusätzlich zur Installation durch einen Administrator auch individuell installiert werden. Auf dieser Seite werden einige Unterschiede zwischen den beiden Installationstypen hervorgehoben. Beide Installationstypen werden hier nicht beworben. Auf der Seite für die App-Konfiguration im Google Workspace Marketplace SDK können Sie festlegen, ob eine Installation zulässig ist.
Administrator installation
Mit Administratorinstallationen kann ein Administrator allen Konten in einer Domain oder bestimmten Zugriffsgruppen oder Organisationseinheiten ein Add-on hinzufügen. Nur ein Domainadministrator kann eine Administratorinstallation durchführen. Der Administrator kann optional allen Zugriffsbereichen im Namen aller Nutzer in der Domain zustimmen. Nutzer werden nicht aufgefordert, die Einwilligung für Zugriffsbereiche zu erteilen, wenn der Administrator dies möchte.
Im Folgenden finden Sie einige Überlegungen zur Administratorinstallation.
- Strengere Steuerungsmöglichkeiten: Administratoren können einschränken, welche Nutzer auf ein Add-on zugreifen können.
- Kompatibilität mit der Lizenzierung. Wenn für Ihre Anwendung eine Lizenz erforderlich ist, kann die Kanalisierung von Installationen über einen Administrator dazu beitragen, dass die Lizenzen mit der entsprechenden Einrichtung angemessen verteilt und verwendet werden.
- Entlastung der Endnutzer. Eine Administratorinstallation reduziert den Einrichtungsaufwand für Lehrkräfte und Lernende. Dies kann zu einer nahtloseren Nutzererfahrung mit weniger Klicks und weniger Verwirrung führen.
Weitere Informationen zum Ausführen von Administratorinstallationen finden Sie unter Marketplace-Apps in Ihrer Domain installieren. Weitere Informationen zu Organisationseinheiten und Zugriffsgruppen finden Sie unter Funktionsweise der Organisationsstruktur.
Individuelle Installation
Bei einzelnen Installationen wird dem Konto des Nutzers ein Add-on hinzugefügt. Der Nutzer wird während der Installation aufgefordert, den Zugriffsbereichen des Add-ons zuzustimmen.
Im Folgenden finden Sie einige Überlegungen zur Installation bei einzelnen Geräten.
- Ermöglichung der Einführung. Mehr Nutzer können Ihr Add-on aus dem Google Workspace Marketplace sehen und installieren. Wenn Sie die Installation einzeln zulassen, werden möglicherweise mehr Lehrkräfte Ihr Produkt akzeptieren oder sich dafür einsetzen.
- Tests durch Administratoren: Ein Administrator kann ein Add-on einzeln installieren, um es zu testen oder zu bewerten, bevor es für eine breitere Gruppe genehmigt oder installiert wird.
Administratoren können nicht nur Add-ons im Namen von Nutzern installieren, sondern auch eine Zulassungsliste erstellen, damit Nutzer Add-ons installieren dürfen, die eine individuelle Installation ermöglichen. Wenn ein Add-on nicht auf der Zulassungsliste steht, können Nutzer zwar den Eintrag des Add-ons im Google Workspace Marketplace sehen, aber nicht installieren. Stattdessen wird eine Meldung angezeigt, dass das Add-on von einem Domainadministrator nicht installiert werden darf. Weitere Informationen finden Sie unter Google Workspace Marketplace-Apps auf der Zulassungsliste verwalten.
Weitere Informationen finden Sie in der Dokumentation zu den Installationseinstellungen für Google Workspace Marketplace.
App-Einbindung
Sie müssen eine Start-iFrame-URL in das Feld URI für die Anhangeinrichtung eingeben. Diese URL wird als iFrame-Wert src für den iFrame der Anhangerkennung verwendet. Der iFrame für die Anhangerkennung wird von Lehrkräften verwendet, um Inhalte oder Aktivitäten zu finden, die sie an ihre Aufgaben anhängen können.
Sie müssen auch alle URI-Präfixe angeben, über die Anhänge vom Add-on zulässig sind. Diese Funktion erhöht die Sicherheit, da Anhänge von nicht autorisierten Quellen verhindert werden.
Weitere Informationen zu diesen Feldern finden Sie auf der Seite mit dem Leitfaden für iFrames.
Testkonten
Erstellen Sie Testkonten in Ihrer Demodomain, um das korrekte Verhalten Ihres privaten Add-ons zu prüfen. Es sind zwei Schülerkonten erforderlich, um den Wechsel zwischen Schülern im iFrame für die Aufgabe der Schüler/Studenten zu testen.
Empfohlene Testkonten:
- Tammy-Lehrkraft, tammy.Teacher@<Ihre Demo-Domain>
- Sam Student, sam.student@<Ihre Demodomain>
- Sally Student, sally.student@<Ihre Demo-Domain>
So erstellen Sie ein neues Testkonto:
- Melden Sie sich in der Admin-Konsole an.
- Gehen Sie zu Nutzer.
- Klicken Sie auf Neuen Nutzer hinzufügen (siehe Abbildung 1).
- Geben Sie die Daten des Nutzers ein und weisen Sie die richtigen Rollen zu.
Abbildung 1: Speicherort des Links Neuen Nutzer hinzufügen in der Admin-Konsole.
So erstellen Sie eine neue Testgruppe:
- Melden Sie sich in der Admin-Konsole an.
- Gehen Sie zu Gruppen.
- Klicken Sie auf Gruppe erstellen (siehe Abbildung 2).
- Geben Sie die Mitglieder und Inhaber der Gruppe ein.
Abbildung 2: Position des Links Gruppe erstellen in der Admin-Konsole.