Google Classroom API

Verwaltet Kurse, Teilnehmerlisten und Einladungen in Google Classroom.

Dienst: classroom.googleapis.com

Wir empfehlen, diesen Dienst mit den von Google bereitgestellten Clientbibliotheken aufzurufen. Wenn Ihre Anwendung diesen Dienst mit Ihren eigenen Bibliotheken aufrufen muss, sollten Sie die folgenden Informationen verwenden, wenn Sie die API-Anfragen senden.

Discovery-Dokument

Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zum Beschreiben und Nutzen von REST APIs. Sie wird verwendet, um Clientbibliotheken, IDE-Plug-ins und andere Tools zu erstellen, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente haben. Der Dienst bietet das folgende Discovery-Dokument:

Dienstendpunkt

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst hat den folgenden Dienstendpunkt und alle nachstehenden URIs beziehen sich auf ihn:

  • https://classroom.googleapis.com

REST-Ressource: v1.courses

Methoden
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Gibt zurück, ob ein Nutzer berechtigt ist, Add-on-Anhänge in einem bestimmten Kurs zu erstellen.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Gibt zurück, ob ein Nutzer berechtigt ist, die GradingPeriodSettings in einem bestimmten Kurs zu aktualisieren.
create POST /v1/courses
Erstellt einen Kurs.
delete DELETE /v1/courses/{id}
Löscht einen Kurs.
get GET /v1/courses/{id}
Gibt einen Kurs zurück.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
Gibt die Einstellungen für den Benotungszeitraum in einem Kurs zurück.
list GET /v1/courses
Gibt eine Liste der Kurse zurück, die der anfragende Nutzer ansehen darf. Die Liste ist auf die Kurse beschränkt, die der Anfrage entsprechen.
patch PATCH /v1/courses/{id}
Aktualisiert ein oder mehrere Felder in einem Kurs.
update PUT /v1/courses/{id}
Aktualisiert einen Kurs.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
Aktualisiert die Einstellungen für den Benotungszeitraum eines Kurses.

REST-Ressource: v1.courses.aliases

Methoden
create POST /v1/courses/{courseId}/aliases
Erstellt einen Alias für einen Kurs.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Löscht einen Alias eines Kurses.
list GET /v1/courses/{courseId}/aliases
Gibt eine Liste von Aliasen für einen Kurs zurück.

REST-Ressource: v1.courses.announcements

Methoden
create POST /v1/courses/{courseId}/announcements
Erstellt eine Ankündigung.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Löscht eine Ankündigung.
get GET /v1/courses/{courseId}/announcements/{id}
Gibt eine Ankündigung zurück.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Ruft Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab.
list GET /v1/courses/{courseId}/announcements
Gibt eine Liste von Ankündigungen zurück, die der Antragsteller ansehen darf.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Ändert den Zuweisungsmodus und die Optionen einer Mitteilung.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Aktualisiert ein oder mehrere Felder einer Ankündigung.

REST-Ressource: v1.courses.announcements.addOnAttachments

Methoden
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Erstellt einen Add-on-Anhang für einen Beitrag.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Löscht einen Add-on-Anhang.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Gibt einen Add‑on-Anhang zurück.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Gibt alle Anhänge zurück, die von einem Add-on unter dem Beitrag erstellt wurden.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Aktualisiert einen Add-on-Anhang.

REST-Ressource: v1.courses.courseWork

Methoden
create POST /v1/courses/{courseId}/courseWork
Erstellt Kursaufgaben.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Löscht eine Kursaufgabe.
get GET /v1/courses/{courseId}/courseWork/{id}
Gibt Kursaufgaben zurück.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Ruft Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab.
list GET /v1/courses/{courseId}/courseWork
Gibt eine Liste mit Kursaufgaben zurück, die der Antragsteller ansehen darf.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Ändert den Zuweisungsmodus und die Optionen eines Kurses.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Aktualisiert ein oder mehrere Felder einer Kursaufgabe.

REST-Ressource: v1.courses.courseWork.addOnAttachments

