Mit einer Ressource vom Typ „Kursalias“ können Sie auf Kurse mit einem anderen Namen verweisen. Kursaliasse sind eine Zuordnung zwischen Google Classroom-Kurs-IDs und externen Kurs-IDs.
Wir empfehlen, dass Sie bei jedem Erstellen eines Kurses aus einem SIS oder Verknüpfen eines Kurses mit einem SIS die Kurs-ID des SIS als Kursalias verwenden. Mit der Classroom API können Sie dies direkt beim Erstellen des Kurses tun, indem Sie den Parameter id
des Kurses als Alias angeben. Wenn der Alias bereits vorhanden ist, schlägt die Kurserstellung mit einem ALREADY_EXISTS (409)
-Fehler fehl. So wird verhindert, dass bei einem Fehler im Synchronisierungsprogramm doppelte Kurse erstellt werden.
Aliasse gibt es in zwei Varianten: domainweit und projektweit.
- Domainweite Aliasse haben das Präfix
d:
und sind für alle Nutzer sichtbar, die die Classroom API verwenden. - Projektweite Aliase haben das Präfix
p:
und können nur von der Anwendung (Entwicklerkonsolenprojekt), in der sie erstellt wurden, gesehen und verwendet werden.
Aliasse können überall in der API verwendet werden, wo eine Kurs-ID erwartet wird. Das bedeutet, dass ein Alias, der über die API registriert wurde, zum Lesen und Ändern von Kurs- und Teilnehmerlisten verwendet werden kann.
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 einbindet, einfach die SIS-ID verwenden, um mit Classroom-Daten zu interagieren.
Angenommen, der Name des SIS lautet school
und die vom SIS für einen bestimmten Kurs verwendete interne Kennung ist math_101
, könnten Sie einen Alias wie d:school_math_101
erstellen.
Alias für einen neuen Kurs hinzufügen
Wenn du einen Alias für einen neuen Kurs hinzufügen möchtest, setze course.id
bei der courses.create()
-Anfrage auf den gewünschten Alias.
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 alias
auf den gewünschten Aliasnamen festlegen und die Methode courses.aliases.create()
verwenden.
Apps Script
Java
Python
Kursaliasse abrufen
Sie können die Aliasse für einen Kurs mit der Methode courses.aliases.list()
abrufen, wie im folgenden Beispiel gezeigt:
.NET
Java
Python