Présentation

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 domaine 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.

Les développeurs d'applications peuvent utiliser l'API Classroom pour intégrer leurs applications à Classroom. Ces applications doivent utiliser OAuth 2.0 pour demander aux enseignants l'autorisation d'afficher les cours et les listes d'élèves. Les administrateurs peuvent restreindre la possibilité pour les enseignants et les élèves de leur domaine d'autoriser des applications à accéder à 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 du contenu avec Classroom.

Toutes les intégrations de boutons de partage dans Classroom et l'API doivent respecter les consignes relatives à la marque Classroom.

Présentation de l'API

L'API Classroom comprend plusieurs types d'entités correspondant aux classes, aux enseignants et aux élèves dans l'interface Classroom. Certaines de ces entités possèdent 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 disponibles concernant 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 », ainsi que les enseignants attribué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 sur le cours, telles que le nom, la description, le lieu et l'heure. Les listes d'élèves des cours sont gérées via les ressources Student, Teacher, Invitation et 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 personnes autorisées à le créer et à l'afficher. Deux espaces de noms sont acceptés:

  • Domaine:l'espace de noms de domaine est utile pour créer des alias auxquels tous les utilisateurs ont besoin d'accéder, mais qui ne sont spécifiques à aucun programme. Par exemple, des fiches alternatives pour un cours, telles que MATH 127 et COMSCI 127, doivent être créées dans l'espace de noms du domaine. Les alias de l'espace de noms de domaine ne peuvent être créés que par les administrateurs de domaine, mais 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 propres à une application. Par exemple, une application qui utilise d'autres identifiants pour les cours peut créer des alias afin de mapper son identifiant avec les 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.

Listes des cours et utilisateurs

É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 pour un cours et comme élève pour un autre. La désignation "élève" ou "enseignant" représente un ensemble d'autorisations accordées à un utilisateur particulier dans un cours particulier.

Étudiants

Une ressource Étudiant 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 et les enseignants qui y sont associés.

Enseignants

Une ressource "Enseignant" correspond à un utilisateur qui donne 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 participer ou non à un cours, plutôt que de les ajouter directement via les ressources destinées aux enseignants et aux élèves.

UserProfiles représente un mappage avec le profil de domaine d'un utilisateur, tel qu'il est 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'étudiants dans un cours. Il contient des détails tels que la description, la date limite et les supports, ainsi que des métadonnées comme l'heure de création. Ils incluent un titre, une miniature et une URL, ainsi qu'un identifiant pouvant être utilisé 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 terminé par les élèves en envoyant des fiches d'exercices ou d'autres pièces jointes.
  • Question à réponse courte ou question à choix multiples.

Les devoirs des élèves pour un élément CourseWork sont représentés par un élément 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 d'élément courseWork correspondant:

  • Les feuilles de calcul et les pièces jointes envoyées pour un devoir, y compris leur titre, leur miniature et leur URL, ainsi que les identifiants pouvant être utilisés avec les API appropriées comme Drive ou YouTube
  • Il s'agit de la 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, au format Announcements, CourseWork ou CourseWorkMaterials.

Les pièces jointes de modules complémentaires peuvent être une activité ou un contenu.

  • Les pièces jointes à des activités nécessitent que l'élève remplisse et remet un devoir individuel. Il peut s'agir de questionnaires, de dessins ou de jeux. Un envoi d'activité peut éventuellement être noté.
  • L'envoi de pièces jointes n'est pas nécessaire pour les élèves. L'élève n'a pas besoin de rendre la pièce jointe et celle-ci n'est pas notée. Exemples : photos, articles et 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 des 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 pour l'utiliser comme paramètre de requête pour d'autres appels d'API. Si vous n'avez pas de cours, vous pouvez en créer un à l'aide de la méthode courses.create().

Vous pouvez également explorer la documentation de référence de l'API.