Google Cloud-Projektkonfiguration

Diese Seite enthält Informationen zum Erstellen und Erstellen Google Cloud-Projekte für Classroom-Add-ons konfigurieren Google Cloud-Projekte werden verwendet, um die Einmalanmeldung (SSO) von Google über OAuth 2.0 zu implementieren. (Google SSO) verwenden, um von Ihrem Add-on gestellte Anfragen zu autorisieren und um ein Eintrag des Add-ons im Google Workspace Marketplace speichern.

Allgemeine Informationen zum Veröffentlichen eines Add-ons finden Sie hier: Marketplace finden Sie unter App veröffentlichen.

Google Cloud-Projekterstellung

Wichtiger Hinweis :Ihre Produktions-Add-on-Anwendung muss öffentlich sichtbar sein. im Google Workspace Marketplace SDK festgelegt. Ein privates Projekt kann nützlich sein zum Entwickeln und Testen Ihres Add-ons. Es ist jedoch nur ein öffentliches erforderlich.

Es können zwei Arten von Projekten erstellt werden: ein privates Projekt für Entwicklung und ein öffentliches Projekt, das für Endnutzer erreichbar ist. Die „Öffentlichkeit“ und "privat" beziehen sich Labels auf die Sichtbarkeit Ihrer Anwendung in Google Workspace Marketplace ein privater Marktplatz Die Anwendung kann nur von Nutzern in der Domain installiert werden, in der sie sich befand. während eine öffentliche Marketplace-Anwendung in allen Google Workspace-Domains verfügbar. Dabei muss es sich um zwei getrennte Anwendungen zu erstellen, da ein Projekt nicht öffentlich und privat sein kann. Öffentliche Anwendungen müssen überprüft und genehmigt werden, bevor sie auf dem Marktplatz verfügbar sind.

Wichtig :Ein privates Projekt kann nicht in ein öffentliches Projekt umgewandelt werden.

Allgemeine Informationen zum Erstellen eines Google Cloud-Projekts finden Sie unter Create a Google Cloud-Projekt.

Öffentliches Google Cloud-Projekt erstellen

Dieses Projekt stellt die Add-on-Anwendung dar, auf die über Administratoren, Lehrkräfte und Lernende. Ein öffentliches Projekt muss überprüft und vom Google Workspace Marketplace-Team genehmigt, installiert haben.

1. Erstellen Sie ein neues Google Cloud-Projekt in Ihrer Produktionsdomain.

   Google Cloud-Projekt erstellen

   Wichtig: Achten Sie darauf, dass das Projekt zu Ihrer Produktionsdomain gehört und dass Sie sind in der Google Cloud Console als Nutzer dieser Domain angemeldet.
   Warnung: Sie müssen zum Testen die Entwurf-Version Ihres Projekts verwenden. Bei ist die Entwurfsfunktion nur über die Google Workspace-Entwicklervorschauprogramm. Nachdem Sie Ihr Cloud-Projekt erstellt haben, dieses Antragsformulars ein, um die Funktionen des Google Workspace-Entwicklervorschauprogramms zu aktivieren. Weitere Informationen Weitere Informationen finden Sie unter App-Eintrag mit Entwürfen aktualisieren.

2. Aktivieren Sie die Classroom API in Ihrem Cloud-Projekt.

   Classroom API aktivieren

3. Aktivieren Sie das Google Workspace Marketplace SDK in Ihrem Cloud-Projekt.

   Google Workspace Marketplace SDK aktivieren

4. Marketplace SDK festlegen App-Konfiguration Sichtbarkeit der App auf Öffentlich und klicke das Kästchen Nicht gelistet an.

   Wichtiger Hinweis :Private Projekte, die für interne Zwecke verwendet werden, können nicht freigegeben oder konvertiert werden. Entwicklung und Tests.
   Wichtiger Hinweis :Nicht gelistete Apps sind nicht in der im Google Workspace Marketplace suchen. Im Konfiguration des Marketplace SDK: Sie können eine direkte URL ermitteln, mit dem das Add-on installiert werden kann. Nur Google und der Entwickler können um den Store-Eintrag zu finden. Ihre App sollte so lange nicht gelistet bleiben, bis Sie der Allgemeinheit zugänglich zu machen. Sie können festlegen, ob ein ist auf der Seite „App-Konfiguration“ der Marketplace SDK.

