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 erforderlichen Elemente erfüllen, um für die Aufnahme in den Google Workspace Marketplace und als Add-on, das mit Classroom funktioniert, genehmigt zu werden.

Die Schlüsselwörter „MUSS“, „DARF NICHT“, „ERFORDERLICH“, „WIRD“, „WIRD NICHT“, „SOLLTE“, „SOLLTE NICHT“, „EMPFOHLEN“, „KANN“ und „OPTIONAL“ in diesem Dokument sind wie in RFC 2119 beschrieben zu interpretieren.

Voraussetzungen

ID Typ
1.0 Endnutzerlizenz (falls zutreffend)
  1.1 Dem Nutzer SOLLTE eine benutzerfreundliche Meldung angezeigt werden, wenn er keine Lizenz hat. In der Meldung SOLLTE der Grund für die Nichtverwendung des Add-ons deutlich angegeben und dem Nutzer eine Vorgehensweise zur Behebung der Situation vorgeschlagen werden. EMPFOHLEN
  1.3 Im Google Workspace Marketplace-Eintrag für das Add‑on SOLLTEN Details zu den Lizenz- und Aboanforderungen angegeben werden, die für die Nutzung des Add‑ons erforderlich sind. Wenn das Add-on eine kostenpflichtige Stufe hat, SOLLTE im Marketplace-Eintrag ein Link zu einer Webseite mit weiteren Informationen zu den Preisen oder dazu, wie Sie einen Vertriebsmitarbeiter kontaktieren können, angegeben werden. EMPFOHLEN
2.0 Endnutzeranmeldung
  2.1 Lehrkräfte 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 Auth-Bibliothek übergeben, um ungültige Konten herauszufiltern.		 ERFORDERLICH
  2.7 Wenn der Classroom-Nutzer noch nicht im Add-on angemeldet ist (was anhand des Anmeldehinweises ermittelt wird), MUSS im Add-on die Schaltfläche „Mit Google anmelden“ angezeigt werden, damit der Anmeldevorgang durch eine explizite Nutzeraktion ausgelöst wird.
Hinweis: Dies ist erforderlich, um die Google-Markenrichtlinien einzuhalten 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-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 DARF den Vorgang NUR über einen Add-on-Workflow abschließen und NICHT zu einem CourseWork-Workflow wechseln oder die Classroom-Schaltfläche „Teilen“ verwenden. ERFORDERLICH
  3.4 Lokalisierung: Die Sprache SOLLTE auf der vom Browser festgelegten lokalen Einstellung basieren, sofern verfügbar. EMPFOHLEN
  3,5 Wenn ein Add-on maxPoints definiert, MUSS es auch pointsEarned festlegen, wenn ein Schüler eine Aufgabe mit gespeicherten Anmeldedaten der Lehrkraft abschließt (empfohlen) ODER wenn die Lehrkraft die Aufgabe im iframe „Student Work Review“ (Überprüfung von Schülerarbeiten) öffnet. ERFORDERLICH
  3,9 Add-ons SOLLTEN den WCAG 2.1-Richtlinien zur Barrierefreiheit der Stufe AA entsprechen. Add-on-Entwickler müssen bei der Einreichung selbst bestätigen, dass diese Anforderung erfüllt ist und dass das Add-on auch bei zukünftigen Änderungen des Add-ons weiterhin den Anforderungen entspricht. EMPFOHLEN
  3,10 Alle Fehler, die ein Nutzer erhält, 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 Anhangserkennung
  4,1 Wenn für einen Anhang eine Schüler-/Studentenabgabe erforderlich ist, MUSS der Anhang ein studentWorkReviewUri enthalten, damit er als Aktivitätstyp und nicht als Inhaltsanhang behandelt wird. ERFORDERLICH
  4,2 Das Attachment Discovery-iFrame MUSS eine Benutzeroberfläche bieten, die mindestens eine der folgenden Optionen enthält:
  • Neue Inhalte zum Anhängen erstellen
  • Inhaltsbibliothek durchsuchen, Inhalte auswählen und anhängen
  • Anleitung zum Anhängen von Inhalten von Ihrer Website oder aus anderen Produkten
 ERFORDERLICH
  4,3 Die Lehrkraft SOLLTE alle Inhalte/Aktivitäten finden und darauf zugreifen können, die ihr zur Verfügung stehen. EMPFOHLEN
  4.4 Die Lehrkraft SOLLTE sich eine Vorschau der Inhalte/Aktivität ansehen können, bevor sie sich dazu entschließt, sie an die Aufgabe anzuhängen. 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 Lernende
  5.1 Wenn das studentViewUri gestartet wird, SOLLTE der Nutzer NICHT aus dem iFrame herausgeholt werden, um eine Aufgabe zu erledigen.
Wenn der Nutzer aus dem iFrame herausgeholt wird, MUSS es eine Nachricht oder einen anderen Hinweis für die Schüler und Studenten geben, damit sie zu Classroom zurückkehren können.		 EMPFOHLEN
  5.2 Wenn eine Add-on-Aktivität aus dem iFrame herausragt, SOLLTE im iFrame eine Vorschau der Aufgabe angezeigt werden. EMPFOHLEN
  5.3 Falls vorhanden, MUSS eine Schaltfläche oder ein Link in der Aktivität mit der Bezeichnung Abgeben eine API-Anfrage zum Einreichen der Arbeit des Schülers oder Studenten zur Überprüfung durch die Lehrkraft auslösen. ERFORDERLICH
