Verwenden Ihre Nutzer Classroom mit Google Meet? Sehen Sie sich die Apps Script-Kurzanleitung zum Ansehen der Teilnahme von Schülern/Studenten in Google Meet-Kursen an.

Google Classroom API

Verwaltung von Kursen, Teilnehmerlisten und Einladungen in Google Classroom

Dienst: Classroom.googleapis.com

Wir empfehlen, für den Aufruf dieses Dienstes die von Google bereitgestellten Clientbibliotheken zu verwenden. Wenn Ihre Anwendung Ihre eigenen Bibliotheken verwenden muss, um diesen Dienst aufzurufen, 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
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.
list GET /v1/courses
Gibt eine Liste der Kurse zurück, die der anfragende Nutzer sehen darf. Er 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.

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 den Alias eines Kurses.
list GET /v1/courses/{courseId}/aliases
Gibt eine Liste von Aliassen 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.
list GET /v1/courses/{courseId}/announcements
Gibt eine Liste von Ankündigungen zurück, die der Anforderer ansehen darf.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Ändert den Zuweisungsmodus und die Optionen einer Ankündigung.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Aktualisiert ein oder mehrere Felder einer Ankündigung.

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 die Kursaufgabe zurück.
list GET /v1/courses/{courseId}/courseWork
Gibt eine Liste von Kursarbeiten zurück, die der Anforderer ansehen darf.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Ändert den Zuweisungsmodus und die Optionen für Kursarbeiten.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Aktualisiert ein oder mehrere Felder einer Kursaufgabe.

REST-Ressource: v1.courses.courseWork.studentSubmissions

Methoden
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Gibt die Aufgabe eines Schülers/Studenten zurück.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Gibt eine Liste der abgegebenen Aufgaben zurück, die der Antragsteller ansehen darf, wobei die OAuth-Bereiche der Anfrage berücksichtigt werden.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Ändert Anhänge von abgegebenen Aufgaben.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Aktualisiert ein oder mehrere Felder einer abgegebenen Aufgabe
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Ruft den Namen eines Schülers oder Studenten ab, der im Namen des Schülers/Studenten der Inhaber ist.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Gibt die Aufgabe eines Schülers/Studenten zurück.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Sie geben die 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 die Kursmaterialien.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Gibt das Kursmaterial für den Kurs zurück.
list GET /v1/courses/{courseId}/courseWorkMaterials
Gibt eine Liste mit Kursarbeiten zurück, die der Antragsteller ansehen darf.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Aktualisiert ein oder mehrere Felder eines Kursmaterials.

REST-Ressource: v1.courses.students

Methoden
create POST /v1/courses/{courseId}/students
Fügt einen Nutzer als Schüler oder Student hinzu.
delete DELETE /v1/courses/{courseId}/students/{userId}
Löscht einen Schüler/Studenten eines Kurses.
get GET /v1/courses/{courseId}/students/{userId}
Gibt den 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 Anforderer sehen darf.

REST-Ressource: v1.courses.teachers

Methoden
create POST /v1/courses/{courseId}/teachers
Erstellt die Lehrkraft für einen Kurs.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Die angegebene Lehrkraft wird aus dem angegebenen Kurs entfernt.
get GET /v1/courses/{courseId}/teachers/{userId}
Gibt die Lehrkraft eines Kurses zurück.
list GET /v1/courses/{courseId}/teachers
Gibt eine Liste von Lehrkräften dieses Kurses zurück, die der Antragsteller sehen 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 Anforderer 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, entfernt sie und fügt den eingeladenen Nutzer den Lehrkräften oder Schülern/Studenten des jeweiligen Kurses 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 von Einladungen zurück, die der anfragende Nutzer sehen darf. Die Liste ist dabei auf die Liste beschränkt, die der Listenanfrage entsprechen.

REST-Ressource: v1.registrations

Methoden
create POST /v1/registrations
Erstellt ein Registration, wodurch Classroom Benachrichtigungen von dem bereitgestellten feed an das in cloudPubSubTopic angegebene Ziel sendet.
delete DELETE /v1/registrations/{registrationId}
Löscht Registration, wodurch Classroom keine Benachrichtigungen für dieses Registration mehr sendet.

REST-Ressource: v1.userProfiles

Methoden
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 mit einem Erziehungsberechtigten und sendet eine E-Mail an ihn, um ihn zu bestätigen.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Gibt eine bestimmte Einladung eines Erziehungsberechtigten zurück.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Gibt eine Liste von Einladungen von Erziehungsberechtigten zurück, die gemäß den Parametern des anfragenden Nutzers angesehen werden dürfen.
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 von Erziehungsberechtigten zurück, die der anfragende Nutzer sehen darf. Die Liste ist dabei auf die Anfrage beschränkt.