Die Classroom API bietet eine RESTful-Oberfläche, über die Sie Kurse und Teilnehmerlisten in Google Classroom verwalten können. Darüber hinaus können Entwickler und Inhaltsinhaber mit der Schaltfläche zum Teilen von Inhalten in Classroom ihre Inhalte für Classroom freigeben.
Wer kann die API verwenden?
Google Workspace for Education-Domainadministratoren können mit der API programmatisch Kurse für Lehrkräfte bereitstellen, Schüler-/Studenteninformationssysteme mit Classroom synchronisieren und einen Überblick über die Kurse in ihrer Domain erhalten.
Anwendungsentwickler können die Classroom API verwenden, um ihre Anwendungen in Classroom zu integrieren. Diese Anwendungen benötigen OAuth 2.0, um die Berechtigung zum Aufrufen von Kursen und Teilnehmerlisten anzufordern. Administratoren können einschränken, ob Lehrkräfte und Schüler/Studenten in ihrer Domain Anwendungen für den Zugriff auf ihre Google Classroom-Daten autorisieren dürfen.
Websiteinhaber und Inhaltsentwickler können die Schaltfläche „Teilen“ in Classroom verwenden, damit Schüler, Studenten und Lehrkräfte Inhalte mit Classroom teilen können.
Alle API- und Classroom-Freigabeschaltflächen müssen den Branding-Richtlinien für Classroom entsprechen.
API-Übersicht
Die Classroom API besteht aus mehreren Entitätstypen, die Kursen, Lehrkräften und Schülern oder Studenten in der Classroom-Oberfläche entsprechen. Einige dieser Entitäten haben neben den in Classroom vorhandenen Attributen noch weitere spezielle API-Attribute. Die primären Entitätstypen sind:
Ausführliche Informationen zu den Ressourcen und Methoden der API finden Sie in der Referenz zur Classroom API.
Metadaten und Aliasse für Kurse
Kurse stellen eine Klasse dar, z. B. „M. Smiths 4. Mathematikaufgabe", und die zugewiesenen Lehrer, Teilnehmerliste und Metadaten. Jeder Kurs wird durch eine eindeutige ID identifiziert, die vom Server zugewiesen wird. Die Kursressource enthält speziell alle Metadaten zum Kurs, z. B. Name, Beschreibung, Ort und Zeit. Kurslisten werden über die Ressourcen Schüler, Lehrkraft und Einladung und ihre Methoden verwaltet.
Aliasse sind alternative Kennungen für eine Klasse, die einem Kurs zugeordnet und anstelle der eindeutigen ID verwendet werden können. Jeder Alias ist in einem Namespace vorhanden, der einschränkt, wer ihn erstellen und aufrufen kann. Es werden zwei Namespaces unterstützt:
- Domain: Der Domain-Namespace eignet sich zum Erstellen von Aliassen, auf die alle Nutzer zugreifen können, die sich jedoch nicht auf ein bestimmtes Programm beziehen. Alternative Einträge für einen Kurs wie MATH 127 und COMSCI 127 sollten beispielsweise im Domain-Namespace erstellt werden. Aliasse im Domain-Namespace können nur von Domainadministratoren erstellt werden, sind aber für alle Nutzer in einer Domain sichtbar.
- Entwicklerprojekt:Der Namespace des Entwicklerprojekts ist hilfreich, um Aliasse für eine Anwendung zu verwalten. Beispielsweise kann eine Anwendung, die alternative IDs für Kurse verwendet, Aliasse erstellen, um ihre ID Classroom-Kursen zuzuordnen. In diesem Namespace erstellte Aliasse sind an eine bestimmte Google API-Konsole gebunden. Jeder Nutzer einer Anwendung kann Aliasse im Namespace für das Entwicklerprojekt dieser Anwendung erstellen und ansehen.
Weitere Informationen zum Verwalten von Kursmetadaten und Aliassen finden Sie unter Kurse verwalten.
Teilnehmerlisten und -nutzer
Kursteilnehmer und Kursleiter sind spezifische Zuordnungen zwischen einem Nutzerprofil und einem Kurs. Sie repräsentieren die Rolle dieses Nutzers im Kurs. Die Bezeichnungen "Kursteilnehmer" und "Kursleiter" sind nicht global: Ein Nutzer kann als Lehrkraft für einen Kurs und einen anderen für einen anderen Kurs zugewiesen werden. Die Kennzeichnung „Schüler/Student“ oder „Lehrkraft“ steht für eine Reihe von Berechtigungen für einen bestimmten Nutzer in einem bestimmten Kurs.
- Kursteilnehmer
- Eine Schülerressource stellt einen Nutzer dar, der als Student in einem bestimmten Kurs eingeschrieben ist. Schüler/Studenten können sich die Kursdetails und die Lehrkräfte für diesen Kurs ansehen.
- Lehrer
- Eine Ressource für Lehrkräfte repräsentiert einen Nutzer, der einen bestimmten Kurs unterrichtet. Lehrkräfte können die Kursdetails aufrufen und ändern, Lehrkräfte und Schüler/Studenten ansehen sowie zusätzliche Lehrkräfte und Schüler/Studenten verwalten.
Mit Einladungen und den zugehörigen Methoden können Sie Schülern und Studenten oder Lehrkräften ganz einfach Kurse hinzufügen. Wenn Sie Einladungen erstellen, können Nutzer selbst entscheiden, ob sie einem Kurs beitreten möchten oder nicht. Sie müssen sie nicht direkt über die Ressourcen für Lehrkräfte und Schüler/Studenten hinzufügen.
UserProfiles stellen eine Zuordnung zum Domainprofil eines Nutzers dar, wie durch die eindeutige ID oder E-Mail-Adresse des Nutzers identifiziert, die von der Directory API zurückgegeben wird.
Der aktuelle Nutzer kann sich mit der Kurzschreibweise "me" auch auf seine eigene ID beziehen.
Weitere Informationen zum Verwalten von Teilnehmerlisten finden Sie unter Lehrkräfte und Schüler/Studenten verwalten.
Kursaufgaben und abgegebene Aufgaben
Ein CourseWork-Element ist eine einzelne Aufgabe, die einer Gruppe von Schülern in einem Kurs zugewiesen ist. Sie enthält Details wie die Beschreibung, das Fälligkeitsdatum und Materialien sowie Metadaten wie den Erstellungszeitpunkt. Die Materialien umfassen einen Titel, ein Thumbnail, eine URL und eine Kennung, die mit den entsprechenden APIs wie Drive oder YouTube verwendet werden kann.
Kursinhalte beschreiben eine der folgenden Aufgaben:
- Eine Aufgabe, die Schüler oder Studenten durch Einreichen von Arbeitsblättern oder anderen Anhängen abschließen können
- Eine Kurzantwort- oder Multiple-Choice-Frage.
Die Aufgaben von Schülern/Studenten eines Kursstücks werden durch ein Schülerbeitrag-Objekt dargestellt. Sie besteht aus einer Antwort und zusätzlichen Metadaten wie einem Status und einer zugewiesenen Note.
Der Inhalt eines StudentSubmission-Objekts hängt vom Typ des entsprechenden CourseWork-Elements ab:
- Die Arbeitsblätter und Anhänge, die für eine Aufgabe eingereicht wurden, einschließlich Titel, Thumbnail und URL, sowie Kennungen, die mit den entsprechenden APIs wie Drive oder YouTube verwendet werden können.
- Die Antwort auf eine Kurzantwort- oder Multiple-Choice-Frage.
Weitere Informationen zur Verwaltung von Kursaufgaben und abgegebenen Aufgaben finden Sie unter Kursaufgaben verwalten.
Kurzanleitungen
Wenn Sie Ihre Umgebung einrichten und sofort mit der API starten möchten, probieren Sie eine der Kurzanleitungen aus:
Mit dem Classroom API Explorer experimentieren
Wenn Sie Aufrufmethoden für Live-Daten testen möchten, können Sie den Classroom API Explorer verwenden. Sie müssen dafür keinen Code schreiben. Sie können aber mit Aktionen, die Sie mit dem API Explorer durchführen, vorhandene Daten ändern.
Eine Möglichkeit, die Methoden aufzurufen, besteht darin, die Methode courses.list() aufzurufen. Für diese Methode sind keine Anfrageparameter erforderlich. Sie können eine id aus der zurückgegebenen Kursliste abrufen und als Anfrageparameter für andere API-Aufrufe verwenden. Wenn Sie keine Kurse haben, können Sie mit der Methode courses.create() einen erstellen.
Sie können sich auch die API-Referenz ansehen.