Anforderungen an Add-ons

Version 1.0, 30. April 2024

Die Kriterien auf dieser Seite gelten für alle Classroom-Add-ons. Ihr Add-on muss alle erforderlichen Elemente erfüllen, um für den Eintrag im Google Workspace Marketplace genehmigt zu werden, sowie ein Add-on, das mit Classroom kompatibel ist.

Die in diesem Dokument verwendeten Schlüsselwörter "MUSS", "DARF NICHT", "ERFORDERLICH", "WIRD", "WIRD NICHT", "SOLLTE", "SOLLTE NICHT", "EMPFOHLEN", "KÖNNEN" und "OPTIONAL" in diesem Dokument gelten gemäß RFC 2119.

Voraussetzungen

ID Typ
1.0 Endnutzerlizenz (falls zutreffend)
  1,1 Wenn der Nutzer keine Lizenz hat, MUSS eine nutzerfreundliche Nachricht angezeigt werden. In der Nachricht MUSS die Nachricht klar angegeben werden, warum das Add-on nicht verwendet werden kann, und dem Nutzer eine Abhilfemaßnahme vorschlagen. ERFORDERLICH
  1.3 Der Google Workspace Marketplace-Eintrag des Add-ons MÜSSEN Details zu den Lizenzierungsanforderungen enthalten, die möglicherweise für die Verwendung des Add-ons erforderlich sind. Wenn das Add-on eine kostenpflichtige Stufe hat, MUSS der Marketplace-Eintrag einen Link zu einer Webseite enthalten, auf der weitere Informationen zur Preisgestaltung oder zur Kontaktaufnahme mit einem Vertriebsmitarbeiter verfügbar sind. ERFORDERLICH
2.0 Endnutzeranmeldung
  2.1 Nutzer von Lehrkräften MÜSSEN sich mit der Einmalanmeldung (SSO) von Google im Add-on anmelden.
Wenn Schüler oder Studenten dazu aufgefordert werden, sich im Add-on anzumelden, MÜSSEN sie sich mit der Einmalanmeldung (SSO) von Google anmelden.		 ERFORDERLICH
  2.2 Das Add-on MÜSSEN die Google-SSO verwenden, um einen Nutzer bei nachfolgenden Besuchen automatisch anzumelden, ohne dass eine Aufforderung zur Anmeldung angezeigt wird.
Wenn der Anmeldehinweis keine Übereinstimmung mit dem aktuell angemeldeten Nutzer ergibt, muss der Nutzer vom Add-on mit einer Anmeldeschaltfläche aufgefordert und den „login_hint“ an die Authentifizierungsbibliothek übergeben werden, um ungültige Konten herauszufiltern.		 ERFORDERLICH
  2.7 Wenn der Classroom-Nutzer nicht bereits im Add-on angemeldet ist (siehe Anmeldehinweis), MUSS das Add-on die Schaltfläche „Über Google anmelden“ einblenden, damit der Anmeldeprozess durch eine explizite Nutzeraktion ausgelöst wird.
Hinweis: Das ist erforderlich, um die Branding-Richtlinien von Google zu erfüllen und Pop-up-Blocker zu vermeiden.		 ERFORDERLICH
  2,8 Im Add-on sollte angezeigt werden, wer der aktuell angemeldete Nutzer ist. EMPFOHLEN
