Mit einer Kursalias-Ressource können Sie unter einem anderen Namen auf Kurse verweisen. Kurs-Aliasse bilden eine Zuordnung zwischen Google Classroom-Kurs-IDs und externen Kurs-IDs.
Wir empfehlen, immer die Kurs-ID des SIS als Kursalias zu verwenden, wenn Sie einen Kurs aus einem SIS erstellen oder einen Kurs mit einem SIS verknüpfen. Mit der Classroom API können Sie dies direkt bei der Kurserstellung tun, indem Sie den Parameter id
des Kurses als Alias angeben. Wenn der Alias bereits vorhanden ist, schlägt die Kurserstellung mit dem Fehler ALREADY_EXISTS (409)
fehl. Dadurch wird verhindert, dass Kurse doppelt erstellt werden, wenn ein Fehler im Synchronisierungsprogramm vorliegt.
Es gibt zwei Arten von Aliassen: domainweit und projektweit.
- Domainweite Aliasse haben das Präfix
d:
und sind für alle Nutzer der Classroom API sichtbar. - Projektweite Aliasse verwenden das Präfix
p:
und können nur von der Anwendung (Entwicklerkonsolenprojekt) gesehen und verwendet werden, mit der sie erstellt wurden.
Aliasse können überall in der API verwendet werden, wo eine Kurs-ID erwartet wird. Sobald ein Alias über die API registriert ist, kann er zum Lesen und Ändern von Kurs- und Teilnehmerlisteninformationen verwendet werden.
Aus Sicht der SIS-Synchronisierung bedeutet dies, dass die interne SIS-ID für einen Kurs als domainweiter Alias für den Kurs registriert werden kann. So kann jeder Entwickler, der sowohl das SIS als auch Classroom integriert hat, einfach die SIS-ID verwenden, um mit Classroom-Daten zu interagieren.
Wenn wir beispielsweise davon ausgehen, dass der SIS-Name school
und die vom SIS für einen bestimmten Kurs verwendete interne Kennung math_101
ist, können Sie einen Alias als d:school_math_101
erstellen.
Alias für einen neuen Kurs hinzufügen
Wenn Sie einen Alias für einen neuen Kurs hinzufügen möchten, legen Sie für course.id
bei der courses.create()
-Anfrage den gewünschten Alias fest.
Apps Script
Java
Python
Alias für einen vorhandenen Kurs hinzufügen
Wenn Sie den Alias einem vorhandenen Kurs hinzufügen möchten, können Sie für alias
den gewünschten Alias festlegen und die Methode courses.aliases.create()
verwenden.
Apps Script
Java
Python
Kursaliasse abrufen
Mit der Methode courses.aliases.list()
können Sie die Aliasse für einen Kurs abrufen, wie im folgenden Beispiel gezeigt:
.NET
Java
Python