Übersicht

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 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 in ihrer Domain unterrichteten Kurse zu erhalten.

Anwendungsentwickler können die Classroom API verwenden, um ihre Anwendungen in Classroom zu integrieren. Diese Apps 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 „Teilen“ 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 neben den Classroom-Funktionen 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, Schülerliste und 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. den Namen, die Beschreibung, den Ort und die Uhrzeit. Kurslisten werden über die Ressourcen Student, Teacher und Einladung sowie die entsprechenden 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 die 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 für Lernende stellt einen Nutzer dar, der als Schüler/Student an einer

für einen bestimmten Kurs. Lernende können die Kursdetails und die Lehrkräfte für diesen Kurs sehen.

Lehrer

Eine Lehrkraftressource 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 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 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.

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 dem Status und der 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.

Add-ons für Classroom

Ein Add-on ist eine von einem Partner 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.

Bei Add-on-Anhängen kann es sich um Aktivitäten oder Inhalte handeln.

  • Dazu müssen die Lernenden eine einzelne Aufgabe ausfüllen und abgeben. Beispiele hierfür sind Quizze, Zeichnungen oder Spiele. Eine Aktivität kann 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

Wenn Sie Ihre Umgebung einrichten und sofort mit der API starten möchten, sehen Sie sich eine der Kurzanleitungen an:

Mit Google APIs Explorer experimentieren

Wenn Sie Aufrufmethoden für Live-Daten testen möchten, verwenden Sie den Google APIs Explorer. Sie müssen dafür keinen Code schreiben. Beachten Sie jedoch, dass mit APIs Explorer ausgeführte Aktionen 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.