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 à toutes les exigences applicables pour être approuvé et référencé dans Google Workspace Marketplace en tant que module complémentaire "Fonctionne avec Classroom".

Les mots clés "DOIT", "NE DOIT PAS", "REQUIS", "DEVRA", "NE DEVRA PAS", "DEVRAIT", "NE DEVRAIT PAS", "RECOMMANDÉ", "PEUT" et "FACULTATIF" dans ce document doivent être interprétés comme décrit dans la RFC 2119.

Conditions requises

ID Type
1.0 Licence utilisateur final (le cas échéant)
  1.1 Un message convivial DOIT être affiché à l'utilisateur lorsqu'il 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 Google Workspace Marketplace du module complémentaire DOIT spécifier les exigences concernant la licence et l'abonnement qui peuvent être nécessaires pour utiliser le module complémentaire. Si le module complémentaire propose un niveau payant, la fiche Marketplace DOIT fournir un lien vers une page Web qui offre plus d'informations sur les tarifs ou sur la façon 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'hint de connexion ne correspond pas à l'utilisateur actuellement connecté, le module complémentaire DOIT inviter l'utilisateur à se connecter à l'aide d'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 indiqué par l'indice de connexion), le module complémentaire DOIT présenter un bouton "Se connecter avec Google" pour que l'action explicite de l'utilisateur déclenche le processus de connexion.
Remarque : Cela est nécessaire pour respecter les consignes relatives à la marque Google et permet également d'éviter les bloqueurs de pop-up.
REQUIRED
  2,8 Le module complémentaire DOIT afficher 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 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 d'iframe, un message convivial invitant l'utilisateur à revenir à Classroom DOIT s'afficher. 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 DOIT ê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 envoie un devoir à l'aide des identifiants de l'enseignant enregistrés (recommandé) OU lorsque l'enseignant ouvre le devoir dans l'iFrame "Examen des devoirs des élèves". REQUIRED
  3.9 Les modules complémentaires DOIVENT être conformes aux consignes d'accessibilité WCAG 2.1, niveau AA. Les développeurs de modules complémentaires devront déclarer eux-mêmes que cette exigence est respectée au moment de l'envoi et que le module complémentaire reste conforme aux futures modifications apportées. RECOMMANDÉ
  3,10 Toutes les erreurs rencontrées par un utilisateur DOIVENT être lisibles par l'humain. RECOMMANDÉ
  3.11 Si studentViewUri, teacherViewUri ou studentWorkViewUri est lancé à partir d'un devoir ou d'un cours copiés, 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 une remise de la part de l'élève, elle DOIT inclure un studentWorkReviewUri pour être traitée comme un type d'activité et non comme un type de contenu. REQUIRED
  4.2 L'iFrame de découverte des pièces jointes DOIT fournir une interface utilisateur qui propose au moins l'une des options suivantes :
  • Créer un contenu à associer
  • Parcourir, sélectionner et joindre des éléments à partir d'une bibliothèque de contenu
  • Instructions pour joindre du contenu provenant de votre site Web ou d'autres produits
REQUIRED
  4.3 L'enseignant DOIT pouvoir trouver et accéder à tous les contenus/activités qui lui sont proposés. RECOMMANDÉ
  4.4 L'enseignant DOIT pouvoir prévisualiser le contenu/l'activité avant de s'engager à le joindre au devoir. RECOMMANDÉ
  4.5 Si l'enseignant doit créer du contenu ou une activité avant de pouvoir les joindre, il DOIT le faire dans l'iFrame. RECOMMANDÉ
5.0 Vue de l'élève
  5.1 Lorsque 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 être affiché pour que les élèves reviennent à Classroom.
RECOMMANDÉ
  5.2 Si une activité de module complémentaire s'affiche en dehors de l'iFrame, un aperçu de la tâche DOIT être disponible dans l'iFrame. RECOMMANDÉ
  5,3 Si un bouton ou un lien Rendre le devoir 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 l'examine. REQUIRED
