L'API Google Classroom fournit une interface de programmation permettant aux développeurs de logiciels, aux administrateurs et aux responsables d'établissements scolaires de gérer les ressources Google Classroom. Vous pouvez créer un logiciel qui crée, récupère et modifie 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 les contenus ou outils d'un fournisseur externe visibles et accessibles dans Classroom
L'API Classroom est-elle la solution adaptée à mon cas ?
Google propose plusieurs produits pour vous aider à interagir avec Classroom. Vous trouverez ci-dessous des 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. | Écrire des applications qui utilisent l'API Classroom |
| Je souhaite gérer occasionnellement un petit volume de ressources Classroom. Je suis à l'aise avec l'écriture de petites quantités de code avec peu de frais généraux. | Utilisez l'API Classroom avec Google Apps Script. |
| Je souhaite modifier occasionnellement des ressources Classroom individuelles. Je suis à l'aise avec les commandes du 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 examiner l'activité de mes utilisateurs. | Générez des rapports dans la console d'administration ou utilisez l'API de création de rapports. |
Intégrer Google Classroom
| Scénario | Solutions recommandées |
|---|---|
| Je veux que les enseignants et les élèves puissent voir et lancer mes contenus dans Classroom. | Créez un module complémentaire Classroom. |
| Je souhaite que les enseignants cliquent sur un bouton sur mon site Web ou dans mon application pour intégrer mes contenus dans Classroom. | Créez un module complémentaire Classroom et créez des pièces jointes par programmation. |
| Je veux que les enseignants cliquent sur un bouton sur mon site Web ou dans mon application pour accéder à mon contenu dans Classroom. | Créez des devoirs à l'aide de l'API Classroom ou intégrez les boutons Partager avec Classroom. |
| Je souhaite que les enseignants Classroom synchronisent ou importent des informations à partir de mon système d'information sur la scolarité. | Intégrez 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 à effectuer les opérations suivantes avant de démarrer un nouveau projet:
- Consultez notre guide sur la structure de l'API Classroom.
- En savoir plus sur les notes, 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.
- Découvrez le fonctionnement des requêtes de l'API Classroom.
Pour commencer à développer, assurez-vous d'avoir effectué les étapes préalables. Choisissez les champs d'application d'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 les méthodes d'appel sur des données actives, 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.
Une façon de commencer à appeler les méthodes consiste à 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 consulter la documentation de référence de l'API Classroom.