5. Füllen Sie die Pflichtfelder im Marketplace SDK aus Store-Eintrag und klicken Sie auf VERÖFFENTLICHEN

6. Ihre Anwendung wird vom Google Workspace Marketplace-Team überprüft. Sie wird mit dir über die Entwickler-E-Mail-Adresse kommunizieren, die im Marketplace SDK: Löschen Sie nach der Genehmigung der App Nicht gelistet, damit Lehrkräfte und Administratoren sie im Marktplatz:

Privates Google Cloud-Projekt erstellen

Dieses private Projekt steht für die Add-on-Anwendung, die für die Entwicklung verwendet wird. Sie ist für Nutzer außerhalb der Domain, in der sie erstellt wurde, nicht zugänglich. vor der Installation keine Genehmigung erforderlich ist. Daher empfiehlt Google Ihr Add-on in einer kontrollierten Umgebung entwickeln und testen.

Sie benötigen Zugriff auf eine Google Workspace for Education-Domain mit dem Lehr- und Learning oder Plus um ein privates Projekt zu erstellen. Wenn Sie noch keinen Zugriff auf eine solche -Domain handelt, folgen Sie diesen Schritten, um eine Demodomain für Google Workspace for Education einzurichten, ein Upgrade auf eine Außerdem müssen Sie Lizenzen erwerben und der Anwendung Zugriff auf die Classroom Add-ons API gewähren:

1. Führen Sie die Schritte zum Besorgen einer Entwickler-Testdomain aus.

2. Erstellen Sie, während Sie als Administrator in der Demodomain angemeldet sind, ein neues Google Cloud-Projekt

   Google Cloud-Projekt erstellen

   Warnung: Achten Sie darauf, dass das Projekt zur Demodomain gehört und dass Sie Sie sind mit einem Administratorkonto der Demo in der Google Cloud Console angemeldet. Domain.

   Wenn Sie nicht auf die Google Cloud Console zugreifen oder keine Cloud-Projekte prüfen Sie Folgendes in der Admin-Konsole:

   • Rufen Sie die Seite Kontoeinstellungen > Seite mit den altersabhängigen Zugriffseinstellungen und Wählen Sie die Option Alle Nutzer in dieser Gruppe oder Organisationseinheit sind 18 Jahre alt oder älter.
   • 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.

3. Füllen Sie das Antragsformular für das Upgrade der Demodomain aus und senden Sie es an uns. Senden dass Google Ihre Demodomain auf Google Workspace for Education Plus mit zehn und ermöglicht Ihrem Cloud-Projekt Classroom Add-ons API.

   Sie erhalten eine E-Mail, wenn das Upgrade und die Zulassungslisten abgeschlossen sind abgeschlossen ist. Weisen Sie Plus-Lizenzen Ihren Testlehrkonten in der zu Admin-Konsole. Weniger als Verzeichnis > Nutzer: Erstellen Sie Ihre Testkonten für Lehrkräfte oder wählen Sie sie aus. In jeder Lizenzen der Lehrkraft, sehen Sie nach, ob Google Workspace for Education Plus zugewiesen ist.

4. Aktivieren Sie die Classroom API in Ihrem Cloud-Projekt.

   Classroom API aktivieren

5. Aktivieren Sie das Google Workspace Marketplace SDK in Ihrem Cloud-Projekt.

   Google Workspace Marketplace SDK aktivieren

6. Marketplace SDK festlegen App-Konfiguration Sichtbarkeit der App auf Privat.

7. Füllen Sie die Pflichtfelder im Marketplace SDK aus Store-Eintrag 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 suchen und installieren können oder indem Sie die im Store-Eintrag angezeigte App-URL aufrufen.

oauth 2.0

Für den Zugriff auf die Classroom API ist die Einwilligung für den Zugriff auf Nutzerdaten erforderlich. Diese Sie erhalten Zugriff, indem Sie für den angemeldeten Nutzer Zugriff auf die OAuth-Bereiche von Google anfordern. Nutzer und erhält ein Token, mit dem anschließend API-Aufrufe an Google Classroom Bereiche müssen in der Google Workspace Marketplace-Store-Eintrag, damit der Domainadministrator können im Namen ihrer Domainnutzer einwilligen, dass das Add-on installiert wird.

