Conditions requises pour les modules complémentaires

Version 1.1, 5 décembre 2024.

Les critères de cette page s'appliquent à tous les modules complémentaires Classroom. Votre module complémentaire doit répondre à tous les éléments requis applicables pour être approuvé et listé dans Google Workspace Marketplace, et pour être considéré comme "fonctionnant avec Classroom".

Les mots clés "DOIT", "NE DOIT PAS", "REQUIS", "DEVRAIT", "NE DEVRAIT PAS", "RECOMMANDÉ", "PEUT" et "FACULTATIF" employés aux présentes doivent être interprétés conformément au sens qui leur est conféré dans la RFC 2119.

Conditions requises

ID Type
1.0 Licence de l'utilisateur final (le cas échéant)
  1.1 Un message convivial DOIT s'afficher lorsque l'utilisateur ne dispose pas de licence. Le message DOIT indiquer clairement la raison pour laquelle le module complémentaire ne peut pas être utilisé et suggérer à l'utilisateur une marche à suivre pour remédier à la situation. RECOMMANDÉ
  1.3 La fiche du module complémentaire sur Google Workspace Marketplace DOIT spécifier les exigences en matière de licence et d'abonnement qui peuvent être requises pour utiliser le module complémentaire. Si le module complémentaire comporte un niveau payant, la fiche Marketplace DOIT fournir un lien vers une page Web contenant plus d'informations sur les tarifs ou sur la manière de contacter un commercial. RECOMMANDÉ
2.0 Connexion de l'utilisateur final
  2.1 Les enseignants DOIVENT se connecter au module complémentaire à l'aide de l'authentification unique Google.
Si les élèves sont invités à se connecter au module complémentaire, ils DOIVENT le faire à l'aide de l'authentification unique Google.		 REQUIRED
  2.2 Le module complémentaire DOIT utiliser l'authentification unique Google pour connecter automatiquement un utilisateur lors de ses visites ultérieures sans afficher d'invite de connexion.
