Google Classroom API

Gère les cours, les listes d'élèves et les invitations dans Google Classroom.

Service : classroom.googleapis.com

Pour appeler ce service, nous vous recommandons d'utiliser les bibliothèques clientes fournies par Google. Si votre application doit utiliser vos propres bibliothèques pour appeler ce service, conformez-vous aux informations suivantes lorsque vous effectuez les requêtes API.

Document de découverte

Un document de découverte est une spécification lisible par machine qui permet de décrire et d'utiliser les API REST. Ce document permet de créer des bibliothèques clientes, des plug-ins IDE et d'autres outils qui interagissent avec les API Google. Un même service peut fournir plusieurs documents de découverte. Ce service fournit le document de découverte suivant :

Point de terminaison de service

Un point de terminaison de service est une URL de base qui spécifie l'adresse réseau d'un service d'API. Un service peut posséder plusieurs points de terminaison de service. Ce service possède le point de terminaison de service suivant, et tous les URI ci-dessous sont relatifs à ce point de terminaison de service :

  • https://classroom.googleapis.com

Ressource REST : v1.courses

Méthodes
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Indique si un utilisateur est autorisé à créer des pièces jointes de module complémentaire dans un cours donné.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Indique si un utilisateur est autorisé à modifier les paramètres GradingPeriodSettings d'un cours donné.
create POST /v1/courses
Crée un cours.
delete DELETE /v1/courses/{id}
Supprime un cours.
get GET /v1/courses/{id}
Renvoie un cours.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
Renvoie les paramètres de la période de notation d'un cours.
list GET /v1/courses
Renvoie une liste des cours que l'utilisateur demandeur est autorisé à consulter, limitée à ceux qui correspondent à la requête.
patch PATCH /v1/courses/{id}
Met à jour un ou plusieurs champs d'un cours.
update PUT /v1/courses/{id}
Met à jour un cours.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
Met à jour les paramètres de période de notation d'un cours.

Ressource REST : v1.courses.aliases

Méthodes
create POST /v1/courses/{courseId}/aliases
Crée un alias pour un cours.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Supprime l'alias d'un cours.
list GET /v1/courses/{courseId}/aliases
Renvoie une liste d'alias pour un cours.

Ressource REST : v1.courses.announcements

Méthodes
create POST /v1/courses/{courseId}/announcements
Crée une annonce.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Supprime une annonce.
get GET /v1/courses/{courseId}/announcements/{id}
Renvoie une annonce.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Récupère les métadonnées des modules complémentaires Classroom dans le contexte d'un post spécifique.
list GET /v1/courses/{courseId}/announcements
Renvoie la liste des annonces que le demandeur est autorisé à consulter.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Modifie le mode et les options d'attribution d'une annonce.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Met à jour un ou plusieurs champs d'une annonce.

Ressource REST : v1.courses.announcements.addOnAttachments

Méthodes
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Crée une pièce jointe de module complémentaire sous un post.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Supprime une pièce jointe de module complémentaire.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Renvoie une pièce jointe de module complémentaire.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Renvoie toutes les pièces jointes créées par un module complémentaire sous le post.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Met à jour une pièce jointe de module complémentaire.

Ressource REST : v1.courses.courseWork

Méthodes
create POST /v1/courses/{courseId}/courseWork
Crée un devoir.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Supprime un devoir.
get GET /v1/courses/{courseId}/courseWork/{id}
Renvoie un devoir.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Récupère les métadonnées des modules complémentaires Classroom dans le contexte d'un post spécifique.
list GET /v1/courses/{courseId}/courseWork
Renvoie la liste des devoirs que le demandeur est autorisé à consulter.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Modifie le mode et les options de cessionnaire d'un document de travail.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Met à jour un ou plusieurs champs d'un devoir.

Ressource REST : v1.courses.courseWork.addOnAttachments

Méthodes
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Crée une pièce jointe de module complémentaire sous un post.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Supprime une pièce jointe de module complémentaire.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Renvoie une pièce jointe de module complémentaire.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Renvoie toutes les pièces jointes créées par un module complémentaire sous le post.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Met à jour une pièce jointe de module complémentaire.

Ressource REST : v1.courses.courseWork.addOnAttachments.studentSubmissions

Méthodes
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Renvoie un devoir rendu par un élève pour une pièce jointe de module complémentaire.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions
Renvoie une liste des devoirs d'élèves que le demandeur est autorisé à consulter.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Met à jour les données associées à l'envoi d'une pièce jointe de module complémentaire.

Ressource REST : v1.courses.courseWork.rubrics

Méthodes
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Crée une grille d'évaluation.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Supprime une grille d'évaluation.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Renvoie une grille d'évaluation.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Renvoie la liste des grilles d'évaluation que le demandeur est autorisé à consulter.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Met à jour une grille d'évaluation.

Ressource REST : v1.courses.courseWork.studentSubmissions

Méthodes
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Renvoie un devoir d'élève.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Renvoie la liste des devoirs d'élèves que le demandeur est autorisé à consulter, en tenant compte des champs d'application OAuth de la requête.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Modifie les pièces jointes du devoir d'un élève.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Met à jour un ou plusieurs champs d'un devoir d'élève.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Récupère un devoir rendu par un élève au nom de l'élève qui en est propriétaire.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Renvoie un devoir d'élève.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Remet un devoir d'élève.

Ressource REST : v1.courses.courseWorkMaterials