Methoden
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Erstellt einen Add-on-Anhang für einen Beitrag.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Löscht einen Add-on-Anhang.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Gibt einen Add‑on-Anhang zurück.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Gibt alle Anhänge zurück, die von einem Add-on unter dem Beitrag erstellt wurden.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Aktualisiert einen Add-on-Anhang.

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

Methoden
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Gibt die Aufgabe eines Schülers/Studenten für einen Add-on-Anhang zurück.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Aktualisiert die Daten, die mit einem Add-on-Anhang verknüpft sind.

REST-Ressource: v1.courses.courseWork.rubrics

Methoden
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Erstellt ein Bewertungsschema.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Löscht ein Bewertungsschema.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Gibt ein Bewertungsschema zurück.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Gibt eine Liste der Rubriken zurück, die der Antragsteller ansehen darf.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Aktualisiert ein Bewertungsschema.

REST-Ressource: v1.courses.courseWork.studentSubmissions

Methoden
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Gibt eine Aufgabe eines Schülers/Studenten zurück.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Gibt eine Liste mit abgegebenen Aufgaben von Schülern/Studenten zurück, die der Anfragesteller ansehen darf. Dabei werden die OAuth-Bereiche der Anfrage berücksichtigt.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Ändert Anhänge von Schüler-/Studentenaufgaben.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Aktualisiert ein oder mehrere Felder einer Schüler-/Studentenarbeit.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Fordert eine Schüler-/Studentenaufgabe im Namen des Schülers/Studenten zurück, dem sie gehört.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Gibt eine Aufgabe eines Schülers/Studenten zurück.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Gibt eine Aufgabe eines Schülers/Studenten ab.

REST-Ressource: v1.courses.courseWorkMaterials

Methoden
create POST /v1/courses/{courseId}/courseWorkMaterials
Erstellt ein Kursmaterial.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Löscht ein Kursmaterial.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Gibt ein Kursarbeitsmaterial zurück.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Ruft Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab.
list GET /v1/courses/{courseId}/courseWorkMaterials
Gibt eine Liste mit Kursmaterial zurück, das der Antragsteller ansehen darf.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Aktualisiert ein oder mehrere Felder eines Kursaufgabenmaterials.

REST-Ressource: v1.courses.courseWorkMaterials.addOnAttachments

Methoden
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Erstellt einen Add-on-Anhang für einen Beitrag.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Löscht einen Add-on-Anhang.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Gibt einen Add‑on-Anhang zurück.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Gibt alle Anhänge zurück, die von einem Add-on unter dem Beitrag erstellt wurden.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Aktualisiert einen Add-on-Anhang.

REST-Ressource: v1.courses.posts

Methoden
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Ruft Metadaten für Classroom-Add-ons im Kontext eines bestimmten Beitrags ab.

REST-Ressource: v1.courses.posts.addOnAttachments

Methoden
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Erstellt einen Add-on-Anhang für einen Beitrag.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Löscht einen Add-on-Anhang.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Gibt einen Add‑on-Anhang zurück.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Gibt alle Anhänge zurück, die von einem Add-on unter dem Beitrag erstellt wurden.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Aktualisiert einen Add-on-Anhang.

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

Methoden
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Gibt die Aufgabe eines Schülers/Studenten für einen Add-on-Anhang zurück.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Aktualisiert die Daten, die mit einem Add-on-Anhang verknüpft sind.

REST-Ressource: v1.courses.studentGroups

Methoden
create POST /v1/courses/{courseId}/studentGroups
Erstellt eine Schüler‑/Studentengruppe für einen Kurs.
delete DELETE /v1/courses/{courseId}/studentGroups/{id}
Löscht eine Schüler‑/Studentengruppe.
list GET /v1/courses/{courseId}/studentGroups
Gibt eine Liste der Gruppen in einem Kurs zurück.
patch PATCH /v1/courses/{courseId}/studentGroups/{id}
Aktualisiert ein oder mehrere Felder in einer Schüler-/Studentengruppe.

REST-Ressource: v1.courses.studentGroups.studentGroupMembers

Methoden
create POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Erstellt ein Mitglied einer Schüler‑/Studentengruppe für eine Schüler‑/Studentengruppe.
delete DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
Löscht ein Mitglied einer Schüler‑/Studentengruppe.
list GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Gibt eine Liste der Schüler/Studenten in einer Gruppe zurück.

