L'API Google Classroom fournit une interface de programmation aux développeurs de logiciels, aux administrateurs et aux responsables d'établissement pour 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 tuteurs
- 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 détectables 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 les 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 avec l'écriture de code et la maintenance de l'infrastructure logicielle. | Écrivez des applications qui utilisent l'API Classroom. |
| Je souhaite gérer occasionnellement un petit nombre de ressources Classroom. Je suis à l'aise avec l'écriture de petites quantités de code avec peu de surcharge. | Utilisez l'API Classroom avec Google Apps Script. |
| Je souhaite apporter occasionnellement des modifications à des ressources Classroom individuelles. Je suis à l'aise avec les commandes de terminal. | Utilisez Google Apps Manager. |
| Je souhaite obtenir un grand nombre de rapports contenant des informations détaillées 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 par programmation. |
| 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 dans Classroom". |
| Je souhaite que les enseignants Classroom se synchronisent avec mon système d'information sur la scolarité ou importent des informations depuis celui-ci. | Implémentez OneRoster pour le SIS ou créez des ressources et accédez-y à l'aide de l'API Classroom. |
Premiers pas
Nous encourageons les nouveaux développeurs à procéder comme suit avant de démarrer un nouveau projet :
- Consultez notre guide sur la structure de l'API Classroom.
- Découvrez les notes, les types d'utilisateurs, l'éligibilité des utilisateurs et les actions des administrateurs. Ces guides expliquent des concepts propres à Google Classroom et à l'API Classroom.
- Découvrez le fonctionnement des requêtes de l'API Classroom.
Pour commencer le développement, assurez-vous d'avoir effectué les étapes préalables. Choisissez les champs d'application 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 d'utiliser le Google APIs Explorer. 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 courses.list()
méthode. Cette méthode ne nécessite aucun paramètre de requête. Vous pouvez récupérer un id dans 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 aucun cours, vous pouvez en créer un à l'aide de la
courses.create() méthode.
Vous pouvez également consulter la documentation de référence de l'API Classroom.