Google Classroom API

Hier können Sie Kurse, Teilnehmerlisten und Einladungen in Google Classroom verwalten.

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, verwenden Sie die folgenden Informationen, 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 an, ob ein Nutzer berechtigt ist, in einem bestimmten Kurs Add-on-Anhänge zu erstellen.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Gibt zurück, ob ein Nutzer die Benotungszeitraumeinstellungen in einem bestimmten Kurs aktualisieren kann.
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 aufrufen darf, beschränkt auf die, 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 der Aliasse 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 mit Mitteilungen zurück, die der Antragsteller ansehen darf.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Ändert den Modus für die Zuweisung und die Optionen einer Mitteilung.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Aktualisiert ein oder mehrere Felder einer Mitteilung.

REST-Ressource: v1.courses.announcements.addOnAttachments

Methoden
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Erstellt einen Add-on-Anhang unter einem 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 Kursarbeiten.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Löscht eine Kursarbeit.
get GET /v1/courses/{courseId}/courseWork/{id}
Gibt Kursarbeit 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 der Kursarbeiten zurück, die der Antragsteller sich ansehen darf.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Ändert den Modus für die Zuweisung und die Optionen eines Kurses.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Aktualisiert ein oder mehrere Felder einer Kursarbeit.

REST-Ressource: v1.courses.courseWork.addOnAttachments

Methoden
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Erstellt einen Add-on-Anhang unter einem 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 abgegebene 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 eingereichten Add-on-Anhang verknüpft sind.

REST-Ressource: v1.courses.courseWork.rubrics

Methoden
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Ein Bewertungsschema wird erstellt.
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 Benotungsraster zurück, die der Antragsteller aufrufen 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 die abgegebene Aufgabe eines Schülers/Studenten zurück.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Gibt eine Liste der von Schülern/Studenten eingereichten Aufgaben zurück, die der Anfragende sich ansehen darf. Dabei werden die OAuth-Bereiche der Anfrage berücksichtigt.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Ändert Anhänge der Aufgabe von Schülern/Studenten.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Aktualisiert ein oder mehrere Felder einer Schüler-/Studenteneinreichung.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Erhebt Anspruch auf eine von einem Schüler oder Studenten eingereichte Aufgabe im Namen des Schülers oder Studenten, dem sie gehört.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Gibt die Einreichung eines Schülers/Studenten zurück.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Ein Schüler/Student gibt eine Aufgabe ab.

REST-Ressource: v1.courses.courseWorkMaterials

Methoden
create POST /v1/courses/{courseId}/courseWorkMaterials
Erstellt Kursmaterialien.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Löscht ein Arbeitsmaterial.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Gibt ein Arbeitsmaterial 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 der Kursmaterialien zurück, die der Antragsteller sich ansehen darf.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Aktualisiert ein oder mehrere Felder eines Kursarbeitsmaterials.

REST-Ressource: v1.courses.courseWorkMaterials.addOnAttachments

Methoden
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Erstellt einen Add-on-Anhang unter einem 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 unter einem 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 Einreichung 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 eingereichten Add-on-Anhang verknüpft sind.

REST-Ressource: v1.courses.students

Methoden
create POST /v1/courses/{courseId}/students
Fügen Sie einen Nutzer als Schüler oder Studenten eines Kurses 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 Antragsteller 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 die Lehrkraft eines Kurses zurück.
list GET /v1/courses/{courseId}/teachers
Gibt eine Liste der Lehrkräfte dieses Kurses zurück, die der Anforderer aufrufen 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 Antragsteller 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
Nimmt eine Einladung an, wird sie entfernt und der eingeladene Nutzer wird den Lehrkräften bzw. Schülern oder Studenten des angegebenen Kurses hinzugefügt.
create POST /v1/invitations
Erstellt eine Einladung.
delete DELETE /v1/invitations/{id}
Löscht eine Einladung.
get GET /v1/invitations/{id}
Eine Einladung wird zurückgegeben.
list GET /v1/invitations
Liste der Einladungen zurückgeben, die der anfragende Nutzer ansehen darf, beschränkt auf die, die der Listenanfrage entsprechen.

REST-Ressource: v1.registrations

Methoden
create POST /v1/registrations
Erstellt eine Registration, sodass Classroom beginnt, Benachrichtigungen von der angegebenen feed an das in cloudPubSubTopic angegebene Ziel zu senden.
delete DELETE /v1/registrations/{registrationId}
Löscht eine Registration, sodass in Classroom keine Benachrichtigungen mehr für diese Registration gesendet werden.

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 den Erziehungsberechtigten und sendet ihm eine E-Mail, 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 der Einladungen für Erziehungsberechtigte zurück, die der anfragende Nutzer ansehen darf, gefiltert nach den angegebenen Parametern.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Ändert die Einladung eines Erziehungsberechtigten.

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 aufrufen darf, beschränkt auf diejenigen, die der Anfrage entsprechen.