Wichtig :Wenn Ihr Add-on zusätzliche Bereiche anfordert, fügen Sie diese in das OAuth- Zustimmungsbildschirm, Tab für die Konfiguration der Marketplace-SDK-App, und den Anwendungscode des Add-ons. Nicht übereinstimmende Bereiche an diesen Standorten kann es bei der Installation von Add-ons zu Problemen bei Nutzern kommen.

Auf der Seite OAuth-Bereiche für Google APIs finden Sie eine detaillierte Liste aller verfügbaren und ihre Verwendung. Weitere Informationen finden Sie in der Workspace-Dokumentation auf der Seite „OAuth konfigurieren“. finden Sie allgemeine Informationen zur OAuth-Konfiguration.

Nutzerberechtigungen

Ihre Webanwendung sollte mindestens einen der folgenden Bereiche anfordern:

• https://www.googleapis.com/auth/userinfo.email, mit dem ein Anwendung, um die E-Mail-Adresse des Nutzers anzuzeigen.
• https://www.googleapis.com/auth/userinfo.profile, mit dem ein personenbezogene Daten wie Hochformat, Vor- und Nachname Namen und andere personenbezogene Daten, die der Nutzer öffentlich gemacht hat verfügbar.

Nachdem ein Nutzer einen dieser Bereiche in Ihrem Add-on autorisiert hat, wird er die durch den Abfrageparameter login_hint identifiziert werden. Dieser Parameter wird an alle Ihrer Web-App-URLs beim Öffnen eines iFrames ein. Wenn ein Nutzer kein Konto autorisiert hat dieser Bereiche werden login_hint nicht gesendet.

Warnung: Ihre App muss mindestens eine der userinfo.email oder userinfo.profile Bereiche, um bei nachfolgenden Besuchen login_hint zu erhalten von demselben Nutzer.

login_hint ist ein OpenID Connect-Standardparameter, den Sie optional an Google weitergeleitet werden, 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.teacher, mit der Sie Zugriff auf alle API-Methoden.
• https://www.googleapis.com/auth/classroom.addons.student, mit der Sie Zugriff zum Starten von Validierungs- und Anhang-Lesevorgängen.

Auch wenn ein gültiges OAuth-Zugriffstoken mit den Anmeldedaten des Nutzers vorhanden ist, werden API-Aufrufe unterliegen folgenden zusätzlichen Anforderungen:

• Bei allen Methoden muss der Nutzer eine Lehrkraft oder ein Schüler/Student im Kurs sein in der Anfrage durch courseId angegeben.
• Zum Erstellen, Aktualisieren, Löschen und Zurückgeben von Anhängen muss der Nutzer um Lehrer zu werden.
• Anrufe an einen bestimmten Google Classroom-Beitrag werden durch Folgendes gesteuert: Überprüfungen.
  • Wenn ein Add-on bereits mindestens einen Anhang für einen Beitrag hat, kann es Anfragen stellen für: <ph type="x-smartling-placeholder">
    </ph>
    • 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, kann das Add-on hat noch keinen Anhang zum Beitrag. Ein addOnToken-Abfrageparameter wird bereitgestellt, mit denen folgende Anfragen gestellt werden können:
    • Anhang unter dem Beitrag erstellen (addOnToken ist erforderlich)
    • Validierung starten (addOnToken ist validiert, sofern angegeben und ist erforderlich, wenn das Add-on keinen Anhang im Beitrag)

OAuth-Überprüfung

Hinweis :Sie können kein Demovideo erstellen, um es im Rahmen der OAuth-Überprüfung einzureichen. . Veröffentlichen Sie stattdessen das Add-on, ohne OAuth zu bestätigen. Vorgehensweise benachrichtigt das Google Workspace Marketplace-Team, ein Demovideo zu erstellen. in Ihrem Namen. Das Prüfteam stellt dir das Video dann zur Verfügung, damit du in Ihre OAuth-Überprüfungseinreichung aufnehmen.

Ein Classroom-Add-on nutzt Google APIs, um auf die Daten.

