Cette page a été traduite par l'API Cloud Translation.

Présentation

L'API Classroom fournit une interface RESTful qui vous permet de gérer les cours et les listes de courses dans Google Classroom. En outre, le bouton de partage 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 de manière automatisée des cours au nom des enseignants, synchroniser les systèmes d'information des élèves 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 l'autorisation d'afficher les classes et les listes d'élèves des enseignants. Les administrateurs peuvent empêcher les enseignants et les élèves de leur domaine d'autoriser les applications à accéder à leurs données Google Classroom.

Les propriétaires de sites Web et les développeurs de contenus peuvent utiliser le bouton de partage Classroom pour permettre aux élèves et aux enseignants de partager du contenu dans Classroom.

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

Présentation de l'API

L'API Classroom se compose de plusieurs types d'entités correspondant aux classes, aux enseignants et aux élèves de l'interface Classroom. Certaines de ces entités possèdent des propriétés supplémentaires spécifiques à l'API, en plus de celles existant dans Classroom. Les principaux types d'entités sont les suivants:

Pour plus d'informations 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. Smith's 4th period' math", ainsi que les métadonnées des enseignants, la liste des élèves et les métadonnées. Chaque cours est identifié par un ID unique attribué par le serveur. La ressource "Encapsulation" encapsule toutes les métadonnées du cours, telles que le nom, la description, le lieu et l'heure. Les listes d'élèves sont gérées via les ressources Élève, Enseignant et Invitation, ainsi que leurs méthodes.

Les alias sont des identifiants alternatifs pour une classe qui peuvent être associés à un cours et utilisés à la place de l'ID 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 de 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 seul programme. Par exemple, vous devez créer des fiches alternatives pour un cours, telles que MATH 127 et COMSCI 127, dans l'espace de noms du domaine. Les alias dans l'espace de noms du domaine ne peuvent être créés que par les administrateurs du domaine, mais sont visibles par tous les utilisateurs du 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 API Google 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 plus d'informations sur la gestion des métadonnées et des alias de cours, consultez la page Gérer les cours.

Listes d'utilisateurs et utilisateurs du cours

Les élèves et les enseignants sont des mappages spécifiques entre un profil utilisateur et un cours, représentant le rôle de cet utilisateur dans le cours. Les désignations des élèves et des enseignants ne sont pas globales: un utilisateur peut être désigné comme enseignant pour un cours et un élève pour un autre. La désignation "élève" ou "enseignant" représente un ensemble d'autorisations pour un utilisateur particulier dans un cours particulier.

Participants: Une ressource "Student" représente un utilisateur inscrit en tant qu'étudiant à un cours spécifique. Les étudiants sont autorisés à afficher les détails du cours et les enseignants de ce cours.
Enseignants: Une ressource "Enseignant" représente un utilisateur qui donne un cours spécifique. Les enseignants sont autorisés à afficher et modifier les détails du cours, à afficher les enseignants et les élèves, et à gérer d'autres enseignants et élèves.

Les invitations et les méthodes associées constituent un moyen pratique d'ajouter des élèves et des enseignants aux cours. En créant des invitations, les utilisateurs peuvent choisir de participer ou non à un cours, plutôt que de les ajouter directement via les ressources destinées aux enseignants et aux élèves.

Les UserProfiles représentent un mappage avec 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 envoyés par les élèves

Un élément CourseWork représente une tâche unique attribuée à un groupe d'étudiants. Il contient des détails tels que la description, la date limite et les éléments, ainsi que des métadonnées telles que l'heure de création. Les documents comprennent 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 que les élèves peuvent faire en envoyant des feuilles de calcul ou d'autres pièces jointes.
Une question à réponse courte ou une question à choix multiples.

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

Les feuilles de calcul et les pièces jointes envoyées pour un devoir, y compris son titre, sa vignette et son 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 à choix multiples

Pour plus d'informations sur la gestion des devoirs et des devoirs des élèves, consultez la page Gérer les travaux et devoirs.

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 l'explorateur d'API Classroom

Pour tester des méthodes d'appel sur des données réelles, essayez d'utiliser l'explorateur d'API Classroom. Vous n'avez pas besoin d'écrire de code pour commencer, mais sachez que les actions que vous effectuez à l'aide de l'explorateur d'API peuvent modifier les données existantes.

Pour commencer à appeler des méthodes, vous pouvez appeler la méthode courses.list(). Cette méthode ne nécessite aucun paramètre de requête et 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 pas de cours, vous pouvez en créer un à l'aide de la méthode courses.create().

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