3.0 Allgemein
  3.1 Das Add-on MUSS den allgemeinen Genehmigungsrichtlinien für den Google Workspace Marketplace entsprechen. ERFORDERLICH
  3.2 Wenn eine Aufgabe über einen der iFrame-Pfade in einem neuen Tab oder Fenster geöffnet wird, MUSS eine nutzerfreundliche Nachricht für die Rückkehr zu Classroom angezeigt werden. ERFORDERLICH
  3.3 Der Nutzer DARF die User Journey nur mit einem Add-on-Workflow abschließen und nicht zu einem Kurs-Work-Flow wechseln oder die Schaltfläche zum Teilen in Classroom verwenden. ERFORDERLICH
  3,4 Lokalisierungsauswahl: Die Sprache sollte auf den lokalen Einstellungen basieren, die vom Browser festgelegt werden (sofern verfügbar). EMPFOHLEN
  3,5 Wenn in einem Add-on maxPoints definiert wird, MÜSSEN auch pointsEarned festgelegt werden, wenn ein Schüler oder Student eine Aufgabe mithilfe von gespeicherten Anmeldedaten der Lehrkraft erledigt (empfohlen) ODER wenn die Lehrkraft die Aufgabe im iFrame von „Aufgaben von Schülern/Studenten“ öffnet. ERFORDERLICH
  3,9 Add-ons SOLLTEN den WCAG 2.1-Richtlinien zur Barrierefreiheit entsprechen. Add-on-Entwickler müssen selbst angeben, dass diese Anforderung zum Zeitpunkt der Einreichung erfüllt ist und dass das Add-on weiterhin an künftige Änderungen am Add-on angepasst wird. EMPFOHLEN
  3,10 Alle Fehler, die bei einem Nutzer festgestellt werden, MÜSSEN lesbar sein. ERFORDERLICH
  3.11 Wenn studentViewUri, teacherViewUri oder studentWorkViewUri über eine kopierte Aufgabe oder einen kopierten Kurs gestartet wird, DARF für das Add-on KEINE Fehlerseite im iFrame angezeigt werden. ERFORDERLICH
  3.12 Wenn studentViewUri, teacherViewUri oder studentWorkViewUri über eine kopierte Aufgabe oder einen kopierten Kurs gestartet wird, sollte das Add-on einen neuen Anhang anzeigen, den der Schüler/Student abschließen kann. Die Antworten eines Schülers oder Studenten aus früheren Aufgaben oder Kursen sollten NICHT im iFrame angezeigt werden. EMPFOHLEN
4.0 Erkennung von Anhängen
  4.1 Wenn für einen Anhang das Einreichen eines Schülers/Studenten erforderlich ist, MUSS er eine studentWorkReviewUri enthalten, damit er als Aktivitätstyp und nicht als Anhang mit Inhaltstyp behandelt wird. ERFORDERLICH
  4,2 Der iFrame der Anhangserkennung muss eine Benutzeroberfläche bieten, die mindestens eines der folgenden Elemente enthält:
  • Neue Inhalte zum Anhängen erstellen
  • In Inhaltsbibliotheken stöbern, Inhalte auswählen und anhängen
  • Anleitung zum Anhängen von Inhalten von Ihrer Website oder anderen Produkten
 ERFORDERLICH
  4,3 Die Lehrkraft sollte alle Inhalte und Aktivitäten finden und darauf zugreifen können, die ihr zur Verfügung stehen. EMPFOHLEN
  4.4 Die Lehrkraft MUSS sich eine Vorschau des Inhalts oder der Aktivität ansehen können, bevor sie sie an die Aufgabe anhängen kann. ERFORDERLICH
  4,5 Wenn die Lehrkraft Inhalte oder Aktivitäten erst erstellen muss, bevor sie angehängt werden können, SOLLTEN diese im iFrame erledigt werden. EMPFOHLEN
5.0 Ansicht für Schüler/Studenten
  5.1 Nach der Einführung von studentViewUri sollte das Add-on den Nutzer NICHT aus dem iFrame entfernen, um eine Aufgabe auszuführen.
Wenn der Nutzer durch das Add-on nicht mehr im iFrame angezeigt wird, MÜSSEN die Schüler oder Studenten dazu aufgefordert werden, zu Classroom zurückzukehren.		 EMPFOHLEN
  5,2 Wenn eine Add-on-Aktivität aus dem iFrame herausspringt, MUSS es eine Vorschau der Aufgabe im iFrame geben. ERFORDERLICH
  5.3 Wenn ein Schüler oder Student bei einer Aktivität eine Aktion ausführen muss, um die Aufgabe als erledigt zu markieren, DARF die Schaltfläche NICHT mit „Abgeben“ beschriftet sein, damit Verwechslungen mit der Schaltfläche zum Abgeben in Classroom vermieden werden. ERFORDERLICH
6,00 Lehreransicht
  6.1 Die Lehrkraft sollte sehen können, was der Schüler oder Student sieht, wenn er die Aufgabe erledigt. EMPFOHLEN
7,0 Aufgaben von Schülern/Studenten überprüfen
  7.1 Wenn studentWorkReviewUri gestartet wird, MUSS das Add-on die Arbeit dieses Schülers/Studenten innerhalb des iFrames zur Prüfung durch die Lehrkraft rendern. Zusätzliches Material wird möglicherweise außerhalb des iFrames verlinkt. ERFORDERLICH
  7,2 Das Add-on DARF NICHT die Navigation zwischen Schülern/Studenten in der Ansicht „studentWorkReviewUri“ aktivieren. Die Navigation zwischen den Schülern MUSS nur über die Classroom-Benutzeroberfläche erfolgen. ERFORDERLICH