• Bestätige deine Markenidentität.
• Prüfen Sie vertrauliche OAuth-Bereiche.

Weitere Informationen zur OAuth API-Überprüfung finden Sie hier. zu überprüfen.

Google Workspace Marketplace-Eintrag

Achtung :Wenn Sie die Sichtbarkeitsoption während der Veröffentlichung gespeichert haben, können Sie Ihre Auswahl später nicht mehr ändern.

Allgemeine Informationen zur Konfiguration des Google Workspace Marketplace SDK finden Sie unter Aktivieren und konfigurieren Sie das Google Workspace Marketplace SDK und Store-Eintrag für Google Workspace Marketplace erstellen

Überlegungen zu Listeneinträgen

Im Marketplace SDK-Store Ihres öffentlichen Google Cloud-Projekts Liste gibt den Namen und die Beschreibungen für die Endanwendenden. Sie können diese Details in mehreren Sprachen unter App-Details.

Beachten Sie bei Ihren Einträgen die folgenden Richtlinien:

• Unter App-Details:

  • Vermeiden Sie Satzzeichen im Anwendungsnamen. Beispiel: "Mein Add-on von My Company statt „Mein Unternehmen: Mein Add-on“ oder "Mein Add-on von meinem Company“ aus.

  • Die Kurzbeschreibung und die detaillierte Beschreibung dürfen folgenden Text nicht enthalten: exakt denselben Text.

  + Stellen Sie sicher, dass Sie einen Wert für das Feld Pricing ausgewählt haben. Dieses Optionen wie Kostenlos, Mit einem kostenlosen Testzeitraum bezahlt und Bezahlt mit kostenlose Funktionen und kostenpflichtige Preise. Kosten müssen nicht angegeben werden. im Marketplace-Eintrag angezeigt.

  • Sie müssen einen Wert für das Feld Kategorie ausgewählt haben. Akademische Ressourcen oder Tools für Lehrkräfte und Administratoren könnten eine gute Wahl für ein Classroom-Add-on.

  • Sehen Sie sich die Elemente an, die in der Marketplace-App ausführliche Beschreibung.

Wichtig :Prüfen Sie die App-Details für jede Sprache, in der Sie Ihr Add-on.

• Unter Grafikinhalte:

  • Die bereitgestellten Grafikinhalte sind nicht unscharf und entsprechen den angegebenen Größen. in den Google Workspace Marketplace-Standards

  • Alle bereitgestellten Screenshots sind genaue Darstellungen Ihres Add-ons. .

• Unter Supportlinks:

  • Stellen Sie sicher, dass Sie einen Link zu den Nutzungsbedingungen Dienst.

• Achten Sie darauf, die Branding-Richtlinien für die Google API einzuhalten, deckt zulässige Namen und Beschreibungen ab.

• Wenn Sie in Ihrem Eintrag auf Google-Produkte verweisen, verwenden Sie deren Namen im das in der Markenliste angegebene Format verwendet wird. Stellen Sie sicher, dass Sie die Markensymbol (TM), falls angegeben; verwenden Sie "Google DocsTM", nicht "Google Google Docs“.

Einbindung in Lizenz- und Abrechnungsdienste von Google

Wenn Sie Ihre Google Workspace Marketplace-Anwendungen Integration in die Lizenzierungs- und Abrechnungsdienste von Google erhalten Sie unter Marketplace API

Installationseinstellungen

Neben dem Administrator können Add-ons auch die Installation für einzelne Nutzer ermöglichen Installation. Auf dieser Seite werden einige Unterschiede zwischen den beiden Installationen hervorgehoben. Typen. Es ist nicht dafür gedacht, eines der beiden Installationstypen zu bewerben. Zur Auswahl stehen ob die individuelle Installation im Google Workspace Marketplace SDK erlaubt ist Seite „App-Konfiguration“.

Administrator installation

Bei Installationen durch Administratoren kann ein Administrator Add-on für alle Konten in einer Domain oder auf bestimmte Zugriffsgruppen oder Organisationseinheiten zugreifen. Nur kann ein Domainadministrator eine Administratorinstallation durchführen. Die Administrator kann optional im Namen aller Nutzer allen Zugriffsbereichen zustimmen in der Domain werden Nutzer nicht aufgefordert, Zugriffsbereichen zuzustimmen, wenn der für die Verwaltung von Zugriffsrechten.