REST-Ressource: v1.courses.students

Methoden
create POST /v1/courses/{courseId}/students
Fügt einen Nutzer als Kursteilnehmer hinzu.
delete DELETE /v1/courses/{courseId}/students/{userId}
Löscht einen Schüler/Studenten aus einem Kurs.
get GET /v1/courses/{courseId}/students/{userId}
Gibt einen Schüler/Studenten eines Kurses zurück.
list GET /v1/courses/{courseId}/students
Gibt eine Liste der Schüler/Studenten dieses Kurses zurück, die der Anfragende ansehen darf.

REST-Ressource: v1.courses.teachers

Methoden
create POST /v1/courses/{courseId}/teachers
Erstellt eine Lehrkraft für einen Kurs.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Entfernt die angegebene Lehrkraft aus dem angegebenen Kurs.
get GET /v1/courses/{courseId}/teachers/{userId}
Gibt eine Lehrkraft eines Kurses zurück.
list GET /v1/courses/{courseId}/teachers
Gibt eine Liste der Lehrkräfte dieses Kurses zurück, die der Anfragende ansehen darf.

REST-Ressource: v1.courses.topics

Methoden
create POST /v1/courses/{courseId}/topics
Erstellt ein Thema.
delete DELETE /v1/courses/{courseId}/topics/{id}
Löscht ein Thema.
get GET /v1/courses/{courseId}/topics/{id}
Gibt ein Thema zurück.
list GET /v1/courses/{courseId}/topics
Gibt die Liste der Themen zurück, die der Anfragende ansehen darf.
patch PATCH /v1/courses/{courseId}/topics/{id}
Aktualisiert ein oder mehrere Felder eines Themas.

REST-Ressource: v1.invitations

Methoden
accept POST /v1/invitations/{id}:accept
Akzeptiert eine Einladung, entfernt sie und fügt den eingeladenen Nutzer dem angegebenen Kurs als Lehrkraft oder Schüler/Student hinzu.
create POST /v1/invitations
Erstellt eine Einladung.
delete DELETE /v1/invitations/{id}
Löscht eine Einladung.
get GET /v1/invitations/{id}
Gibt eine Einladung zurück.
list GET /v1/invitations
Gibt eine Liste mit Einladungen zurück, die der anfragende Nutzer ansehen darf. Die Liste ist auf die Einladungen beschränkt, die der Listenanfrage entsprechen.

REST-Ressource: v1.registrations

Methoden
create POST /v1/registrations
Erstellt ein Registration, sodass Classroom Benachrichtigungen vom angegebenen feed an das in cloudPubSubTopic angegebene Ziel sendet.
delete DELETE /v1/registrations/{registrationId}
Löscht eine Registration. Classroom sendet dann keine Benachrichtigungen mehr für diese Registration.

REST-Ressource: v1.userProfiles

Methoden
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
Gibt zurück, ob ein Nutzer die angegebene Classroom-Funktion verwenden darf.
get GET /v1/userProfiles/{userId}
Gibt ein Nutzerprofil zurück.

REST-Ressource: v1.userProfiles.guardianInvitations

Methoden
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Erstellt eine Einladung für Erziehungsberechtigte und sendet eine E‑Mail an den Erziehungsberechtigten, in der er gebeten wird, zu bestätigen, dass er der Erziehungsberechtigte des Schülers oder Studenten ist.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Gibt eine bestimmte Einladung für Erziehungsberechtigte zurück.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Gibt eine Liste mit Einladungen für Erziehungsberechtigte zurück, die der anfragende Nutzer ansehen darf. Die Liste wird nach den angegebenen Parametern gefiltert.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Ändert eine Einladung für Erziehungsberechtigte.

REST-Ressource: v1.userProfiles.guardians

Methoden
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
Löscht einen Erziehungsberechtigten.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Gibt einen bestimmten Erziehungsberechtigten zurück.
list GET /v1/userProfiles/{studentId}/guardians
Gibt eine Liste der Erziehungsberechtigten zurück, die der anfragende Nutzer ansehen darf, beschränkt auf diejenigen, die der Anfrage entsprechen.