Anforderungen an Add-ons

Version 1.1, 5. Dezember 2024

Die Kriterien auf dieser Seite gelten für alle Classroom-Add-ons. Ihr Add-on muss alle anwendbaren Anforderungen erfüllen, um für die Auflistung im Google Workspace Marketplace und als Add-on, das mit Classroom funktioniert, genehmigt zu werden.

Dieser Artikel ist eine Übersetzung aus dem Englischen. Für die im Original verwendeten Begriffe „must“, „must not“, „required“, „shall“, „shall not“, „should“, „should not“, „recommended“, „may“ und „optional“ gelten die Definitionen laut RFC 2119.

Voraussetzungen

ID Typ
1.0 Endnutzerlizenz (falls zutreffend)
  1.1 Wenn ein Nutzer keine Lizenz hat, SOLLTE ihm eine nutzerfreundliche Meldung angezeigt werden. In der Meldung SOLLTE klar angegeben werden, warum das Add-on nicht verwendet werden kann, und dem Nutzer SOLLTE eine Vorgehensweise vorgeschlagen werden, um die Situation zu beheben. EMPFOHLEN
  1.3 In der Google Workspace Marketplace-Auflistung für das Add-on SOLLTEN Details zu den Lizenz- und Aboanforderungen angegeben werden, die für die Verwendung des Add-ons erforderlich sein können. Wenn das Add-on eine kostenpflichtige Stufe hat, SOLLTE die Marketplace-Auflistung einen Link zu einer Webseite mit weiteren Informationen zu den Preisen oder dazu, wie Sie einen Vertriebsmitarbeiter kontaktieren können, enthalten. EMPFOHLEN
2.0 Anmeldung für Endnutzer
  2.1 Lehrer MÜSSEN sich über Google SSO im Add-on anmelden.
Wenn Schüler und Studenten aufgefordert werden, sich im Add-on anzumelden, MÜSSEN sie sich über Google SSO anmelden.		 ERFORDERLICH
  2.2 Das Add-on MUSS Google SSO verwenden, um einen Nutzer bei nachfolgenden Besuchen automatisch anzumelden, ohne eine Anmeldeaufforderung anzuzeigen.
Wenn der Anmeldehinweis keine Übereinstimmung mit dem aktuell angemeldeten Nutzer ergibt, MUSS das Add-on den Nutzer mit einer Anmeldeschaltfläche auffordern und den login_hint an die Authentifizierungsbibliothek übergeben, um ungültige Konten herauszufiltern.		 ERFORDERLICH
  2.7 Wenn der Classroom-Nutzer noch nicht im Add-on angemeldet ist (wie anhand des Anmeldehinweises ermittelt), MUSS das Add-on eine Schaltfläche „Mit Google anmelden“ anzeigen, damit der Nutzer die Anmeldung explizit auslösen kann.
Hinweis: Dies ist erforderlich, um die Google-Markenrichtlinien einzuhalten und Pop-up-Blocker zu vermeiden.		 ERFORDERLICH
  2.8 Das Add-on SOLLTE anzeigen, wer der aktuell angemeldete Nutzer ist. EMPFOHLEN
3.0 Allgemein
  3.1 Das Add-on MUSS die allgemeinen Genehmigungsrichtlinien für den Google Workspace Marketplace einhalten. ERFORDERLICH
  3.2 Wenn eine Aufgabe über einen der iFrame-Abläufe in einem neuen Tab oder Fenster gestartet wird, SOLLTE eine nutzerfreundliche Meldung angezeigt werden, über die der Nutzer zu Classroom zurückkehren kann. EMPFOHLEN
  3.3 Der Nutzer MUSS den Ablauf nur über einen Add-on-Workflow abschließen und darf nicht zu einem CourseWork-Workflow wechseln oder die Classroom-Schaltfläche „Teilen“ verwenden. ERFORDERLICH
  3.4 Lokalisierung: Die Sprache SOLLTE nach Möglichkeit auf der vom Browser festgelegten lokalen Einstellung basieren. EMPFOHLEN
  3.5 Wenn ein Add-on maxPoints definiert, MUSS auch pointsEarned festgelegt werden, wenn ein Schüler oder Student eine Aufgabe mit gespeicherten Lehreranmeldedaten abschließt (empfohlen) ODER wenn der Lehrer die Aufgabe im iFrame „Aufgaben von Schülern und Studenten prüfen“ öffnet. ERFORDERLICH
  3.9 Add-ons SOLLTEN den Richtlinien für Barrierefreiheit der WCAG 2.1, Konformitätsstufe AA entsprechen. Add-on-Entwickler geben bei der Einreichung selbst an, dass diese Anforderung erfüllt ist und dass das Add-on auch bei zukünftigen Änderungen am Add-on konform bleibt. EMPFOHLEN
  3.10 Alle Fehler, die bei einem Nutzer auftreten, SOLLTEN für Menschen lesbar sein. EMPFOHLEN
  3.11 Wenn studentViewUri, teacherViewUri oder studentWorkViewUri über eine kopierte Aufgabe oder einen kopierten Kurs gestartet wird, DÜRFEN im iFrame keine Fehlerseiten angezeigt werden. ERFORDERLICH
