Die Classroom API bietet eine RESTful-Oberfläche, über die Sie Kurse und Listen in Google Classroom verwalten können. Darüber hinaus können Entwickler und Rechteinhaber über die Schaltfläche zum Teilen von Inhalten in Classroom die Freigabe ihrer Inhalte in Classroom aktivieren.
Wer kann die API verwenden?
Google Workspace for Education-Domainadministratoren können die API verwenden, um Kurse im Namen von Lehrkräften programmatisch bereitzustellen, Schüler-/Studenteninformationssysteme mit Classroom zu synchronisieren und grundlegende Einblicke in die Kurse zu erhalten, die in ihrer Domain unterrichtet werden.
Anwendungsentwickler können die Classroom API verwenden, um ihre Apps in Classroom zu integrieren. Diese Anwendungen benötigen OAuth 2.0, um die Berechtigung zum Aufrufen von Kursen und Teilnehmerlisten von Lehrkräften anzufordern. Administratoren können einschränken, ob Lehrkräfte und Schüler/Studenten in ihrer Domain Apps für den Zugriff auf ihre Google Classroom-Daten autorisieren.
Websiteinhaber und Inhaltsentwickler können die Schaltfläche zum Freigeben von Inhalten in Classroom verwenden, damit Lernende und Lehrkräfte Inhalte mit Classroom teilen können.
Alle Integrationen der 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-Benutzeroberfläche entsprechen. Einige dieser Entitäten haben zusätzlich zu den in Classroom vorhandenen Eigenschaften weitere API-spezifische 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.
Kursmetadaten und Aliasse
Kurse stellen eine Klasse dar, z. B. „M. Smiths Mathematik im 4. Std.“ und die zugewiesenen Lehrkräfte, die Teilnehmerliste und die Metadaten. Jeder Kurs wird durch eine eindeutige ID identifiziert, die vom Server zugewiesen wird. Die Kursressource enthält insbesondere alle Metadaten zum Kurs, z. B. Name, Beschreibung, Ort und Zeit. Kurslisten werden über die Ressourcen Student, Teacher und Invitation und ihre Methoden verwaltet.
Aliasse sind alternative Kennungen für eine Klasse, die mit einem Kurs verknüpft 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 ist nützlich zum Erstellen von Aliassen, auf die alle Nutzer Zugriff benötigen, die jedoch nicht programmspezifisch sind. 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 nützlich, um anwendungsspezifische Aliasse zu verwalten. Beispielsweise kann eine Anwendung, die alternative Kennungen für Kurse verwendet, Aliasse erstellen, um ihre ID Classroom-Kursen zuzuordnen. In diesem Namespace erstellte Aliasse sind an eine bestimmte Google API Console 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 von Kursen
Students und Teachers sind spezifische Zuordnungen zwischen einem Nutzerprofil und einem Kurs und stellen die Rolle dieses Nutzers im Kurs dar. Die Bezeichnungen „Schüler/Student“ und „Lehrkraft“ sind nicht global: Ein Nutzer kann für einen Kurs als Lehrkraft und in einem anderen als Schüler/Student zugewiesen werden. Die Bezeichnung „Schüler/Student“ oder „Lehrkraft“ steht für eine Reihe von Berechtigungen für einen bestimmten Nutzer in einem bestimmten Kurs.
- Kursteilnehmer
- Eine Ressource vom Typ „Schüler/Student“ steht für einen Nutzer, der in einem bestimmten Kurs angemeldet ist. Schüler und Studenten können die Kursdetails und die Lehrkräfte für diesen Kurs sehen.
- Lehrer
- Eine Lehrkraftressource stellt einen Nutzer dar, der einen bestimmten Kurs unterrichtet. Lehrkräfte können die Kursdetails aufrufen und ändern, Lehrkräfte und Schüler/Studenten einsehen und zusätzliche Lehrkräfte und Schüler/Studenten verwalten.
Einladungen und die zugehörigen Methoden bieten eine bequeme Möglichkeit, Kursteilnehmer und Lehrkräfte zu Kursen hinzuzufügen. Wenn Sie Einladungen erstellen, können Nutzer auswählen, ob sie einem Kurs beitreten möchten, anstatt sie direkt über die Ressourcen für Lehrkräfte und Schüler/Studenten hinzuzufügen.
UserProfiles stellen eine Zuordnung zum Domainprofil eines Nutzers dar, die durch die eindeutige ID oder E-Mail-Adresse des Nutzers identifiziert wird, die von der Directory API zurückgegeben wird.
Der aktuelle Nutzer kann auch mit der Abkürzung "me" auf seine eigene ID verweisen.
Weitere Informationen zum Verwalten von Teilnehmerlisten finden Sie unter Lehrkräfte und Schüler/Studenten verwalten.
Kursarbeiten und abgegebene Aufgaben von Schülern oder Studenten
Ein CourseWork-Element steht für eine einzelne Aufgabe, die einer Gruppe von Teilnehmern eines Kurses zugewiesen wird. Es enthält Details wie Beschreibung, Fälligkeitsdatum und Materialien sowie Metadaten wie die Erstellungszeit. Zu den Materialien gehören ein Titel, eine Miniaturansicht und eine URL sowie eine Kennung, die mit den entsprechenden APIs (z.B. Drive, YouTube) verwendet werden kann.
In den Kursarbeiten geht es um einen der folgenden Aufgabentypen:
- Aufgaben, die Schüler oder Studenten erledigen, indem sie Arbeitsblätter oder andere Anhänge einreichen.
- Eine Kurzantwort- oder Multiple-Choice-Frage.
Aufgaben von Schülern/Studenten für ein Kurswork-Element werden durch StudentSubmission gekennzeichnet. Sie besteht aus einer Antwort und zusätzlichen Metadaten wie einem Status und einer zugewiesenen Note.
Der Inhalt einer Einreichung von Schülern/Studenten hängt vom Typ des entsprechenden Kurswork-Elements ab:
- Die Arbeitsblätter und Anhänge, die für eine Aufgabe eingereicht werden, einschließlich Titel, Miniaturansicht und URL sowie IDs, die mit den entsprechenden APIs wie Drive oder YouTube verwendet werden können.
- Die Antwort auf eine Kurzantwort- oder Multiple-Choice-Frage.
Weitere Informationen zum Verwalten von Kursaufgaben und abgegebenen Aufgaben finden Sie unter Kursaufgaben verwalten.
Kurzanleitungen
Wenn Sie Ihre Umgebung einrichten und sofort mit der API starten möchten, sehen Sie sich eine der Kurzanleitungen an:
Mit dem Classroom API Explorer experimentieren
Wenn Sie Aufrufmethoden für Live-Daten ausprobieren möchten, verwenden Sie den Classroom API Explorer. Sie müssen keinen Code schreiben, um zu beginnen. Beachten Sie jedoch, dass Aktionen, die Sie mit dem API Explorer ausführen, vorhandene Daten ändern können.
Eine Möglichkeit zum Aufrufen der Methoden besteht darin, die Methode courses.list() aufzurufen. Für diese Methode sind keine Anfrageparameter erforderlich. Sie können aus der zurückgegebenen Liste der Kurse einen id abrufen, der als Anfrageparameter für andere API-Aufrufe verwendet werden soll. Wenn Sie keine Kurse haben, können Sie mit der Methode courses.create() einen Kurs erstellen.
Sie können sich auch die API-Referenz ansehen.