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 anwendbaren erforderlichen Elemente erfüllen, um für die Aufnahme in den Google Workspace Marketplace genehmigt zu werden. Außerdem muss es als Add-on gekennzeichnet sein, das „mit Classroom funktioniert“.

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

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 Meldung 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 Anmeldung von Endnutzern
  2.1 Lehrkräfte müssen sich über die Google-Einmalanmeldung im Add-on anmelden.
Wenn Schüler oder Studenten aufgefordert werden, sich im Add-on anzumelden, müssen sie sich über die Google-Einmalanmeldung anmelden.		 ERFORDERLICH
  2.2 Das Add-on MUSS Google SSO verwenden, um Nutzer bei nachfolgenden Besuchen automatisch anzumelden, ohne eine Anmeldeaufforderung anzuzeigen.
Wenn der Anmeldehinweis nicht mit dem aktuell angemeldeten Nutzer übereinstimmt, 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 (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 Das Add-on sollte den aktuell angemeldeten Nutzer anzeigen. 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-Aufrufpfade in einem neuen Tab oder Fenster geöffnet wird, MUSS eine nutzerfreundliche Meldung zur 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 von Lehrkräften 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 bei der Einreichung bestätigen, dass diese Anforderung erfüllt ist und dass das Add-on auch bei zukünftigen Änderungen weiterhin den Anforderungen entspricht. 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 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 für die Schüler/Studenten zum Ausfüllen anzeigen und KEINE Antworten der Schüler/Studenten aus früheren Aufgaben oder Kursen im IFrame. EMPFOHLEN
4,0 Anhangssuche
  4,1 Wenn für einen Anhang eine Einreichung durch Schüler oder Studenten erforderlich ist, MUSS der Anhang ein studentWorkReviewUri enthalten, damit er als Aktivitätstyp und nicht als Inhaltstyp behandelt wird. ERFORDERLICH
  4,2 Der Attachment Discovery-Iframe MUSS eine Benutzeroberfläche bieten, die mindestens eine der folgenden Funktionen bietet:
  • Neue Inhalte zum Anhängen erstellen
  • Inhalte in einer Mediathek durchsuchen, auswählen und anhängen
  • Anleitung zum Anhängen von Inhalten von Ihrer Website oder anderen Produkten
 ERFORDERLICH
  4,3 Die Lehrkraft sollte alle für sie verfügbaren Inhalte und Aktivitäten finden und darauf zugreifen können. EMPFOHLEN
  4.4 Die Lehrkraft MUSS sich eine Vorschau des Inhalts oder der Aktivität ansehen können, bevor sie ihn mit der Aufgabe verknüpfen möchte. ERFORDERLICH
  4,5 Wenn der*die Lehrkraft Inhalte/Aktivitäten erstellen muss, bevor sie angehängt werden können, sollte dies im IFrame geschehen. 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 zu erledigen.
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 Arbeit als erledigt zu markieren, darf die Schaltfläche NICHT mit „Abgeben“ beschriftet sein, um Verwechslungen mit der Abgabeschaltfläche in Classroom zu vermeiden. ERFORDERLICH
6.0 Ansicht für Lehrkräfte
  6.1 Die Lehrkraft sollte sehen können, was die Schüler/Studenten sehen, wenn sie die Aufgabe erledigen. EMPFOHLEN
7.0 Bewertung der Schüler-/Studentenarbeit
  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 in der Ansicht studentWorkReviewUri KEINE Navigation zwischen Schülern/Studenten ermöglichen. Die Navigation zwischen Schülern/Studenten muss ausschließlich über die Classroom-Benutzeroberfläche erfolgen. ERFORDERLICH
8,0 Unterstützung für die mobile Classroom App
  8.1 Wenn über die mobile Classroom App eine teacherViewUri, studentViewUri oder studentWorkReviewUri gestartet wird, MUSS die URL entweder die mobile native App oder die mobile Webanwendung 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 Nachricht angezeigt werden, in der er darüber informiert wird, dass es sich um ein nicht unterstütztes Gerät handelt, und idealerweise auch, welche Geräte unterstützt werden. ERFORDERLICH
  8.2 Die Arbeit der Schüler und Studenten sollte 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 CourseWork 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 Letzte Aktualisierung: 30. April 2024
1.1 1.1 und 1.2 zu einer einzigen Anforderung kombiniert.
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 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 gelangen darf.
3:11, 3:12 Die Anforderungen 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 Funktionen für die Suche nach Anhängen wurde erweitert.
4,3 Neu nummeriert, zuvor 4.2. Außerdem wurde der Status von „ERFORDERLICH“ in „EMPFOHLEN“ geändert.
4.4 Neu nummeriert, zuvor 4.3.
4,5 Neu nummeriert, zuvor 4.4.
5.2 Neu nummeriert, zuvor 5.3.
5.3 Neu nummeriert, zuvor 5.2.
9,1 Es wurde eine Empfehlung hinzugefügt, eingefügte Links in Anhänge umzuwandeln.
9.2 Es wird empfohlen, beim programmatischen Erstellen von CourseWork-Aufgaben standardmäßig Add-on-Anhänge zu erstellen.
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 Ein Szenario eingefügt, 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 wurden erforderliche und empfohlene Hinweise für den Kurstext für studentViewUri, teacherViewUri und studentWorkReviewUri hinzugefügt.
Version 0.2 Aktualisiert am 29. Oktober 2021
1.3 Der Text wurde überarbeitet, um seine Absicht klarer zu formulieren.
3.1 Folgendes wurde hinzugefügt: „Das Add-on MUSS den allgemeinen GWM-Genehmigungsrichtlinien auf der Website entsprechen.“
3,9 In den WCAG wurde „ERFORDERLICH“ in „EMPFOHLEN“ geändert.
5.1 „ERFORDERLICH“ in „EMPFOHLEN“ geändert.
5.3 Hinzugefügt: „Wenn die Add-ons aus dem Iframe herausspringen, MUSS im Iframe eine Vorschau der Aufgabe zu sehen sein.“
5.4 Hinzugefügt: „Wenn das Add-on aus dem Iframe herausspringt, sollte eine Aufforderung angezeigt werden, zu Classroom zurückzukehren.“
8.1 Hinzugefügt: „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, und idealerweise auch, welche Geräte unterstützt werden.“
8.2 Die Option „Aufgaben für Schüler/Studenten auf Mobilgeräten“ wurde von „ERFORDERLICH“ zu „EMPFOHLEN“ geändert.
Version 0.1 Aktualisiert am 22. September 2021
  Erste Version