L'API Google Classroom fournit une interface de programmation permettant aux développeurs de logiciels, aux administrateurs et aux responsables d'établissement scolaire de gérer les ressources Google Classroom. Vous pouvez créer des logiciels qui créent, récupèrent et modifient des cours Classroom et leur contenu.
Voici certains cas d'utilisation types :
- Gérer les cours, les listes d'élèves et les représentants légaux
- Ajouter des devoirs, des annonces et des supports de cours
- Attribuer des notes et modifier les paramètres de notation
- Générer des données pour l'analyse
- Rendre des contenus ou des outils d'un fournisseur externe visibles et accessibles dans Classroom
L'API Classroom est-elle la solution adaptée à mes besoins ?
Google propose plusieurs produits pour vous aider à interagir avec Classroom. Vous trouverez ci-dessous quelques scénarios courants et des recommandations de produits qui pourraient le mieux répondre à vos besoins.
Modifier des ressources Google Classroom
| Scénario | Solutions recommandées |
|---|---|
| Je souhaite gérer régulièrement un grand nombre de cours, d'utilisateurs ou d'autres ressources Classroom. Je suis à l'aise pour écrire du code et gérer l'infrastructure logicielle. | Écrivez des applications qui utilisent l'API Classroom. |
| Je souhaite gérer occasionnellement un petit volume de ressources Classroom. Je suis à l'aise pour écrire de petites quantités de code avec peu de surcharge. | Utilisez l'API Classroom avec Google Apps Script. |
| Je souhaite modifier occasionnellement des ressources individuelles dans Classroom. Je suis à l'aise avec les commandes du terminal. | Utilisez Google Apps Manager. |
| Je souhaite obtenir un grand nombre de rapports détaillés sur les événements dans Classroom. | Utilisez le service de transfert de données BigQuery. |
| Je souhaite mener une enquête sur l'activité de mes utilisateurs. | Générez des rapports dans la console d'administration ou utilisez l'API Reports. |
Intégrer à Google Classroom
| Scénario | Solutions recommandées |
|---|---|
| Je souhaite que les enseignants et les élèves puissent voir et lancer mon contenu dans Classroom. | Créez un module complémentaire Classroom. |
| Je souhaite que les enseignants cliquent sur un bouton de mon site Web ou de mon application qui intègre mon contenu dans Classroom. | Créez un module complémentaire Classroom et créez des pièces jointes de manière programmatique. |
| Je souhaite que les enseignants cliquent sur un bouton de mon site Web ou de mon application pour accéder à mon contenu dans Classroom. | Créez des devoirs à l'aide de l'API Classroom ou intégrez des boutons Partager sur Classroom. |
| Je souhaite que les enseignants Classroom synchronisent ou importent des informations depuis mon système d'information sur la scolarité. | Implémentez OneRoster pour SIS ou créez des ressources et accédez-y à l'aide de l'API Classroom. |
Premiers pas
Avant de commencer un nouveau projet, les nouveaux développeurs sont invités à effectuer les opérations suivantes :
- Consultez notre guide sur la structure de l'API Classroom.
- En savoir plus sur les niveaux, les types d'utilisateurs, l'éligibilité des utilisateurs et les actions des administrateurs Ces guides expliquent les concepts propres à Google Classroom et à l'API Classroom.
- Comprendre le fonctionnement des requêtes de l'API Classroom
Pour commencer à développer, assurez-vous d'avoir effectué les étapes préalables. Choisissez les scopes de l'API Classroom adaptés à vos besoins, puis configurez votre environnement et commencez à envoyer des requêtes en suivant l'un des guides de démarrage rapide :
Tester Google APIs Explorer
Pour tester l'appel de méthodes sur des données réelles, essayez 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 des 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 consulter la documentation de référence de l'API Classroom.