Im Folgenden finden Sie einige Überlegungen zur Administratorinstallation.

• Strengere Steuerelemente: Administratoren können einschränken, welche Nutzer auf Add-on.
• Kompatibilität mit der Lizenzierung: Wenn für Ihren Antrag eine Lizenz erforderlich ist, Das Kanalisieren von Installationen über einen Administrator kann dazu beitragen, Lizenzen verteilt und ordnungsgemäß mit der entsprechenden Einrichtung.
• Geringere Belastung für Endnutzer Eine Administrator-Installation reduziert den für Lehrkräfte und Lernende. Dies kann zu einer besseren Nutzererfahrung mit weniger Klicks und weniger Missverständnissen.

Weitere Informationen finden Sie unter Marketplace-Apps in Ihrer Domain installieren. Administratorinstallationen ausführen und Funktionsweise der Organisationsstruktur finden Sie weitere Informationen zu Organisationseinheiten und Zugriffsgruppen.

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. Mehr Nutzer können Ihr Add-on über die Google Workspace Marketplace Wenn Sie die Einzelinstallation zulassen, mehr Lehrkräfte, die Ihr Produkt akzeptieren oder sich dafür einsetzen.
• Administratortests: Ein Administrator kann eine können Sie es testen oder bewerten, bevor Sie es für eine einer größeren Gruppe.

Zusätzlich zur Installation von Add-ons für Ihre Nutzer können Administratoren Sie führen eine Zulassungsliste, um Nutzern die Installation von Add-ons zu erlauben, Installation. Wenn ein Add-on nicht auf der Zulassungsliste steht, können Nutzer das den Eintrag des Add-ons im Google Workspace Marketplace hat, das Add-on aber nicht installiert werden kann. add-on; erscheint stattdessen eine Meldung, dass das Add-on nicht die von einem Domainadministrator installiert werden dürfen. Weitere Informationen finden Sie unter Google Workspace verwalten Marketplace-Apps auf Ihrer Zulassungsliste, um mehr über dieses Verhalten zu erfahren.

Weitere Informationen finden Sie in der Dokumentation zu den Installationseinstellungen für den Google Workspace Marketplace. erhalten Sie weitere Informationen.

App-Einbindung

Sie müssen im Feld URI für die Anhangeinrichtung eine Start-iFrame-URL angeben. Dieses Die URL wird als src-i-Wert für den iFrame für den iFrame der Anhangserkennung verwendet. Die Der iFrame für die Anhangserkennung wird von Lehrkräften verwendet, um Inhalte oder Aktivitäten zu finden, an die Aufgabe anhängen.

Sie müssen auch alle URI-Präfixe angeben, von denen Anhänge zulässig sind aus Ihrem Add-on. Diese Funktion erhöht die Sicherheit, indem verhindert wird, dass Anhänge nicht autorisierten Quellen.

Weitere Informationen zu diesen Feldern finden Sie im Leitfaden zu iFrames.

Testkonten

Erstellen Sie in Ihrer Demodomain Testkonten, um das Verhalten Ihrer privaten Add-ons. Zwei Schüler-/Studentenkonten sind erforderlich, um den Wechsel zwischen in den iFrame mit der Aufgabe „Aufgaben von Schülern/Studenten“ ein.

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:

1. Melden Sie sich in der Admin-Konsole an.
2. Gehen Sie zu Nutzer.
3. Klicken Sie auf Neuen Nutzer hinzufügen (siehe Abbildung 1).
4. Geben Sie die Daten des Nutzers ein und weisen Sie ihm die entsprechenden Rollen zu.

Abbildung 1: Speicherort des Links Neuen Nutzer hinzufügen im in der Admin-Konsole.

So erstellen Sie eine neue Testgruppe:

1. Melden Sie sich in der Admin-Konsole an.
2. Gehen Sie zu Gruppen.
3. Klicken Sie auf Gruppe erstellen (siehe Abbildung 2).
4. Geben Sie die Mitglieder und Inhaber der Gruppe ein.

Abbildung 2: Speicherort des Links Gruppe erstellen im in der Admin-Konsole.