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 ihre 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 vergeben und Noteneinstellungen ändern
- Daten für die Analyse generieren
- Inhalte oder Tools von Drittanbietern 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 kann Code schreiben und Softwareinfrastruktur verwalten. | Anwendungen schreiben, die die Classroom API verwenden. |
| Ich möchte gelegentlich eine kleine Anzahl von Classroom-Ressourcen verwalten. Ich kann mit wenig Aufwand kleine Mengen an Code schreiben. | Classroom API mit Google Apps Script verwenden. |
| Ich möchte gelegentlich Änderungen an einzelnen Classroom-Ressourcen vornehmen. Ich kann mit Terminalbefehlen arbeiten. | Google Apps Manager verwenden. |
| Ich möchte eine große Anzahl von Berichten mit Details zu Ereignissen in Classroom. | BigQuery Data Transfer Service verwenden. |
| Ich möchte die Aktivitäten meiner Nutzer untersuchen. | Berichte in der Admin-Konsole erstellen oder die Reports APIverwenden. |
In Google Classroom einbinden
| Szenario | Empfohlene Lösungen |
|---|---|
| Ich möchte, dass Lehrkräfte und Schüler/Studenten meine Inhalte in Classroom sehen und starten können. | Classroom-Add‑on erstellen. |
| Ich möchte, dass Lehrkräfte auf meiner Website oder in meiner App auf eine Schaltfläche klicken können, 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 können, um in Classroom auf meine Inhalte zu verlinken. | Kursaufgaben mit der Classroom API erstellen oder Schaltflächen „Mit Classroom teilen“ einbetten. |
| Ich möchte, dass Classroom-Lehrkräfte Informationen aus meinem Schüler-/Studenteninformationssystem synchronisieren oder importieren können. | OneRoster für SIS implementieren oder Ressourcen mit der Classroom API erstellen und darauf zugreifen. |
Erste Schritte
Neue Entwickler sollten vor dem Start eines neuen Projekts Folgendes tun:
- Lesen Sie unseren Leitfaden zur Struktur der Classroom API.
- Lesen Sie die Informationen zu Noten, Nutzertypen, Nutzerberechtigung und Administrator aktionen. In diesen Leitfäden werden Konzepte erläutert, die für Google Classroom und die Classroom API spezifisch sind.
- Informationen zu Classroom API-Anfragen
Bevor Sie mit der Entwicklung beginnen, müssen Sie die erforderlichen Schritte ausführen. Wählen Sie die entsprechenden Classroom API-Bereiche für Ihre Anforderungen aus, richten Sie dann Ihre Umgebung ein und senden Sie Anfragen. Folgen Sie dazu einer der Kurzanleitungen:
Mit dem Google APIs Explorer experimentieren
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 APIs Explorer ausführen, vorhandene Daten ändern können.
Eine Möglichkeit, die Methoden aufzurufen, ist die courses.list()
Methode. Für diese Methode sind keine Anfrageparameter erforderlich. Sie können eine id aus der zurückgegebenen Liste der Kurse abrufen und als Anfrageparameter für andere API-Aufrufe verwenden. Wenn Sie keine Kurse haben, können Sie mit der
courses.create() Methode einen Kurs erstellen.
Sie können auch die Classroom API-Referenz aufrufen.