Die Google Classroom API bietet eine Programmierschnittstelle für Softwareentwickler, Administratoren und Schulleiter zur Verwaltung von Google Classroom-Ressourcen. Sie können Software entwickeln, mit der Classroom-Kurse und deren Inhalte erstellt, abgerufen und geändert werden können.
Einige typische Anwendungsfälle:
- Kurse, Teilnehmerlisten und Erziehungsberechtigte verwalten
- Aufgaben, Ankündigungen und Kursmaterialien hinzufügen
- Noten zuweisen und Noteneinstellungen ändern
- Daten für die Analyse generieren
- Inhalte oder Tools eines externen Anbieters in Classroom auffindbar und zugänglich machen
Ist die Classroom API die richtige Lösung für mich?
Google bietet verschiedene Produkte, mit denen Sie mit Classroom interagieren können. Im Folgenden finden Sie einige häufige Szenarien und Empfehlungen für Produkte, die Ihren Anforderungen am besten entsprechen.
Google Classroom-Ressourcen ändern
Szenario | Empfohlene Lösungen |
---|---|
Ich möchte regelmäßig eine große Anzahl von Kursen, Nutzern oder anderen Classroom-Ressourcen verwalten. Ich bin mit dem Schreiben von Code und der Wartung von Softwareinfrastruktur vertraut. | Anwendungen schreiben, die die Classroom API verwenden. |
Ich möchte gelegentlich eine kleine Anzahl von Classroom-Ressourcen verwalten. Ich kann problemlos kleine Mengen an Code mit geringem Aufwand schreiben. | Verwenden Sie die Classroom API mit Google Apps Script. |
Ich möchte gelegentlich Änderungen an einzelnen Classroom-Ressourcen vornehmen. Ich bin mit der Arbeit mit Terminalbefehlen vertraut. | Verwenden Sie Google Apps Manager. |
Ich möchte eine große Anzahl von Berichten mit Details zu Ereignissen in Classroom. | Verwenden Sie den BigQuery Data Transfer Service. |
Ich möchte die Aktivitäten meiner Nutzer untersuchen. | Sie können Berichte in der Admin-Konsole erstellen oder die Reports API verwenden. |
Integration in Google Classroom
Szenario | Empfohlene Lösungen |
---|---|
Ich möchte, dass Lehrkräfte und Schüler/Studenten meine Inhalte in Classroom sehen und starten können. | Erstellen Sie ein Classroom-Add‑on. |
Ich möchte, dass Lehrkräfte auf meiner Website oder in meiner App auf eine Schaltfläche klicken, um meine Inhalte in Classroom einzubetten. | Classroom-Add‑on erstellen und Anhänge programmatisch erstellen |
Ich möchte, dass Lehrkräfte auf meiner Website oder in meiner App auf eine Schaltfläche klicken, um eine Verknüpfung zu meinen Inhalten in Classroom herzustellen. | Kursaufgaben erstellen mit der Classroom API oder Schaltflächen zum Teilen von Inhalten in Classroom einbetten. |
Ich möchte, dass Classroom-Lehrkräfte Informationen aus meinem Schüler-/Studenteninformationssystem synchronisieren oder importieren. | Implementieren Sie OneRoster für SIS oder erstellen und greifen Sie auf Ressourcen mit der Classroom API zu. |
Erste Schritte
Neue Entwickler sollten vor dem Start eines neuen Projekts Folgendes tun:
- Leitfaden zur Struktur der Classroom API
- Weitere Informationen finden Sie unter Klassen, Nutzertypen, Voraussetzungen für Nutzer und Administratoraktionen. In diesen Leitfäden werden Konzepte erläutert, die für Google Classroom und die Classroom API spezifisch sind.
- So funktionieren Classroom API-Anfragen
Bevor Sie mit der Entwicklung beginnen, müssen Sie die erforderlichen Schritte ausführen. Wählen Sie die passenden Classroom API-Bereiche für Ihre Anforderungen aus, richten Sie Ihre Umgebung ein und beginnen Sie mit Anfragen, indem Sie einer der Schnellstartanleitungen folgen:
Google APIs Explorer ausprobieren
Wenn Sie Methoden für Live-Daten aufrufen möchten, können Sie den Google APIs Explorer verwenden. Sie müssen keinen Code schreiben, um loszulegen. Beachten Sie jedoch, dass Aktionen, die Sie mit dem API Explorer ausführen, vorhandene Daten ändern können.
Eine Möglichkeit, die Methoden aufzurufen, ist die Methode courses.list()
. Für diese Methode sind keine Anfrageparameter erforderlich. Sie können eine id
aus der zurückgegebenen Liste der Kurse abrufen, die Sie als Anfrageparameter für andere API-Aufrufe verwenden können. Wenn Sie keine Kurse haben, können Sie mit der Methode courses.create()
einen erstellen.
Sie können sich auch die Classroom API-Referenz ansehen.