6.0 Vue de l'enseignant
  6,1 L'enseignant DOIT pouvoir voir ce que l'élève verra lorsqu'il effectuera le devoir. RECOMMANDÉ
7.0 Vérification des travaux des élèves
  7.1 Si le studentWorkReviewUri est lancé, le module complémentaire DOIT afficher le travail de l'élève pour que l'enseignant puisse l'examiner dans l'iFrame. Les ressources supplémentaires peuvent rediriger les utilisateurs en dehors de l'iFrame. REQUIRED
  7.2 Le module complémentaire NE DOIT PAS permettre la navigation entre les élèves dans la vue studentWorkReviewUri. La navigation entre les élèves DOIT s'effectuer uniquement dans l'interface utilisateur Classroom. REQUIRED
8.0 Compatibilité de Classroom avec les appareils mobiles
  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 son application Web mobile, et dans les deux cas, établir un lien profond vers la vue appropriée. Si l'appareil n'est pas compatible, un message DOIT s'afficher pour l'indiquer à l'utilisateur et, idéalement, pour lui indiquer quels appareils sont compatibles. REQUIRED
  8.2 Les devoirs des élèves DOIVENT pouvoir être effectués 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 DEVEZ 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 DEVEZ créer des pièces jointes de module complémentaire par défaut pour tous les liens compatibles avec votre module complémentaire. RECOMMANDÉ

Journal des modifications

Version 1.1 Mise à jour : 5 décembre 2024
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 Passage de "REQUIRED" (OBLIGATOIRE) à "RECOMMENDED" (RECOMMANDÉ).
3.12 Supprimé.
5,3 Reformulation. Une modification récente permet aux développeurs de modules complémentaires de rendre les devoirs des élèves de manière fiable à l'aide de l'API.
Version 1.0 Mise à jour : 30 avril 2024
1.1 Les exigences 1.1 et 1.2 ont été combinées en une seule.
2.1 Les exigences 2.1 et 2.5 ont été combinées en une seule.
2.2 Les sections 2.2, 2.3 et 2.4 ont été combinées en une seule exigence.
3.5 Les versions 3.5, 3.6 et 3.7 ont été combinées 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 Les exigences combinées 5.5, 5.6, 6.3, 6.4, 7.5 et 7.6 ont été regroupées en deux nouvelles exigences.
4.2 Développement de la description des expériences de découverte des pièces jointes acceptables.
4.3 Re-numéroté, anciennement 4.2. Le paramètre est également passé de "REQUIRED" (OBLIGATOIRE) à "RECOMMENDED" (RECOMMANDÉ).
4.4 Renuméroté, anciennement 4.3.
4.5 Re-numéroté, anciennement 4.4.
5.2 Re-numéroté, anciennement 5.3.
5,3 Re-numé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.
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 Ajout d'un scénario dans lequel l'implémentation de hd est requise.
3.2 Reformulation de "indique le chemin".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Ajout de conseils obligatoires et recommandés pour la copie de cours pour les studentViewUri, teacherViewUri et studentWorkReviewUri.
Version 0.2 Mise à jour : 29 octobre 2021
1.3 Le texte a été modifié pour que l'intention soit plus claire.
3.1 Ajout de "Le module complémentaire DOIT respecter les consignes générales d'approbation GWM disponibles sur le site Web."
3.9 Les WCAG ont remplacé "OBLIGATOIRE" par "RECOMMANDÉ".
5.1 Le paramètre "REQUIRED" (OBLIGATOIRE) est devenu "RECOMMENDED" (RECOMMANDÉ).
5,3 Ajout de "Si les modules complémentaires sortent de l'iFrame, il DOIT y avoir un aperçu de la tâche dans l'iFrame."
5.4 Ajout de "Si le module complémentaire s'affiche en dehors de l'iFrame, une invite DOIT s'afficher pour inviter les élèves à revenir à 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 Le paramètre "Travaux des élèves sur mobile" est passé de "OBLIGATOIRE" à "RECOMMANDÉ".
Version 0.1 Mise à jour du 22 septembre 2021
  Version initiale.