Méthodes
create POST /v1/courses/{courseId}/courseWorkMaterials
Crée un support de cours.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Supprime un support de cours.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Renvoie un support de cours.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Récupère les métadonnées des modules complémentaires Classroom dans le contexte d'un post spécifique.
list GET /v1/courses/{courseId}/courseWorkMaterials
Renvoie une liste de supports de cours que le demandeur est autorisé à consulter.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Met à jour un ou plusieurs champs d'un support de cours.

Ressource REST : v1.courses.courseWorkMaterials.addOnAttachments

Méthodes
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Crée une pièce jointe de module complémentaire sous un post.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Supprime une pièce jointe de module complémentaire.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Renvoie une pièce jointe de module complémentaire.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Renvoie toutes les pièces jointes créées par un module complémentaire sous le post.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Met à jour une pièce jointe de module complémentaire.

Ressource REST : v1.courses.posts

Méthodes
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Récupère les métadonnées des modules complémentaires Classroom dans le contexte d'un post spécifique.

Ressource REST : v1.courses.posts.addOnAttachments

Méthodes
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Crée une pièce jointe de module complémentaire sous un post.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Supprime une pièce jointe de module complémentaire.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Renvoie une pièce jointe de module complémentaire.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Renvoie toutes les pièces jointes créées par un module complémentaire sous le post.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Met à jour une pièce jointe de module complémentaire.

Ressource REST : v1.courses.posts.addOnAttachments.studentSubmissions

Méthodes
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Renvoie le devoir d'un élève pour une pièce jointe de module complémentaire.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Met à jour les données associées à l'envoi d'une pièce jointe de module complémentaire.

Ressource REST : v1.courses.studentGroups

Méthodes
create POST /v1/courses/{courseId}/studentGroups
Crée un groupe d'élèves pour un cours.
delete DELETE /v1/courses/{courseId}/studentGroups/{id}
Supprime un groupe d'élèves.
list GET /v1/courses/{courseId}/studentGroups
Renvoie la liste des groupes d'un cours.
patch PATCH /v1/courses/{courseId}/studentGroups/{id}
Met à jour un ou plusieurs champs d'un groupe d'élèves.

Ressource REST : v1.courses.studentGroups.studentGroupMembers

Méthodes
create POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Crée un membre de groupe d'élèves pour un groupe d'élèves.
delete DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
Supprime un membre d'un groupe d'élèves.
list GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Renvoie la liste des élèves d'un groupe.

Ressource REST : v1.courses.students

Méthodes
create POST /v1/courses/{courseId}/students
Ajoute un utilisateur en tant qu'élève d'un cours.
delete DELETE /v1/courses/{courseId}/students/{userId}
Supprime un élève d'un cours.
get GET /v1/courses/{courseId}/students/{userId}
Renvoie un élève d'un cours.
list GET /v1/courses/{courseId}/students
Renvoie la liste des élèves de ce cours que le demandeur est autorisé à consulter.

Ressource REST : v1.courses.teachers

Méthodes
create POST /v1/courses/{courseId}/teachers
Crée un enseignant pour un cours.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Supprime l'enseignant spécifié du cours spécifié.
get GET /v1/courses/{courseId}/teachers/{userId}
Renvoie un enseignant d'un cours.
list GET /v1/courses/{courseId}/teachers
Renvoie la liste des enseignants de ce cours que le demandeur est autorisé à consulter.

Ressource REST : v1.courses.topics

Méthodes
create POST /v1/courses/{courseId}/topics
 : crée un sujet.
delete DELETE /v1/courses/{courseId}/topics/{id}
Supprime un sujet.
get GET /v1/courses/{courseId}/topics/{id}
Renvoie un sujet.
list GET /v1/courses/{courseId}/topics
Renvoie la liste des thèmes que le demandeur est autorisé à afficher.
patch PATCH /v1/courses/{courseId}/topics/{id}
Met à jour un ou plusieurs champs d'un sujet.

Ressource REST : v1.invitations

Méthodes
accept POST /v1/invitations/{id}:accept
Accepte une invitation, la supprime et ajoute l'utilisateur invité aux enseignants ou aux élèves (selon le cas) du cours spécifié.
create POST /v1/invitations
Crée une invitation.
delete DELETE /v1/invitations/{id}
Supprime une invitation.
get GET /v1/invitations/{id}
Renvoie une invitation.
list GET /v1/invitations
Renvoie une liste des invitations que l'utilisateur demandeur est autorisé à consulter, limitée à celles qui correspondent à la requête de liste.

Ressource REST : v1.registrations

Méthodes
create POST /v1/registrations
Crée un Registration, ce qui amène Classroom à commencer à envoyer des notifications depuis le feed fourni vers la destination fournie dans cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
Supprime un Registration, ce qui empêche Classroom d'envoyer des notifications pour ce Registration.

Ressource REST : v1.userProfiles

Méthodes
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
Indique si un utilisateur peut utiliser la fonctionnalité Classroom spécifiée.
get GET /v1/userProfiles/{userId}
Renvoie un profil utilisateur.

Ressource REST : v1.userProfiles.guardianInvitations

Méthodes
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Crée une invitation pour un représentant légal et lui envoie un e-mail lui demandant de confirmer qu'il est bien le représentant légal de l'élève.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Renvoie une invitation de représentant légal spécifique.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Renvoie une liste des invitations de responsables que l'utilisateur demandeur est autorisé à consulter, filtrée selon les paramètres fournis.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Modifie une invitation de représentant légal.

Ressource REST : v1.userProfiles.guardians

Méthodes
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
Supprime un représentant légal.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Renvoie un représentant légal spécifique.
list GET /v1/userProfiles/{studentId}/guardians
Renvoie une liste des représentants légaux que l'utilisateur demandeur est autorisé à consulter, limitée à ceux qui correspondent à la requête.