Diese Seite enthält Informationen zum Erstellen und Konfigurieren von Google Cloud-Projekten für Classroom-Add-ons. Google Cloud-Projekte werden verwendet, um die Google-Einmalanmeldung (SSO) ü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 in Marketplace finden Sie unter App veröffentlichen.
Google Cloud-Projekterstellung
Es können zwei Arten von Projekten erstellt werden: 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 in 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 gemacht werden.
Allgemeine Informationen zum Erstellen von Google Cloud-Projekten finden Sie unter Google Cloud-Projekt erstellen.
Öffentliches Google Cloud-Projekt erstellen
Dieses Projekt stellt die Add-on-Anwendung dar, auf die Administratoren, Lehrkräfte und Schüler oder Studenten zugreifen können. Öffentliche Projekte müssen vom Google Workspace Marketplace-Team geprüft und genehmigt werden, bevor es gestartet oder installiert werden kann.
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.
Setzen Sie die App-Konfiguration der App-Sichtbarkeit des Marketplace SDK auf Öffentlich und klicken Sie das Kästchen Nicht gelistet an.
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. Er kommuniziert mit Ihnen über die im Marketplace SDK angegebene E-Mail-Adresse des Entwicklers. 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.
Privates Google Cloud-Projekt erstellen
Dieses private Projekt steht für die Add-on-Anwendung, die für die Entwicklung verwendet wird. Sie kann nicht von Nutzern außerhalb der Domain aufgerufen werden, in der sie erstellt wurde. Sie muss jedoch 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 and 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 der Domain Zugriff auf die Classroom Add-ons API zu gewähren:
- Gehen Sie wie hier beschrieben vor, um eine Entwickler-Testdomain zu erhalten.
Erstellen Sie ein neues Google Cloud-Projekt, während Sie als Administrator in der Demodomain angemeldet sind.
Google Cloud-Projekt erstellen
Wenn Sie nicht auf die Google Cloud Console zugreifen oder 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 Nutzern erlauben, Projekte zu erstellen.
- Die Cloud Shell-Zugriffseinstellungen sind Zugriff auf Cloud Shell zulassen.
Füllen Sie das Antragsformular für das Upgrade der Demodomain aus und senden Sie es an uns. Mit dem Senden dieses Formulars wird Google gebeten, Ihre Demodomain auf Google Workspace for Education Plus mit zehn Lizenzen zu aktualisieren und Ihr Cloud-Projekt in die Classroom Add-ons API aufzunehmen.
Sie erhalten eine E-Mail, wenn das Upgrade und die Prozesse auf der Zulassungsliste abgeschlossen sind. Weisen Sie in der Admin-Konsole den Konten der Testlehrkräfte Plus-Lizenzen zu. Erstellen Sie unter Verzeichnis > Nutzer Ihre Testkonten für Lehrkräfte oder wählen Sie sie aus. Prüfen Sie bei jeder Lehrkraft unter Lizenzen, ob 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 App-Sichtbarkeit 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 Anwendungseintrag veröffentlicht wurde, können Nutzer in der Domain die Anwendung im Google Workspace Marketplace oder über die auf der Seite des Store-Eintrags angezeigte App-URL finden und installieren.
oauth 2.0
Für den Zugriff auf die Classroom API ist die Einwilligung für den Zugriff auf Nutzerdaten erforderlich. Dazu wird für den angemeldeten Nutzer Zugriff von Google auf OAuth-Bereiche angefordert und ein Token erhalten, mit dem anschließend API-Aufrufe an Google Classroom gesendet werden können. Bereiche müssen im Google Workspace Marketplace-Store-Eintrag konfiguriert werden, damit der Domainadministrator bei der Installation des Add-ons die Einwilligung im Namen der Domainnutzer erteilen kann.
Eine detaillierte Liste aller verfügbaren Bereiche und ihrer Verwendung finden Sie auf der Seite OAuth-Bereiche für Google APIs. Allgemeine Informationen zur OAuth-Konfiguration finden Sie in der Dokumentation zu Google Workspace auf der Seite „OAuth konfigurieren“.
Nutzerberechtigungen
Ihre Webanwendung sollte mindestens einen der folgenden Bereiche anfordern:
https://www.googleapis.com/auth/userinfo.email, mit dem eine Anwendung die E-Mail-Adresse des Nutzers ansehen kann.https://www.googleapis.com/auth/userinfo.profile, mit dem eine Anwendung personenbezogene Daten wie das Porträt, Vor- und Nachnamen sowie andere personenbezogene Daten abrufen kann, 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 alle URLs Ihrer Webanwendung übergeben, wenn ein iFrame geöffnet wird. Wenn ein Nutzer einen dieser Bereiche nicht autorisiert hat, wird login_hint nicht gesendet.
login_hint ist ein OpenID Connect-Standardparameter, den Sie optional an Google weitergeben können, wenn Sie Google Log-in verwenden oder ein OAuth-Token anfordern. Es soll die Autorisierung für den Endnutzer reibungsloser gestalten.
Bereiche von Classroom-Add-ons
Die folgenden Bereiche gelten nur für Classroom-Add-ons:
https://www.googleapis.com/auth/classroom.addons.teachererlaubt 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 die Anmeldedaten des Nutzers mit einem gültigen OAuth-Zugriffstoken angegeben werden, sind API-Aufrufe durch zusätzliche Anforderungen gesteuert:
- Bei allen Methoden muss der Nutzer eine Lehrkraft oder ein Schüler/Student im Kurs sein, der in der Anfrage durch
courseIdangegeben wird. - Zum Erstellen, Aktualisieren, Löschen und Zurückgeben von Anhängen muss der Nutzer eine Lehrkraft sein.
- Aufrufe an einen bestimmten Google Classroom-Beitrag werden durch die folgenden Prüfungen gesteuert.
- Wenn ein Add-on bereits mindestens einen Anhang für einen Beitrag hat, kann es folgende Anfragen senden:
- Validierung des iFrame-Starts
- Lese-, Aktualisierungs- und Löschvorgänge für Anhänge
- Notenaktualisierungen für diesen Beitrag
- Wenn der iFrame für die Anhangserkennung zum ersten Mal geöffnet wird, hat das Add-on möglicherweise noch keinen Anhang zum Beitrag. Es wird ein
addOnToken-Abfrageparameter bereitgestellt, mit dem sich Anfragen für Folgendes senden lassen:- Anhang unter dem Beitrag erstellen (
addOnTokenist erforderlich) - Startvalidierung (
addOnTokenwird validiert, sofern angegeben und ist erforderlich, wenn das Add-on keinen vorhandenen Anhang zum Beitrag hat)
- Anhang unter dem Beitrag erstellen (
- Wenn ein Add-on bereits mindestens einen Anhang für einen Beitrag hat, kann es folgende Anfragen senden:
OAuth-Überprüfung
Ein Classroom-Add-on verwendet Google APIs, um auf die Daten von Google-Nutzern zuzugreifen.
Weitere Informationen zum Überprüfungsprozess finden Sie in den häufig gestellten Fragen zur OAuth API-Bestätigung.
Google Workspace Marketplace-Eintrag
Allgemeine Informationen zur Konfiguration des Google Workspace Marketplace SDK finden Sie unter Google Workspace Marketplace SDK aktivieren und konfigurieren und Store-Eintrag für Google Workspace Marketplace erstellen.
Überlegungen zu Listeneinträgen
Im Marketplace SDK-Store-Eintrag Ihres öffentlichen Google Cloud-Projekts werden 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 die folgenden Richtlinien:
Unter App-Details:
Vermeiden Sie Satzzeichen im Anwendungsnamen. Verwenden Sie beispielsweise "Mein Add-on von meinem Unternehmen" anstelle von "Mein Unternehmen: Mein Add-on" oder "Mein Add-on, von meinem Unternehmen".
Die Kurzbeschreibung und die detaillierte Beschreibung sollten nicht denselben Text enthalten.
+ Stellen Sie sicher, dass Sie einen Wert für das Feld Pricing ausgewählt haben. Dieses Feld enthält Optionen für die Preise Kostenlos, Mit einem kostenlosen Testzeitraum bezahlt, Mit kostenlosen Funktionen bezahlt und Kostenpflichtig. Sie müssen den Kostenbetrag nicht im Marketplace-Eintrag angeben.
Sie müssen einen Wert für das Feld Kategorie ausgewählt haben. Akademische Ressourcen oder Tools für Lehrkräfte und Administratoren können eine gute Wahl für ein Classroom-Add-on sein.
Weitere Informationen finden Sie in der Beschreibung der App-Details von Marketplace.
Unter Grafikinhalte:
Die bereitgestellten Grafikinhalte sind nicht unscharf und entsprechen den in den Google Workspace Marketplace-Standards angegebenen Größen.
Alle bereitgestellten Screenshots sind genaue Darstellungen Ihrer Add-on-Nutzung.
Unter Supportlinks:
- Sie müssen einen Link zu den Nutzungsbedingungen Ihrer Anwendung angegeben haben.
Sie müssen die Branding-Richtlinien für die Google API einhalten, die auch zulässige Namen und Beschreibungen umfassen.
Wenn Sie in Ihrem Eintrag auf Google-Produkte verweisen, verwenden Sie den Namen in dem Format, das in der Markenliste angegeben ist. Falls dies angegeben ist, muss das Markensymbol (TM) angegeben werden. Verwenden Sie Google DocsTM und nicht "Google Docs".
Einbindung in Lizenz- und Abrechnungsdienste von Google
Wenn Sie Ihre Google Workspace Marketplace-Anwendungen in die Lizenzierungs- und Abrechnungsdienste von Google einbinden lassen möchten, rufen Sie die Marketplace API auf.
Installationseinstellungen
Add-ons können die Installation für einzelne Nutzer zusätzlich zur Installation für Administratoren ermöglichen. Auf dieser Seite werden einige Unterschiede zwischen den beiden Installationstypen hervorgehoben. Beide Installationstypen sollen nicht beworben werden. Auf der Seite „App-Konfiguration“ des Google Workspace Marketplace SDK können Sie auswählen, ob die individuelle 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 im Namen aller Nutzer in der Domain allen Zugriffsbereichen zustimmen. Nutzer werden nicht aufgefordert, den Zugriffsbereichen zuzustimmen, wenn sie das möchten.
Im Folgenden finden Sie einige Überlegungen zur Administratorinstallation.
- Strengere Steuerelemente: 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 das Channeling über einen Administrator dazu beitragen, dass Lizenzen mit der entsprechenden Einrichtung verteilt und ordnungsgemäß verwendet werden.
- Geringere Belastung für Endnutzer Durch eine Administratorinstallation wird der Einrichtungsaufwand für Lehrkräfte und Schüler oder Studenten reduziert. Dies kann zu einer nahtloseren Nutzererfahrung mit weniger Klicks und weniger Verwirrung führen.
Weitere Informationen zu Organisationseinheiten und Zugriffsgruppen finden Sie unter Marketplace-Apps in Ihrer Domain installieren und 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 Einzelinstallation.
- Erleichtern Sie die Einführung. Weitere Nutzer können Ihr Add-on im Google Workspace Marketplace sehen und installieren. Eine individuelle Installation kann dazu führen, dass mehr Lehrkräfte Ihr Produkt akzeptieren oder sich dafür einsetzen.
- Administratortests: Ein Administrator kann ein Add-on einzeln installieren, um es zu testen oder zu evaluieren, bevor es für eine größere Gruppe genehmigt oder installiert wird.
Administratoren können nicht nur Add-ons im Namen von Nutzern installieren, sondern auch eine Zulassungsliste erstellen, über die Nutzer Add-ons installieren dürfen, die eine individuelle Installation ermöglichen. Wenn ein Add-on nicht auf der Zulassungsliste steht, können Nutzer den Eintrag des Add-ons im Google Workspace Marketplace zwar sehen, aber nicht installieren. Sie sehen stattdessen eine Meldung, dass die Installation des Add-ons von einem Domainadministrator nicht zugelassen wurde. Weitere Informationen zu diesem Verhalten 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 im Feld URI für die Anhangeinrichtung eine Start-iFrame-URL angeben. Diese URL wird als src-i-Wert für den iFrame für den iFrame der Anhangerkennung verwendet. Der iFrame der Anhangserkennung wird von Lehrkräften verwendet, um Inhalte oder Aktivitäten zu finden und an ihre Aufgabe anzuhängen.
Sie müssen auch alle URI-Präfixe angeben, über die Anhänge des Add-ons zulässig sind. Dieses Feature erhöht die Sicherheit, da es Anhänge aus nicht autorisierten Quellen verhindert.
Weitere Informationen zu diesen Feldern finden Sie im Leitfaden zu iFrames.
Testkonten
Erstellen Sie Testkonten in Ihrer Demodomain, um das korrekte Verhalten Ihres privaten Add-ons zu prüfen. Zum Testen des Wechsels zwischen Lernenden im iFrame „Student Work Review“ sind zwei Schülerkonten erforderlich.
Vorgeschlagene Testkonten:
- Tammy Lehrer, tammy.lehrer@<Ihre Demodomain>
- Sam Student, sam.student@<Ihre Demodomain>
- Sally Student, sally.student@<Ihre Demodomain>
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 ihm die entsprechenden 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: Speicherort des Links Gruppe erstellen in der Admin-Konsole.