4.0 Anhangsuche
  4.1 Wenn für einen Anhang eine Abgabe von Schülern oder Studenten erforderlich ist, MUSS der Anhang studentWorkReviewUri enthalten, damit er als Aktivitätstyp und nicht als Anhang vom Inhaltstyp behandelt wird. ERFORDERLICH
  4.2 Der iFrame „Anhangsuche“ MUSS eine Benutzeroberfläche bieten, die mindestens eine der folgenden Möglichkeiten bietet:
  • Neue Inhalte zum Anhängen erstellen
  • In einer Inhaltsbibliothek suchen, Inhalte auswählen und anhängen
  • Anleitung zum Anhängen von Inhalten von Ihrer Website oder aus anderen Produkten
 ERFORDERLICH
  4.3 Der Lehrer SOLLTE alle für ihn verfügbaren Inhalte/Aktivitäten finden und darauf zugreifen können. EMPFOHLEN
  4.4 Der Lehrer SOLLTE eine Vorschau der Inhalte/Aktivitäten sehen können, bevor er sie an die Aufgabe anhängt. EMPFOHLEN
  4.5 Wenn der Lehrer Inhalte/Aktivitäten erstellen muss, bevor sie angehängt werden können, SOLLTE dies im iFrame erfolgen. EMPFOHLEN
5.0 Ansicht für Schüler und Studenten
  5.1 Wenn das studentViewUri gestartet wird, SOLLTE der Nutzer nicht aus dem iFrame herausgeleitet werden, um eine Aufgabe zu erledigen.
Wenn der Nutzer doch aus dem iFrame herausgeleitet wird, MUSS eine Meldung oder ein anderer Hinweis für Schüler und Studenten vorhanden sein, damit sie zu Classroom zurückkehren können.		 EMPFOHLEN
  5.2 Wenn eine Add-on-Aktivität aus dem iFrame herausgeleitet wird, SOLLTE im iFrame eine Vorschau der Aufgabe angezeigt werden. EMPFOHLEN
  5.3 Wenn in der Aktivität eine Schaltfläche oder ein Link mit der Bezeichnung Abgeben vorhanden ist, MUSS dadurch eine API-Anfrage gesendet werden, um die Arbeit des Schülers oder Studenten zur Überprüfung durch den Lehrer einzureichen. ERFORDERLICH
6.0 Ansicht für Lehrer
  6.1 Der Lehrer SOLLTE sehen können, was der Schüler oder Student sieht, wenn er die Aufgabe bearbeitet. EMPFOHLEN
7.0 Aufgaben von Schülern und Studenten prüfen
  7.1 Wenn studentWorkReviewUri gestartet wird, MUSS das Add-on die Arbeit des Schülers oder Studenten zur Überprüfung durch den Lehrer im iFrame rendern. Zusätzliches Material kann außerhalb des iFrames verlinkt werden. ERFORDERLICH
  7.2 Das Add-on DÜRFEN in der Ansicht studentWorkReviewUri keine Navigation zwischen Schülern und Studenten ermöglichen. Die Navigation zwischen Schülern und Studenten MUSS nur in der Classroom-Benutzeroberfläche erfolgen. ERFORDERLICH
8.0 Unterstützung für die mobile Classroom App
  8.1 Wenn in der mobilen Classroom App teacherViewUri, studentViewUri oder studentWorkReviewUri gestartet wird, MUSS die URL entweder die native mobile App des Partners oder die mobile Web-App des Partners öffnen und in beiden Fällen einen Deeplink zur richtigen Ansicht enthalten. Wenn das Gerät nicht unterstützt wird, MUSS dem Nutzer eine Meldung angezeigt werden, dass es sich um ein nicht unterstütztes Gerät handelt. Idealerweise wird auch angegeben, welche Geräte unterstützt werden. ERFORDERLICH
  8.2 Aufgaben von Schülern und Studenten SOLLTEN auf einem Mobilgerät bearbeitet werden können. EMPFOHLEN