Lorsque l'indice de connexion ne correspond pas à l'utilisateur actuellement connecté, le module complémentaire DOIT inviter l'utilisateur à cliquer sur un bouton de connexion et transmettre le login_hint à la bibliothèque d'authentification pour filtrer les comptes non valides.		 REQUIRED
  2.7 Lorsque l'utilisateur Classroom n'est pas déjà connecté au module complémentaire (comme déterminé par l'indice de connexion), le module complémentaire DOIT présenter un bouton 'Se connecter avec Google' pour que l'utilisateur puisse déclencher explicitement le processus de connexion.
Remarque : Cette exigence est nécessaire pour respecter les consignes relatives à la marque de Google et éviter les bloqueurs de pop-up.		 REQUIRED
  2.8 Le module complémentaire DEVRAIT indiquer l'utilisateur actuellement connecté. RECOMMANDÉ
3.0 Général
  3.1 Le module complémentaire DOIT respecter les consignes générales d'approbation de Google Workspace Marketplace. REQUIRED
  3.2 Si une tâche est lancée dans un nouvel onglet ou une nouvelle fenêtre à partir de l'un des parcours iFrame, elle DOIT fournir un message convivial pour revenir à Classroom. RECOMMANDÉ
  3.3 L'utilisateur DOIT uniquement effectuer le parcours à l'aide d'un workflow de module complémentaire et ne pas passer à un workflow de devoir ni utiliser le bouton de partage Classroom. REQUIRED
  3.4 Choix de la langue : la langue DEVRAIT être basée sur les préférences locales définies par le navigateur, le cas échéant. RECOMMANDÉ
  3.5 Si un module complémentaire définit maxPoints, il DOIT également définir pointsEarned lorsqu'un élève remet un devoir à l'aide d'identifiants d'enseignant enregistrés (recommandé) OU lorsque l'enseignant ouvre le devoir dans l'iFrame "Vérification des devoirs des élèves". REQUIRED
  3.9 Les modules complémentaires DOIVENT être conformes aux consignes d'accessibilité WCAG 2.1 de niveau AA. Les développeurs de modules complémentaires indiqueront eux-mêmes que cette exigence est respectée au moment de l'envoi et que le module complémentaire restera conforme aux futures modifications. RECOMMANDÉ
  3.10 Toutes les erreurs rencontrées par un utilisateur DOIVENT être lisibles par un humain. RECOMMANDÉ
  3.11 Si studentViewUri, teacherViewUri ou studentWorkViewUri est lancé à partir d'un devoir ou d'un cours copié, le module complémentaire NE DOIT PAS afficher de page d'erreur dans l'iFrame. REQUIRED
4.0 Découverte des pièces jointes
  4.1 Si une pièce jointe nécessite un devoir de la part de l'élève, elle DOIT inclure un studentWorkReviewUri afin d'être traitée comme un type d'activité et non comme un type de contenu. REQUIRED
  4.2 L'iFrame "Découverte des pièces jointes" DOIT fournir une interface utilisateur proposant au moins l'une des options suivantes :
  • Créer un contenu à joindre
  • Parcourir, sélectionner et joindre un contenu à partir d'une bibliothèque de contenu
  • Instructions pour joindre du contenu à partir de votre site Web ou d'autres produits
 REQUIRED
  4.3 L'enseignant DEVRAIT pouvoir trouver et accéder à tous les contenus/activités qui lui sont disponibles. RECOMMANDÉ
  4.4 L'enseignant DEVRAIT pouvoir prévisualiser le contenu/l'activité avant de s'engager à le joindre au devoir. RECOMMANDÉ
  4.5 Si l'enseignant doit effectuer un travail pour créer un contenu/une activité avant de pouvoir le joindre, ce travail DEVRAIT être effectué dans l'iFrame. RECOMMANDÉ
5.0 Vue de l'élève
  5.1 Lorsque le studentViewUri est lancé, le module complémentaire NE DOIT PAS faire sortir l'utilisateur de l'iFrame pour effectuer une tâche.
Si le module complémentaire fait sortir l'utilisateur de l'iFrame, un message ou une autre indication DOIT permettre aux élèves de revenir à Classroom.		 RECOMMANDÉ
  5.2 Si une activité de module complémentaire sort de l'iFrame, un aperçu de la tâche DOIT s'afficher dans l'iFrame. RECOMMANDÉ
  5.3 Si un bouton ou un lien intitulé Rendre est présent dans l'activité, il DOIT entraîner une requête API pour envoyer le travail de l'élève à l'enseignant pour qu'il le corrige. REQUIRED
6.0 Vue de l'enseignant
  6.1 L'enseignant DEVRAIT pouvoir voir ce que l'élève verra lorsqu'il effectuera le devoir. RECOMMANDÉ
7.0 Vérification des devoirs des élèves
  7.1 Si studentWorkReviewUri est lancé, le module complémentaire DOIT afficher le travail de l'élève pour que l'enseignant le corrige dans l'iFrame. Le matériel supplémentaire peut être lié en dehors de l'iFrame. REQUIRED
  7.2 Le module complémentaire NE DOIT PAS permettre de naviguer entre les élèves dans la vue studentWorkReviewUri. La navigation entre les élèves DOIT avoir lieu uniquement dans l'interface utilisateur Classroom. REQUIRED
8.0 Compatibilité avec l'application mobile Classroom
  8.1 Lorsque l'application mobile Classroom lance un teacherViewUri, un studentViewUri ou un studentWorkReviewUri, l'URL DOIT ouvrir l'application mobile native du partenaire ou l'application Web mobile du partenaire, et dans les deux cas, un lien profond vers la vue appropriée. Si l'appareil n'est pas compatible, un message DOIT s'afficher pour indiquer à l'utilisateur qu'il s'agit d'un appareil non compatible et, idéalement, quels appareils sont compatibles. REQUIRED
  8.2 Les élèves DOIVENT pouvoir effectuer leurs devoirs sur un appareil mobile. RECOMMANDÉ
9.0 Autres fonctionnalités
  9.1 Si les enseignants peuvent coller des liens vers votre contenu en tant que pièces jointes de liens, vous DEVRIEZ convertir les liens en pièces jointes de modules complémentaires. RECOMMANDÉ
  9.2 Si vous utilisez une intégration CourseWork pour créer des devoirs en dehors de Classroom, vous DEVRIEZ créer des pièces jointes de modules complémentaires par défaut pour tous les liens compatibles avec votre module complémentaire. RECOMMANDÉ

Journal des modifications

Version 1.1 Mise à jour le 5 décembre 2024
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 Passage de REQUIRED à RECOMMENDED.
3.12 Supprimé.
5.3 Reformulé. Une modification récente permet aux développeurs de modules complémentaires de rendre de manière fiable les devoirs des élèves à l'aide de l'API.
Version 1.0 Mise à jour le 30 avril 2024
1.1 Combinaison de 1.1 et 1.2 en une seule exigence.
2.1 Combinaison de 2.1 et 2.5 en une seule exigence.
2.2 Combinaison de 2.2, 2.3 et 2.4 en une seule exigence.
3.5 Combinaison de 3.5, 3.6 et 3.7 en une seule exigence.
3.10 Ajout de l'exigence selon laquelle le module complémentaire ne doit jamais entrer dans un état inintelligible ou irrécupérable.
3.11, 3.12 Combinaison de 5.5, 5.6, 6.3, 6.4, 7.5 et 7.6 en deux nouvelles exigences.
4.2 Développement de la description des expériences de découverte des pièces jointes acceptables.
4.3 Renuméroté, anciennement 4.2. Passage de REQUIRED à RECOMMENDED.
4.4 Renuméroté, anciennement 4.3.
4.5 Renuméroté, anciennement 4.4.
5.2 Renuméroté, anciennement 5.3.
5.3 Renuméroté, anciennement 5.2.
9.1 Ajout d'une recommandation pour convertir les liens collés en pièces jointes.
9.2 Ajout d'une recommandation pour créer des pièces jointes de modules complémentaires par défaut lors de la création programmatique de devoirs CourseWork.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Supprimé.
Version 0.3 Mise à jour le 22 novembre 2022
2.3 Correction des consignes concernant l'indice de connexion.
2.4 Intégration d'un scénario dans lequel l'implémentation de hd est requise.
3.2 Reformulation de "fournir un chemin".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Ajout de consignes requises et recommandées concernant la copie de cours pour le studentViewUri, le teacherViewUri, et le studentWorkReviewUri.
Version 0.2 Mise à jour le 29 octobre 2021
1.3 Modification du texte pour plus de clarté.
3.1 Ajout de "Le module complémentaire DOIT respecter les consignes générales d'approbation GWM disponibles sur son site Web."
3.9 Passage de REQUIRED à RECOMMENDED pour les WCAG.
5.1 Passage de REQUIRED à RECOMMENDED.
5.3 Ajout de "Si le module complémentaire sort de l'iFrame, un aperçu de la tâche DOIT s'afficher dans l'iFrame."
5.4 Ajout de "Si le module complémentaire sort de l'iFrame, une invite DOIT s'afficher pour que les élèves reviennent à Classroom."
8.1 Ajout de "Si l'appareil n'est pas compatible, un message DOIT s'afficher pour indiquer à l'utilisateur qu'il s'agit d'un appareil non compatible et, idéalement, quels appareils sont compatibles."
8.2 Passage de REQUIRED à RECOMMENDED pour les devoirs des élèves sur mobile.
Version 0.1 Mise à jour le 22 septembre 2021
  Version initiale.