6.0 Lehreransicht
  6.1 Der Kursleiter SOLLTE sehen können, was der Schüler/Student sieht, wenn er die Aufgabe bearbeitet. EMPFOHLEN
7.0 Überprüfung von Schülerarbeiten
  7.1 Wenn studentWorkReviewUri gestartet wird, MUSS das Add-on die Aufgabe des Schülers/Studenten zur Überprüfung durch den Kursleiter im iFrame rendern. Zusätzliches Material kann außerhalb des iFrames verlinkt werden. ERFORDERLICH
  7.2 Das Add-on DARF KEINE Navigation zwischen Schülern/Studenten in der Ansicht studentWorkReviewUri ermöglichen. Die Navigation zwischen Schülern/Studenten darf NUR über die Classroom-Benutzeroberfläche erfolgen. ERFORDERLICH
8.0 Unterstützung für mobile Geräte in Classroom
  8.1 Wenn die mobile Classroom App eine teacherViewUri, studentViewUri oder studentWorkReviewUri startet, 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, in der er darüber informiert wird, dass es sich um ein nicht unterstütztes Gerät handelt. Idealerweise wird auch angegeben, welche Geräte unterstützt werden. ERFORDERLICH
  8.2 Schüleraufgaben 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 in Add‑on-Anhänge umwandeln. EMPFOHLEN
  9.2 Wenn Sie eine Integration für Kursaufgaben 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 erfolgte Änderung können Add-on-Entwickler Schülerarbeiten zuverlässig über die API einreichen.
Version 1.0 Aktualisiert am 30. April 2024
1.1 Die Anforderungen 1.1 und 1.2 wurden zu einer einzigen Anforderung zusammengefasst.
2.1 Die Anforderungen 2.1 und 2.5 wurden zu einer einzigen Anforderung zusammengefasst.
2.2 Die Anforderungen 2.2, 2.3 und 2.4 wurden zu einer einzigen Anforderung zusammengefasst.
3,5 Die Anforderungen für die Versionen 3.5, 3.6 und 3.7 wurden zusammengefasst.
3,10 Es wurde eine Anforderung hinzugefügt, dass das Add‑on niemals in einen unverständlichen oder nicht wiederherstellbaren Zustand geraten darf.
3.11, 3.12 Die Anforderungen 5.5, 5.6, 6.3, 6.4, 7.5 und 7.6 wurden in zwei neue Anforderungen zusammengefasst.
4,2 Die Beschreibung akzeptabler Funktionen zur Anhangsuche wurde erweitert.
4,3 Neu nummeriert, ehemals 4.2. Auch von ERFORDERLICH zu EMPFOHLEN geändert.
4.4 Neu nummeriert, ehemals 4.3.
4,5 Neu nummeriert, früher 4.4.
5.2 Neu nummeriert, ehemals 5.3.
5.3 Neu nummeriert, ehemals 5.2.
9,1 Es wurde eine Empfehlung hinzugefügt, eingefügte Links auf Anhänge zu aktualisieren.
9.2 Es wurde eine Empfehlung hinzugefügt, Add-on-Anhänge standardmäßig zu erstellen, wenn Kursaufgaben 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 Die Anleitung zum Anmeldehinweis wurde korrigiert.
2.4 Ein Szenario wurde aufgenommen, in dem die Implementierung von hd erforderlich ist.
3.2 „Pfad angeben“ wurde umformuliert.
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Es wurde eine Anleitung zum Kopieren von Kursen für die Felder studentViewUri, teacherViewUri und studentWorkReviewUri hinzugefügt.
Version 0.2 Aktualisiert am 29. Oktober 2021
1.3 Der Text wurde überarbeitet, um die Intention klarer zu machen.
3.1 Der folgende Hinweis wurde hinzugefügt: „Das Add-on MUSS den allgemeinen GWM-Genehmigungsrichtlinien entsprechen, die auf der Website zu finden sind.“
3,9 Die WCAG haben „ERFORDERLICH“ in „EMPFOHLEN“ geändert.
5.1 „ERFORDERLICH“ wurde zu „EMPFOHLEN“ geändert.
5.3 Der folgende Satz wurde hinzugefügt: „Wenn die Add-ons aus dem iFrame herausspringen, MUSS im iFrame eine Vorschau der Aufgabe zu sehen sein.“
5.4 „Wenn das Add-on aus dem iFrame herausragt, SOLLTE eine Aufforderung für Schüler/Studenten angezeigt werden, zu Classroom zurückzukehren.“
8.1 „Wenn das Gerät nicht unterstützt wird, MUSS dem Nutzer eine Meldung angezeigt werden, in der er darüber informiert wird, dass es sich um ein nicht unterstütztes Gerät handelt. Idealerweise wird auch angegeben, welche Geräte unterstützt werden.“
8.2 Die mobile Arbeit der Schüler/Studenten wurde von „REQUIRED“ zu „RECOMMENDED“ geändert.
Version 0.1 Aktualisiert am 22. September 2021
  Erste Version