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.

Übersicht

Die Classroom API bietet eine RESTful-Schnittstelle, über die Sie Kurse und Teilnehmerlisten in Google Classroom verwalten können. Darüber hinaus können Entwickler über die Schaltfläche „Teilen in Classroom“ ihre Inhalte mit Classroom teilen.

Wer kann die API verwenden?

G Suite for Education-Domainadministratoren können mit der API programmatisch Kurse für Lehrkräfte bereitstellen, Schüler-/Studenteninformationssysteme mit Classroom synchronisieren und Einblick in die Kurse in ihrer Domain erhalten.

Anwendungsentwickler können die Classroom API verwenden, um ihre Apps in Classroom zu integrieren. Diese Anwendungen müssen OAuth 2.0 verwenden, um die Berechtigung zum Aufrufen von Klassen und Teilnehmerlisten für Lehrkräfte anzufordern. Administratoren können einschränken, ob Lehrkräfte sowie Schüler und Studenten in ihrer Domain Apps auf ihre Google Classroom-Daten zugreifen dürfen.

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

Alle Funktionen 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-Oberfläche entsprechen. Einige dieser Entitäten haben zusätzlich zu den in Classroom vorhandenen Attributen zusätzliche API-spezifische Eigenschaften. Die primären Entitätstypen sind:

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

Metadaten und Aliasse für Kurse

Kurse stellen eine Klasse dar, z. B. "M. Smith und seine Mathematik, Schülerliste und Metadaten. Jeder Kurs wird durch eine eindeutige ID identifiziert, die vom Server zugewiesen wird. Die Kursressource enthält insbesondere alle Metadaten zu dem Kurs, z. B. Name, Beschreibung und Ort. Teilnehmerlisten werden über die Ressourcen Schüler, Lehrkräfte und Einladungen und die zugehörigen Methoden verwaltet.

Aliasse sind alternative Kennungen für eine Klasse, die einem Kurs zugewiesen und anstelle der eindeutigen ID verwendet werden kann. Jeder Alias ist in einem Namespace vorhanden, der beschränkt, wer ihn erstellen und ansehen kann. Es werden zwei Namespaces unterstützt:

  • Domain: Der Domain-Namespace ist nützlich, um Aliasse zu erstellen, auf die alle Nutzer Zugriff haben, die aber nicht spezifisch für ein bestimmtes Programm 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 dürfen nur von Domainadministratoren erstellt werden, sind jedoch für alle Nutzer in einer Domain sichtbar.
  • Entwicklerprojekt: Der Namespace des Entwicklerprojekts ist nützlich für die Verwaltung von Aliassen, die für eine Anwendung spezifisch sind. Beispielsweise kann eine Anwendung, die alternative Kennungen für Kurse verwendet, Aliasse erstellen, um ihre ID den Classroom-Kursen zuzuordnen. Aliasse, die in diesem Namespace erstellt werden, sind an eine bestimmte Google API Console gebunden. Jeder Nutzer einer Anwendung kann Aliasse im Namespace für dieses Entwicklerprojekt erstellen und aufrufen.

Weitere Informationen zum Verwalten von Kursmetadaten und Aliassen finden Sie unter Kurse verwalten.

Teilnehmerlisten und Nutzer des Kurses

Schüler/Studenten und Lehrkräfte sind spezifische Verknüpfungen zwischen einem Nutzerprofil und einem Kurs. Sie repräsentieren die Rolle des Nutzers im Kurs. Die Bezeichnungen „Schüler/Student“ und „Lehrkraft“ sind nicht global: Ein Nutzer kann für einen Kurs als Lehrkraft und ein anderer Kursteilnehmer zugewiesen werden. Die Kennzeichnung „Schüler“ 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 angemeldet ist. Schüler/Studenten dürfen die Kursdetails und die Lehrkräfte für diesen Kurs sehen.
Lehrer
Eine Lehrkraft ist ein Nutzer, der einen bestimmten Kurs unterrichtet. Lehrkräfte können die Kursdetails aufrufen und ändern, Lehrkräfte sowie Schüler und Studenten sowie weitere Lehrkräfte und Schüler oder Studenten verwalten.

Mit Einladungen und den zugehörigen Methoden können Sie schnell Kursteilnehmer und Lehrkräfte hinzufügen. Wenn Sie Einladungen erstellen, können Nutzer entscheiden, ob sie an einem Kurs teilnehmen möchten oder nicht. Sie müssen sie nicht direkt über die Ressourcen für Lehrkräfte und Schüler/Studenten hinzufügen.

UserProfiles ist eine Zuordnung zu einem Domainprofil eines Nutzers, die durch die eindeutige ID oder E-Mail-Adresse des Nutzers identifiziert wird, die vom Google Admin SDK zurückgegeben wird. Der aktuelle Nutzer kann sich mit dem "me"-Kurzbefehl auch auf seine eigene ID beziehen.

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

Kursarbeiten und Aufgaben von Schülern/Studenten

Ein CourseWork-Element stellt eine einzelne Aufgabe dar, die einer Gruppe von Schülern in einem Kurs zugewiesen wird. Es enthält Details wie die Beschreibung, das Fälligkeitsdatum und Materialien sowie Metadaten wie den Erstellungsdatum. Materialien enthalten einen Titel, ein Thumbnail, eine URL und eine Kennzeichnung, die bei den entsprechenden APIs (z.B. Drive, YouTube) verwendet werden kann.

Kursaufgaben beschreiben eine der folgenden Arten von Aufgaben:

  • Eine Aufgabe, die Schüler oder Studenten durch Einreichen von Arbeitsblättern oder anderen Anhängen abschließen
  • Eine Kurzantwort- oder Multiple-Choice-Frage.

Die Aufgaben von Schülern/Studenten für ein Kurswerk werden durch eine StudentSubmission dargestellt. Sie besteht aus einer Antwort und zusätzlichen Metadaten wie einem Status und einer zugewiesenen Note.

Der Inhalt einer StudentSubmission hängt vom Typ des entsprechenden Kurs-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 zum Verwalten von Kursaufgaben und Schülern/Studenten finden Sie unter Kursaufgaben verwalten.

Erste Schritte

Probieren Sie eine der Kurzanleitungen aus, um Ihre Umgebung einzurichten und sofort mit der API zu starten:

Weitere Informationen finden Sie in der API-Referenz.