9.0 Zusätzliche Ausstattungsmerkmale
  9.1 Wenn Lehrer Links zu Ihren Inhalten als Linkanhänge einfügen können, SOLLTEN Sie die Links zu Add-on-Anhängen aktualisieren. EMPFOHLEN
  9.2 Wenn Sie eine CourseWork-Integration verwenden, um Aufgaben außerhalb von Classroom zu erstellen, SOLLTEN Sie standardmäßig Add-on-Anhänge erstellen für alle Links, die mit Ihrem Add-on kompatibel sind. EMPFOHLEN

Änderungsprotokoll

Version 1.1 Aktualisiert am 5. Dezember 2024
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 Von ERFORDERLICH zu EMPFOHLEN geändert.
3.12 Entfernt.
5.3 Neu formuliert. Durch eine kürzlich vorgenommene Änderung können Add-on-Entwickler Aufgaben von Schülern und Studenten zuverlässig über die API einreichen.
Version 1.0 Aktualisiert am 30. April 2024
1.1 1.1 und 1.2 zu einer einzigen Anforderung zusammengefasst.
2.1 2.1 und 2.5 zu einer einzigen Anforderung zusammengefasst.
2.2 2.2, 2.3 und 2.4 zu einer einzigen Anforderung zusammengefasst.
3.5 3.5, 3.6 und 3.7 zu einer einzigen Anforderung zusammengefasst.
3.10 Anforderung hinzugefügt, dass das Add-on niemals in einen unverständlichen oder nicht wiederherstellbaren Zustand geraten darf.
3.11, 3.12 5.5, 5.6, 6.3, 6.4, 7.5 und 7.6 zu zwei neuen Anforderungen zusammengefasst.
4.2 Beschreibung der akzeptablen Anhangsuche erweitert.
4.3 Umnummeriert, ehemals 4.2. Auch von ERFORDERLICH zu EMPFOHLEN geändert.
4.4 Umnummeriert, ehemals 4.3.
4.5 Umnummeriert, ehemals 4.4.
5.2 Umnummeriert, ehemals 5.3.
5.3 Umnummeriert, ehemals 5.2.
9.1 Empfehlung hinzugefügt, eingefügte Links zu Anhängen zu aktualisieren.
9.2 Empfehlung hinzugefügt, standardmäßig Add-on-Anhänge zu erstellen, wenn CourseWork-Aufgaben programmatisch erstellt werden.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Entfernt.
Version 0.3 Aktualisiert am 22. November 2022
2.3 Korrektur der Anleitung zum Anmeldehinweis.
2.4 Szenario hinzugefügt, in dem die Implementierung von hd erforderlich ist.
3.2 „Pfad angeben“ neu formuliert.
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Anleitung für das Kopieren von Kursen für die studentViewUri, teacherViewUri und studentWorkReviewUri hinzugefügt.
Version 0.2 Aktualisiert am 29. Oktober 2021
1.3 Text angepasst, um die Absicht klarer zu machen.
3.1 „Das Add-on MUSS die allgemeinen Genehmigungsrichtlinien für den Google Workspace Marketplace einhalten die auf der Website zu finden sind“ hinzugefügt.
3.9 WCAG von ERFORDERLICH zu EMPFOHLEN geändert.
5.1 Von ERFORDERLICH zu EMPFOHLEN geändert.
5.3 „Wenn das Add-on aus dem iFrame herausgeleitet wird, MUSS im iFrame eine Vorschau der Aufgabe angezeigt werden“ hinzugefügt.
5.4 „Wenn das Add-on aus dem iFrame herausgeleitet wird, SOLLTEN Schüler und Studenten aufgefordert werden, zu Classroom zurückzukehren“ hinzugefügt.
8.1 „Wenn das Gerät nicht unterstützt wird, MUSS dem Nutzer eine Meldung angezeigt werden, dass es sich um ein nicht unterstütztes Gerät handelt. Idealerweise wird auch angegeben, welche Geräte unterstützt werden“ hinzugefügt.
8.2 Aufgaben von Schülern und Studenten auf Mobilgeräten von ERFORDERLICH zu EMPFOHLEN geändert.
Version 0.1 Aktualisiert am 22. September 2021
  Erste Version