Überblick

Die Classroom API bietet eine RESTful-Oberfläche, in der Sie Kurse und Teilnehmerlisten in Google Classroom verwalten können. Darüber hinaus können Entwickler und Rechteinhaber über die Schaltfläche zum Freigeben von Inhalten in Classroom die Freigabe ihrer Inhalte für 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 mithilfe der Classroom API ihre Anwendungen in Classroom einbinden. 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 können.

Websiteinhaber und Inhaltsentwickler können die Schaltfläche zum Teilen in Classroom verwenden, damit Schüler, Studenten und Lehrkräfte Inhalte mit Classroom teilen können.

Alle Integrationen von Freigabeschaltflächen in APIs und Classroom müssen den Markenrichtlinien von Classroom entsprechen.

API-Übersicht

Die Classroom API besteht aus mehreren Entitätstypen, die Kursen, Lehrkräften und Schülern/Studenten auf der Classroom-Benutzeroberfläche entsprechen. Einige dieser Entitäten haben zusätzlich zu den Funktionen in Classroom zusätzliche API-spezifische Attribute. Die primären Entitätstypen sind:

Ausführliche Informationen zu den API-Ressourcen und -Methoden finden Sie in der Referenz zur Classroom API.

Kursmetadaten und Aliasse

Kurse stehen für eine Klasse, z. B. „M. Mathematik in der 4. Phase“ und die zugewiesenen Lehrkräfte, Schülerliste und Metadaten. Jeder Kurs ist durch eine eindeutige ID gekennzeichnet, die vom Server zugewiesen wird. Die Kursressource enthält alle Metadaten zum Kurs, z. B. den Namen, die Beschreibung, den Ort und die Zeit. Kurslisten werden über die Ressourcen Schüler/Student, Lehrkraft und Einladung und die zugehörigen 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, um Aliasse zu erstellen, auf die alle Nutzer zugreifen müssen, die jedoch nicht programmspezifisch sind. Alternative Einträge für einen Kurs wie MATH 127 und COMSCI 127 sollten 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 die ID Classroom-Kursen zuzuordnen. In diesem Namespace erstellte Aliasse sind an eine bestimmte Google API Console gebunden. Jeder Nutzer einer Anwendung kann im Namespace Aliasse 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, die die Rolle des jeweiligen Nutzers im Kurs darstellen. Die Bezeichnungen von Schülern/Studenten und Lehrkräften sind nicht global: Ein Nutzer kann in einem 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.

Studenten

Eine Ressource vom Typ „Schüler/Student“ steht für einen Nutzer, der für das

für einen bestimmten Kurs. Schüler und Studenten dürfen die Kursdetails und die Lehrkräfte des Kurses sehen.

Lehrkräfte

Eine Ressource vom Typ „Lehrkraft“ steht für einen Nutzer, der einen bestimmten Kurs unterrichtet.

Lehrkräfte können die Kursdetails aufrufen und ändern, Lehrkräfte und Schüler/Studenten aufrufen und zusätzliche Lehrkräfte und Schüler/Studenten verwalten.

Einladungen und die zugehörigen Methoden sind eine bequeme Möglichkeit, Schüler und Studenten und Lehrkräfte zu Kursen hinzuzufügen. Wenn Sie Einladungen erstellen, können Nutzer selbst entscheiden, ob sie einem Kurs beitreten möchten oder nicht. Sie müssen sie also nicht direkt über die Ressourcen für Lehrkräfte und Schüler oder Studenten hinzufü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 dem Kürzel "me" auf seine eigene ID verweisen.

Weitere Informationen zum Verwalten von Teilnehmerlisten finden Sie unter Lehrkräfte und Schüler/Studenten verwalten.

Kursaufgaben und abgegebene Aufgaben

Ein CourseWork-Element steht für eine einzelne Aufgabe, die einer Gruppe von Lernenden in einem Kurs zugewiesen wird. Es enthält Details wie Beschreibung, Fälligkeitsdatum und Materialien sowie Metadaten wie den Erstellungszeitpunkt. Zu den Materialien gehören ein Titel, ein Thumbnail, eine URL sowie eine Kennung, die mit den entsprechenden APIs (z.B. Drive, YouTube) verwendet werden kann.

In „Kurswork-Elemente“ wird eine der folgenden Arten von Aufgaben beschrieben:

  • Eine Aufgabe, die Lernende durch Einreichen von Arbeitsblättern oder anderen Anhängen erledigen.
  • Eine Kurzantwort- oder Multiple-Choice-Frage.

Die Aufgaben von Schülern/Studenten für ein CourseWork-Element werden durch ein StudentSubmission-Objekt gekennzeichnet. Sie besteht aus einer Antwort und zusätzlichen Metadaten, z. B. einem Status und einer zugewiesenen Note.

Der Inhalt einer StudentSubmission hängt vom Typ des entsprechenden Kurselements ab:

  • Die Arbeitsblätter und Anhänge, die für eine Aufgabe eingereicht wurden, 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.

Add-ons für Classroom

Ein Add-on ist eine von Partnern bereitgestellte UI und ein Back-End, die normalerweise in einem iFrame angezeigt werden. Add-ons werden als Anhänge in einem Beitrag angezeigt. Das kann Announcements, CourseWork oder CourseWorkMaterials sein.

Add-on-Anhänge können Aktivitäten oder Inhalte sein.

  • Damit Anhänge zu Aktivitäten hinzugefügt werden können, muss ein Schüler oder Student eine einzelne Aufgabe ausfüllen und abgeben. Beispiele hierfür sind Quizze, Zeichnungen oder Spiele. Aufgaben können optional benotet werden.
  • Inhaltsanhänge müssen nicht abgegeben werden. Die Lernenden müssen den Anhang nicht abgeben und er wird nicht benotet. Beispiele hierfür sind Fotos, Artikel und Videos.

Weitere Informationen finden Sie in den Entwicklerleitfäden für Add-ons.

Kurzanleitungen

Mithilfe der Kurzanleitungen können Sie Ihre Umgebung einrichten und sofort mit der API loslegen:

Mit Google APIs Explorer experimentieren

Verwenden Sie Google APIs Explorer, um Aufrufmethoden mit Live-Daten zu testen. Sie müssen zu Beginn keinen Code schreiben. Beachten Sie jedoch, dass durch Aktionen, die Sie mit APIs Explorer ausführen, vorhandene Daten geändert werden 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 id aus der zurückgegebenen Liste von Kursen abrufen und als Anfrageparameter für andere API-Aufrufe verwenden. 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.