Intégration de CourseWork

Les développeurs peuvent utiliser l'API Google Classroom pour interagir avec les documents de travail dans Google Classroom. Une application qui utilise l'API de cette manière est appelée intégration CourseWork.

Ce chemin d'intégration est couramment utilisé pour créer et noter des devoirs avec des liens vers des ressources en dehors de Classroom. Il offre aux développeurs un accès plus étendu à la gestion des travaux et devoirs par rapport aux boutons de partage Classroom.

Fonctionnement

La principale fonctionnalité d'une intégration CourseWork est la création et la gestion des devoirs, des annonces et des supports de cours à l'aide de l'API Classroom.

Un exemple de parcours utilisateur courant rendu possible par une intégration CourseWork est de permettre aux enseignants de découvrir, d'attribuer et de noter du contenu depuis votre site Web ou votre application:

1. Un utilisateur enseignant se connecte à votre site Web.
2. L'enseignant trouve ou crée des contenus qu'il souhaite partager avec sa classe. L'enseignant clique sur un bouton de votre site Web pour envoyer ce contenu à Google Classroom.
3. Votre application envoie une requête à courses.courseWork.create. Le corps de la requête contient un objet CourseWork qui contient les éléments suivants :
   • ID du cours de destination.
   • Titre du devoir.
   • Description textuelle du devoir.
   • Un link Material avec l'URL du contenu sélectionné par l'enseignant.
   • (facultatif) Score maximal possible pour le contenu sélectionné.
4. Un nouveau devoir apparaît dans Classroom avec un lien en pièce jointe. Le lien fait référence à l'URL spécifiée dans la requête create. Voir l'exemple de la Figure 1.
5. Une nouvelle colonne pour le devoir s'affiche également dans le cahier de notes Classroom, y compris la note maximale, le cas échéant.
6. Les élèves reçoivent le devoir et cliquent sur link Material pour ouvrir l'URL fournie dans un nouvel onglet et afficher ou effectuer le contenu sur votre site Web. Si vous le souhaitez, fournissez aux élèves des commandes leur permettant de remettre leur devoir.
7. Vous pouvez également envoyer une requête à courses.courseWork.studentSubmissions.modifyAttachments pour ajouter des pièces jointes à un devoir d'élève, comme un fichier Google Drive ou un link Material qui pointe vers le travail de l'élève sur votre site Web.
8. (Facultatif) Envoyez une requête à courses.courseWork.studentSubmissions.patch pour définir la note de l'élève pour le devoir.

Figure 1. Vue de l'enseignant lors de la modification d'un devoir avec link Material créé par une intégration CourseWork.

Vous pouvez également appeler courses.announcements.create ou courses.courseWorkMaterials.create pour créer une annonce ou un matériel de cours au lieu d'un devoir. Pour obtenir une description détaillée des actions de l'API Classroom pertinentes, consultez les pages Créer et gérer des devoirs et Définir et mettre à jour des notes.

Remarques

Tenez compte des points suivants avant de décider si une intégration CourseWork est le bon choix pour vos besoins en produits.

• Vous devez autoriser l'utilisateur et lui demander son consentement. Vous envoyez des requêtes d'API au nom de l'utilisateur. Cela signifie, par exemple, que vous ne pouvez pas créer de devoirs dans aucun cours Google Classroom. Vous ne pouvez en créer que dans les cours dispensés par l'utilisateur autorisé.
• Vous devez permettre à l'utilisateur de sélectionner un cours pour recevoir le contenu. Envisagez d'utiliser courses.list pour obtenir la liste des cours dispensés par l'utilisateur, puis autorisez-le à sélectionner un ou plusieurs cours dans la liste.
• Lorsqu'un utilisateur clique sur un link Material dans Classroom, le lien s'ouvre dans un nouvel onglet. Votre serveur ne recevra aucune information de Classroom lorsque l'URL s'ouvrira.
• Un enseignant peut modifier ou supprimer le cours indépendamment du développeur. Cela signifie que les connaissances d'un développeur sur le cours peuvent devenir obsolètes. Si vous devez être informé des modifications apportées aux cours, envisagez de configurer des notifications push pour les cours.
• Un enseignant peut créer des cours dans l'interface utilisateur de Classroom en collant des liens vers des URL de votre site Web. Les devoirs créés de cette manière appartiennent uniquement à l'enseignant. Vous ne pourrez donc pas les afficher, les modifier ni définir les notes de devoirs à l'aide de l'API Classroom.