Anforderungen an Add-ons

Version 1.0, 30. April 2024.

Die Kriterien auf dieser Seite gelten für alle Classroom-Add-ons. Das Add-on muss alle erforderlichen Elemente enthalten, um für die Aufnahme im Google Workspace Marketplace zugelassen zu werden, sowie ein Add-on mit der Kennzeichnung „Funktioniert mit Classroom“.

Die Schlüsselwörter "MÜSSEN", "DÜRFEN NICHT", "ERFORDERLICH", "SELLE", "SOLLTE NICHT", "SOLLTE", "SOLLTE NICHT", "EMPFOHLEN", "KÖNNEN" und "OPTIONAL" in diesem Dokument gemäß RFC 2119 interpretiert werden.

Voraussetzungen

ID Typ
1.0 Endnutzerlizenz (falls zutreffend)
  1,1 Eine nutzerfreundliche Mitteilung MUSS dem Nutzer angezeigt werden, wenn er keine Lizenz hat. In der Nachricht MUSS der Grund klar angegeben werden, warum das Add-on nicht verwendet werden kann, und dem Nutzer eine Vorgehensweise zur Behebung des Problems vorzuschlagen. ERFORDERLICH
  1.3 Im Google Workspace Marketplace-Eintrag des Add-ons MÜSSEN Details zu den Lizenzierungsanforderungen angegeben sein, 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, die weitere Informationen zu Preisen oder zur Kontaktaufnahme mit einem Vertriebsmitarbeiter enthält. ERFORDERLICH
2.0 Endnutzeranmeldung
  2.1 Lehrkräfte MÜSSEN sich im Add-on mit Google SSO anmelden.
Wenn Schüler oder Studenten aufgefordert werden, sich im Add-on anzumelden, MÜSSEN sie sich mit Google SSO anmelden.
ERFORDERLICH
  2.2 Das Add-on MUSS Google SSO verwenden, um einen Nutzer bei nachfolgenden Besuchen automatisch anzumelden, ohne dass eine Aufforderung zur Anmeldung angezeigt wird.
Wenn der Anmeldehinweis nicht mit dem aktuell angemeldeten Nutzer übereinstimmt, MUSS der Nutzer über das Add-on eine Anmeldeschaltfläche einblenden und „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 Sie anhand des Anmeldehinweiss feststellen können), MUSS das Add-on die Schaltfläche „Über Google anmelden“ anzeigen, damit der Anmeldevorgang explizit 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 Das Add-on SOLLTE anzeigen, 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 eine der iFrame-Journeys in einem neuen Tab oder Fenster gestartet wird, MÜSSEN eine nutzerfreundliche Meldung angezeigt werden, um zu Classroom zurückzukehren. ERFORDERLICH
  3.3 Die Nutzer DÜRFEN den Prozess nur mit einem Add-on-Workflow abschließen und nicht zu einem „courseWork“-Ablauf wechseln oder die Schaltfläche zum Freigeben in Classroom verwenden. ERFORDERLICH
  3,4 Lokalisierungsauswahl: Die Sprache MUSS auf den lokalen Einstellungen basieren, die vom Browser festgelegt werden, sofern verfügbar. EMPFOHLEN
  3,5 Wenn in einem Add-on maxPoints definiert ist, MUSS auch pointsEarned festgelegt werden, wenn ein Schüler oder Student mit gespeicherten Anmeldedaten der Lehrkraft eine Aufgabe abschließt (empfohlen) ODER wenn die Lehrkraft die Aufgabe im iFrame für die Prüfung der Aufgabe von Schülern/Studenten öffnet. ERFORDERLICH
  3,9 Add-ons MÜSSEN den WCAG-2.1-AA-Richtlinien zur Barrierefreiheit entsprechen. Add-on-Entwickler geben selbst an, dass diese Anforderung zum Zeitpunkt der Einreichung erfüllt ist und dass das Add-on weiterhin allen zukünftigen Änderungen am Add-on entspricht. EMPFOHLEN
  3,10 Alle Fehler, die Nutzer erkennen, MÜSSEN menschenlesbar sein. ERFORDERLICH
  3.11 Wenn studentViewUri, teacherViewUri oder studentWorkViewUri über eine kopierte Aufgabe oder einen kopierten Kurs gestartet wird, DARF das Add-on KEINE Fehlerseite im iFrame anzeigen. 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 erledigen kann. Die Antworten eines Schülers/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 eine Aufgabe von einem Schüler/Studenten erforderlich ist, MUSS der Anhang eine studentWorkReviewUri enthalten, damit er als Aktivitätstyp und nicht als Anhang mit einem Inhaltstyp behandelt wird. ERFORDERLICH
  4,2 Der iFrame für die Anhangserkennung MUSS eine Benutzeroberfläche bereitstellen, die mindestens eine der folgenden Optionen unterstützt:
  • Neue Inhalte zum Anhängen erstellen
  • Inhalte aus der Mediathek suchen, auswählen und anhängen
  • Anleitung zum Anhängen von Inhalten von Ihrer Website oder anderen Produkten
ERFORDERLICH
  4,3 Die Lehrkraft SOLLTE in der Lage sein, alle für die Lehrkraft verfügbaren Inhalte und Aktivitäten zu finden und auf sie zuzugreifen. EMPFOHLEN
  4.4 Die Lehrkraft MÜSSEN in der Lage sein, eine Vorschau des Inhalts/der Aktivität anzuzeigen, bevor er sich zustimmt, der Aufgabe beigefügt zu werden. ERFORDERLICH
  4,5 Muss die Lehrkraft Inhalte/Aktivitäten erstellen, bevor diese angehängt werden können, MÜSSEN diese Aufgaben im iFrame erledigt werden. EMPFOHLEN