8,0 Support für Classroom auf Mobilgeräten
  8.1 Wenn die mobile Classroom App teacherViewUri, studentViewUri oder studentWorkReviewUri startet, MUSS die URL entweder die mobile native App des Partners oder die mobile Web-App des Partners öffnen und in beiden Fällen über einen Deeplink zur richtigen Ansicht weiterleiten. Wenn das Gerät nicht unterstützt wird, MUSS dem Nutzer eine Nachricht angezeigt werden, dass es sich um ein nicht unterstütztes Gerät handelt und idealerweise welche Geräte unterstützt werden. ERFORDERLICH
  8.2 Die Aufgaben von Schülern sollten auf einem Mobilgerät erledigt werden können. EMPFOHLEN
9,0 Zusätzliche Ausstattungsmerkmale
  9,1 Wenn Lehrkräfte Links zu Ihren Inhalten als Linkanhänge einfügen können, SOLLTEN Sie Links auf Add-on-Anhänge aktualisieren. EMPFOHLEN
  9.2 Wenn Sie Aufgaben außerhalb von Classroom über die Integration von KursWork erstellen, sollten Sie für alle Links, die mit Ihrem Add-on kompatibel sind, standardmäßig Add-on-Anhänge erstellen. EMPFOHLEN

Änderungsprotokoll

Version 1.0 Aktualisiert: 30. April 2024
1,1 1.1 und 1.2 in einer Anforderung kombiniert.
2.1 2.1 und 2.5 in einer Anforderung kombiniert.
2.2 2.2, 2.3 und 2.4 in einer Anforderung kombiniert.
3,5 3.5, 3.6 und 3.7 in einer Anforderung kombiniert.
3,10 Es wurde die Anforderung hinzugefügt, dass das Add-on niemals in einen unverständlichen oder nicht wiederherstellbaren Zustand versetzt wird.
3:11, 3:12 5.5, 5.6, 6.3, 6.4, 7.5 und 7.6 wurden zu zwei neuen Anforderungen kombiniert.
4,2 Die Beschreibung der zulässigen Optionen für die Anhangerkennung wurde erweitert.
4,3 Neu nummeriert, früher 4.2. Außerdem von REQUIRED zu RECOMMENDED geändert.
4.4 Neu nummeriert, früher 4.3.
4,5 Neu nummeriert, früher 4.4.
5,2 Neu nummeriert, früher 5.3.
5.3 Neu nummeriert, früher 5.2.
9,1 Es wurde eine Empfehlung hinzugefügt, ein Upgrade eingefügter Links in Anhänge durchzuführen.
9.2 Es wurde eine Empfehlung hinzugefügt, Add-on-Anhänge standardmäßig zu erstellen, wenn KursWork-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 für Anmeldehinweise.
2.4 Es wurde ein Szenario aufgenommen, bei dem die Implementierung von hd erforderlich ist.
3.2 „Pfad angeben“ umformuliert.
5,5, 5,6, 6,3, 6,4, 7,5, 7,6 Erforderliche und empfohlene Kursinhalte für studentViewUri, teacherViewUri und studentWorkReviewUri wurden hinzugefügt.
Version 0.2 Aktualisiert: 29. Oktober 2021
1.3 Der Text wurde so optimiert, dass er klarer erkennbar ist.
3.1 Folgendes wurde hinzugefügt: „Das Add-on MUSS den allgemeinen GWM-Genehmigungsrichtlinien auf der Website entsprechen.“
3,9 Die WCAG hat REQUIRED zu RECOMMENDED geändert.
5.1 REQUIRED zu RECOMMENDED geändert.
5.3 "Wenn die Add-ons aus dem iFrame herausragen, MÜSSEN im iFrame eine Vorschau der Aufgabe angezeigt werden." hinzugefügt
5.4 Folgendes wurde hinzugefügt: „Wenn das Add-on aus dem iFrame herausspringt, SOLLTEN die Schüler/Studenten aufgefordert werden, zu Classroom zurückzukehren.“
8.1 Hinzugefügt: „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 und idealerweise welche Geräte unterstützt werden.“
8.2 Die mobilen Aufgaben von Schülern/Studenten wurden von REQUIRED zu RECOMMENDED geändert.
Version 0.1 Aktualisiert: 22. September 2021
  Erste Version