L'API Classroom fournit une interface RESTful pour vous permettre de gérer les cours et les listes d'élèves dans Google Classroom. De plus, le bouton de partage de Classroom permet aux développeurs et aux propriétaires de contenu d'activer le partage de leur contenu avec Classroom.
Qui peut utiliser l'API ?
Les administrateurs de domaines Google Workspace for Education peuvent utiliser l'API pour provisionner des cours par programmation pour le compte des enseignants, synchroniser les systèmes d'information sur la scolarité avec Classroom et obtenir une visibilité de base sur les cours enseignés dans leur domaine.
L'API Classroom permet aux développeurs d'intégrer leurs applications dans Classroom. Ces applications doivent utiliser OAuth 2.0 pour demander l'autorisation d'afficher les cours et les listes d'élèves des enseignants. Les administrateurs peuvent restreindre l'accès des enseignants et des élèves de leur domaine à l'accès des applications à leurs données Google Classroom.
Les propriétaires de sites Web et les développeurs de contenu peuvent utiliser le bouton de partage Classroom pour permettre aux élèves et aux enseignants de partager des contenus avec Classroom.
Toutes les intégrations de boutons de partage dans Classroom et dans l'API doivent respecter les consignes relatives à la marque Classroom.
Présentation de l'API
L'API Classroom comporte plusieurs types d'entités correspondant aux classes, aux enseignants et aux élèves dans l'interface Classroom. Certaines de ces entités ont des propriétés supplémentaires spécifiques à l'API en plus de celles qui existent dans Classroom. Les principaux types d'entités sont les suivants:
Pour obtenir des informations détaillées sur les ressources et les méthodes de l'API, consultez la documentation de référence de l'API Classroom.
Métadonnées et alias du cours
Les cours représentent une classe, par exemple "M. "mathématiques de la quatrième période de Smith » et les enseignants assignés, la liste des élèves et les métadonnées. Chaque cours est identifié par un identifiant unique attribué par le serveur. La ressource Course encapsule spécifiquement toutes les métadonnées concernant le cours, telles que le nom, la description, le lieu et la durée. La liste des élèves d'un cours est gérée via les ressources Student, Teacher et Invitation, ainsi que leurs méthodes.
Les alias sont des identifiants alternatifs pour une classe. Ils peuvent être associés à un cours et utilisés à la place de l'identifiant unique. Chaque alias existe dans un espace de noms qui limite les utilisateurs autorisés à le créer et à l'afficher. Deux espaces de noms sont acceptés:
- Domaine:l'espace de noms du domaine est utile pour créer des alias auxquels tous les utilisateurs ont besoin d'accéder, mais qui ne sont pas spécifiques à un programme. Par exemple, d'autres fiches de cours, telles que MATH 127 et COMSCI 127, doivent être créées dans l'espace de noms du domaine. Seuls les administrateurs de domaine peuvent créer les alias de l'espace de noms du domaine, mais ils sont visibles par tous les utilisateurs d'un domaine.
- Projet de développeur:l'espace de noms du projet de développeur est utile pour gérer les alias spécifiques à une application. Par exemple, une application qui utilise d'autres identifiants pour les cours peut créer des alias pour mapper son identifiant aux cours Classroom. Les alias créés dans cet espace de noms sont liés à une console Google APIs spécifique. Tout utilisateur d'une application peut créer et afficher des alias dans l'espace de noms pour le projet de développement de cette application.
Pour en savoir plus sur la gestion des métadonnées et des alias de cours, consultez la page Gérer les cours.
Liste des élèves et utilisateurs du cours
Élèves et Enseignants sont des correspondances spécifiques entre un profil utilisateur et un cours, représentant le rôle de cet utilisateur dans le cours. Les désignations d'élève et d'enseignant ne sont pas globales: un utilisateur peut être désigné comme enseignant d'un cours et comme élève dans un autre. La désignation "élève" ou "enseignant" représente un ensemble d'autorisations accordées à un utilisateur particulier d'un cours particulier.
- Étudiants
Une ressource "Élève" représente un utilisateur inscrit en tant qu'étudiant à
un cours spécifique. Les élèves sont autorisés à consulter les détails du cours, ainsi que les enseignants associés.
- les enseignants.
Une ressource Enseignant représente un utilisateur qui enseigne un cours spécifique.
Les enseignants sont autorisés à consulter et à modifier les détails du cours, à voir les enseignants et les élèves, et à gérer les enseignants et les élèves supplémentaires.
Les invitations et les méthodes associées constituent un moyen pratique d'ajouter des élèves et des enseignants aux cours. La création d'invitations permet aux utilisateurs de choisir s'ils souhaitent rejoindre un cours ou non, plutôt que de les ajouter directement via les ressources pour les enseignants et les élèves.
Les UserProfiles représentent un mappage vers le profil de domaine d'un utilisateur, identifié par l'ID unique ou l'adresse e-mail de l'utilisateur renvoyé par l'API Directory. L'utilisateur actuel peut également faire référence à son propre ID à l'aide du raccourci "me".
Pour en savoir plus sur la gestion des listes d'élèves, consultez Gérer les enseignants et les élèves.
Devoirs et devoirs des élèves
Un élément CourseWork représente une tâche unique attribuée à un groupe d'élèves dans un cours. Il contient des détails tels que la description, la date d'échéance et les documents, ainsi que des métadonnées, comme l'heure de création. Ils incluent un titre, une miniature, une URL, ainsi qu'un identifiant utilisable avec les API appropriées (par exemple, Drive ou YouTube).
Les éléments CourseWork décrivent l'un des types de tâches suivants:
- Devoir que les élèves réalisent en envoyant des feuilles d'exercices ou d'autres pièces jointes.
- Question à réponse courte ou question à choix multiples.
Le devoir d'un élève pour un élément CourseWork est représenté par un StudentSubmission. Il se compose d'une réponse et de métadonnées supplémentaires telles qu'un état et une note attribuée.
Le contenu d'un StudentSubmission dépend du type de l'élément CourseWork correspondant:
- Les feuilles de calcul et les pièces jointes envoyées pour un devoir, y compris le titre, la miniature et l'URL, ainsi que les identifiants pouvant être utilisés avec les API appropriées telles que Drive ou YouTube.
- Réponse à une question à réponse courte ou à une question à choix multiples.
Pour en savoir plus sur la gestion des devoirs et des devoirs des élèves, consultez la page Gérer les travaux et devoirs.
Modules complémentaires Classroom
Un module complémentaire est une interface utilisateur et un backend diffusés par un partenaire, généralement affichés dans un iFrame. Les modules complémentaires s'affichent sous forme de pièces jointes dans un post, qui peut être Announcements, CourseWork ou CourseWorkMaterials.
Les pièces jointes de modules complémentaires peuvent être une activité ou un contenu.
- Les activités en pièce jointe exigent des élèves qu'ils remplissent et rendent un devoir individuel. Il peut s'agir, par exemple, de questionnaires, de dessins ou de jeux. Une activité envoyée peut éventuellement être notée.
- Il n'est pas nécessaire d'envoyer les pièces jointes aux élèves. L'élève n'a pas besoin de rendre la pièce jointe et celle-ci n'est pas notée. Il peut s'agir de photos, d'articles ou de vidéos.
Pour en savoir plus, consultez les guides de développement des modules complémentaires.
Guides de démarrage rapide
Pour configurer votre environnement et commencer immédiatement à utiliser l'API, consultez l'un des guides de démarrage rapide:
Tester Google APIs Explorer
Pour tester des méthodes d'appel sur des données en direct, essayez d'utiliser l'explorateur d'API Google. Vous n'avez pas besoin d'écrire de code pour commencer, mais sachez que les actions que vous effectuez à l'aide d'APIs Explorer peuvent modifier les données existantes.
Pour commencer à appeler les méthodes, vous pouvez appeler la méthode courses.list(). Cette méthode ne nécessite aucun paramètre de requête. Vous pouvez récupérer un id à partir de la liste de cours renvoyée à utiliser comme paramètre de requête pour d'autres appels d'API. Si vous n'avez aucun cours, vous pouvez en créer un à l'aide de la méthode courses.create().
Vous pouvez également consulter la documentation de référence de l'API.