5.0 Ansicht für Schüler/Studenten
  5.1 Wenn studentViewUri gestartet wird, DARF das Add-on den Nutzer NICHT aus dem iFrame herausnehmen, um eine Aufgabe zu erledigen.
Wenn der Nutzer durch das Add-on den iFrame verlässt, MÜSSEN ihm eine Nachricht oder ein anderer Hinweis angezeigt werden, dass die Schüler oder Studenten zu Classroom zurückkehren können.
EMPFOHLEN
  5,2 Wenn eine Add-on-Aktivität aus dem iFrame herausspringt, MUSS eine Vorschau der Aufgabe im iFrame angezeigt werden. ERFORDERLICH
  5.3 Wenn Schüler oder Studenten bei einer Aktivität eine Aktion ausführen müssen, um die Aufgabe als erledigt zu markieren, DARF die Schaltfläche NICHT mit „Abgeben“ beschriftet sein, um Verwechslungen mit der Schaltfläche „Abgeben“ in Classroom zu vermeiden. ERFORDERLICH
6,0 Ansicht für Lehrkräfte
  6.1 Die Lehrkraft SOLLTE sehen, was der Schüler oder Student sieht, wenn er eine Aufgabe erledigt. EMPFOHLEN
7,0 Prüfung der Schüler/Studenten
  7.1 Wenn studentWorkReviewUri gestartet wird, MUSS das Add-on die Aufgabe dieses Schülers/Studenten im iFrame für die Überprüfung durch die Lehrkraft rendern. Zusätzliches Material kann außerhalb des iFrames verlinkt werden. ERFORDERLICH
  7,2 Das Add-on DARF DIE Navigation zwischen den Schülern in der Ansicht „studentWorkReviewUri“ NICHT ermöglichen. Die Navigation zwischen den Schülern MUSS nur über die Classroom-Benutzeroberfläche erfolgen. ERFORDERLICH
8,0 Unterstützung für mobile Classroom-Apps
  8.1 Wenn die mobile Classroom App teacherViewUri, studentViewUri oder studentWorkReviewUri startet, MUSS mit der URL entweder die mobile native App des Partners oder die mobile Web-App des Partners geöffnet werden. In beiden Fällen MUSS per Deeplink zur richtigen Ansicht weitergeleitet werden. Wenn das Gerät nicht unterstützt wird, MUSS eine Nachricht angezeigt werden, um den Nutzer zu informieren, dass es sich um ein nicht unterstütztes Gerät handelt und idealerweise auch die unterstützten Geräte. ERFORDERLICH
  8.2 Die Aufgaben von Schülern/Studenten sollen 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 umstellen. EMPFOHLEN
  9.2 Wenn Sie eine CourseWork-Integration nutzen, um Aufgaben außerhalb von Classroom zu erstellen, MÜSSEN Sie standardmäßig für alle Links, die mit Ihrem Add-on kompatibel sind, 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 nie in einen unverständlichen oder nicht wiederherstellbaren Status übergeht.
3,11, 3,12 5.5, 5.6, 6.3, 6.4, 7.5 und 7.6 in zwei neuen Anforderungen kombiniert.
4,2 Die Beschreibung der zulässigen Anforderungen bei der Anhangerkennung wurde erweitert.
4,3 Neu nummeriert, früher 4.2. Auch von REQUIRED zu RECOMMENDED geändert.
4.4 Neu nummeriert, früher 4.3.
4,5 Neu nummeriert, vorher 4.4.
5,2 Neu nummeriert, früher 5.3.
5.3 Neu nummeriert, früher 5.2.
9,1 Es wurde eine Empfehlung zum Aktualisieren eingefügter Links in Anhänge hinzugefügt.
9.2 Es wurde die Anforderung hinzugefügt, standardmäßig Add-on-Anhänge 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: 22. Nov. 2022
2.3 Korrektur der Hinweise für Anmeldehinweise.
2.4 Einbindung eines Szenarios, bei dem die Implementierung von hd erforderlich ist.
3.2 Umformuliert „Pfad angeben“.
5,5, 5,6, 6,3, 6,4, 7,5, 7,6 Es wurden Kurstexte hinzugefügt, die für studentViewUri, teacherViewUri und studentWorkReviewUri erforderlich sind und empfohlen werden.
Version 0.2 Aktualisiert am 29. Oktober 2021
1.3 Der Text wurde optimiert, damit er die Absicht deutlicher darstellt.
3.1 „Das Add-on MUSS den allgemeinen GWM-Genehmigungsrichtlinien auf der Website entsprechen“ wurde hinzugefügt.
3,9 WCAG wurde von REQUIRED zu RECOMMENDED geändert.
5.1 REQUIRED zu RECOMMENDED geändert.
5.3 Hinzugefügt: „Wenn die Add-ons aus dem iFrame herausspringen, MUSS eine Vorschau der Aufgabe im iFrame vorhanden sein.“
5.4 Hinzugefügt: „Wenn das Add-on aus dem iFrame herausspringt, sollte es eine Aufforderung für die Schüler geben, zu Classroom zurückzukehren.“
8.1 Hinzugefügt: „Wenn das Gerät nicht unterstützt wird, MUSS eine Nachricht für den Nutzer angezeigt werden, um ihn über das nicht unterstützte Gerät und idealerweise darüber zu informieren, welche Geräte unterstützt werden.“
8.2 Die mobilen Aufgaben von Schülern/Studenten wurden von ERFORDERLICH zu EMPFOHLEN geändert.
Version 0.1 Aktualisiert: 22. September 2021
  Erste Version