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 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, sollte ihm eine nutzerfreundliche Nachricht angezeigt werden. Die Meldung MUSS den Grund für die Nichtverfügbarkeit des Add-ons klar angeben und dem Nutzer eine Maßnahme zur Behebung des Problems vorschlagen. EMPFOHLEN
  1.3 Im Google Workspace Marketplace-Eintrag für das Add-on MÜSSEN 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, MUSS der Marketplace-Eintrag einen Link zu einer Webseite enthalten, auf der weitere Informationen zu Preisen oder zur Kontaktaufnahme mit einem Vertriebsmitarbeiter verfügbar sind. EMPFOHLEN
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 sich der Classroom-Nutzer nicht bereits im Add-on angemeldet hat (wie am Anmeldehinweis zu erkennen), muss das Add-on die Schaltfläche „Über Google anmelden“ anzeigen, damit der Nutzer die Anmeldung auslösen kann.
Hinweis: Dies ist erforderlich, um die Google-Markenrichtlinien einzuhalten, und hilft auch, 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, sollte eine nutzerfreundliche Meldung angezeigt werden, um zu Classroom zurückzukehren. EMPFOHLEN
  3.3 Der Nutzer MUSS den gesamten Ablauf nur mit einem Add-on-Workflow abschließen und darf nicht zu einem Kursworkflow wechseln oder die Schaltfläche „Mit Classroom teilen“ verwenden. ERFORDERLICH
  3.4 Auswahl der Lokalisierung: Die Sprache sollte auf den lokalen Einstellungen des Browsers basieren, sofern verfügbar. EMPFOHLEN
  3,5 Wenn ein Add-on maxPoints definiert, MUSS es auch pointsEarned festlegen, wenn ein Schüler oder Student eine Aufgabe mit gespeicherten Anmeldedaten der Lehrkraft abgibt (empfohlen) ODER wenn die Lehrkraft die Aufgabe im IFrame für die Überprüfung der Schüler-/Studentenarbeit öffnet. ERFORDERLICH
  3,9 Add-ons MÜSSEN den Richtlinien für Barrierefreiheit der WCAG 2.1, Konformitätsstufe AA, 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 ein Nutzer feststellt, MÜSSEN für Menschen lesbar sein. EMPFOHLEN
  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
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 mit mindestens einer der folgenden Funktionen bieten:
  • 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 sollte sich eine Vorschau der Inhalte/Aktivitäten ansehen können, bevor sie sich dazu verpflichtet, sie an die Aufgabe anzuhängen. EMPFOHLEN
  4,5 Wenn 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 Wenn die studentViewUri gestartet wird, DARF das Add-on den Nutzer NICHT aus dem iFrame herauslösen, um eine Aufgabe auszuführen.
Wenn das Add-on den Nutzer aus dem iFrame herauslöst, MUSS es eine Nachricht oder einen anderen Hinweis geben, dass er zu Classroom zurückkehren muss.		 EMPFOHLEN
  5.2 Wenn eine Add-on-Aktivität aus dem Iframe herausspringt, sollte im Iframe eine Vorschau der Aufgabe zu sehen sein. EMPFOHLEN
  5.3 Falls vorhanden, MUSS eine Schaltfläche oder ein Link in der Aktivität mit der Bezeichnung Abgeben eine API-Anfrage auslösen, um die Arbeit des Schülers oder Studenten zur Überprüfung durch die Lehrkraft einzureichen. 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 die studentWorkReviewUri gestartet wird, MUSS das Add-on die Arbeit des Schülers/Studenten zur Überprüfung durch den Lehrer im IFrame rendern. Zusätzliche Materialien können außerhalb des iFrames verlinkt sein. 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 in Add-on-Anhänge umwandeln. 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 für alle Links erstellen, 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“ in „EMPFOHLEN“ geändert.
3.12 Entfernt.
5.3 Formulierung geändert. Durch eine kürzlich erfolgte Änderung können Add-on-Entwickler die Einreichungen von Schülern und Studenten über die API zuverlässig einreichen.
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 Die Versionen 3.5, 3.6 und 3.7 wurden zu einer einzigen Anforderung zusammengefasst.
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 so angepasst, dass seine Absicht klarer ist.
3.1 Hinzugefügt: „Das Add-on MUSS den allgemeinen Genehmigungsrichtlinien für Google Unternehmensprofil 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