Mit einem Kursalias können Sie auf Kurse mit einem anderen Namen verweisen. Kursaliase können als Zuordnung zwischen Google Classroom-Kurs-IDs und externen Kurs-IDs dienen. Sie können beispielsweise einen Kursalias festlegen, der der Kurs-ID aus einem Schüler-/Studenteninformationssystem (SIS) entspricht.
Der Kursalias hat zwei Formen: domainweit und projektweit.
Domainweite Aliase verwenden das Präfix
d:
und können von allen Nutzern der Classroom API gesehen werden. Der Domain-Namespace ist nützlich, um Aliase zu erstellen, auf die alle Nutzer Zugriff benötigen, die aber nicht für ein bestimmtes Programm vorgesehen sind. Alternative Einträge für einen Kurs, z. B. MATH 127 und COMSCI 127, sollten im Domain-Namespace erstellt werden. Aliasse im Domain-Namespace dürfen nur von Domainadministratoren erstellt werden, sind aber für alle Nutzer in einer Domain sichtbar.Projektweite Aliase verwenden das Präfix
p:
und können nur vom Google Cloud-Projekt, in dem sie erstellt wurden, aufgerufen und verwendet werden. Der Namespace des Entwicklerprojekts ist nützlich, um Aliasse zu verwalten, die für eine Anwendung spezifisch sind. Eine Anwendung, die alternative Kennzeichnungen für Kurse verwendet, kann beispielsweise Aliase erstellen, um die Kennzeichnung der Anwendung den Classroom-Kursen zuzuordnen. In diesem Namespace erstellte Aliasse sind an ein bestimmtes Google Cloud-Projekt gebunden. Jeder Nutzer einer Anwendung kann Aliase im Namespace für das Entwicklerprojekt dieser Anwendung erstellen und ansehen.
Ein Kursalias kann anstelle der Classroom-Kurs-ID für jeden Classroom API-Endpunkt verwendet werden. Das bedeutet, dass der Alias zum Lesen und Ändern von Kursen und Teilnehmerlisten verwendet werden kann.
Alias für die Synchronisierung mit Schüler-/Studenteninformationssystemen verwenden
Die interne SIS-Kennung für einen Kurs kann als domainweiter Alias für den Kurs registriert werden. So kann jeder Entwickler, der sowohl das SIS als auch Classroom integriert, die SIS-Kennung verwenden, um mit Classroom-Daten zu interagieren.
Wenn Sie einen Kurs über ein SIS erstellen oder einen Kurs mit einem SIS verknüpfen, empfiehlt es sich, die Kurs-ID des SIS als Kursalias zu verwenden. Wenn Sie einen Kurs mit der Methode courses.create()
erstellen, können Sie den Alias im Feld id
der Anfrage angeben. Wenn der Alias bereits vorhanden ist, schlägt die Kurserstellung mit einem 409 ALREADY_EXISTS
-Fehler fehl. So wird verhindert, dass doppelte Kurse erstellt werden, wenn es ein Problem im Synchronisierungsprogramm gibt.
Wenn der SIS-Name beispielsweise school
und die interne Kennung, die vom SIS für einen bestimmten Kurs verwendet wird, 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 course.id
beim Senden der Anfrage courses.create()
auf einen 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 das Feld alias
festlegen und die Methode courses.aliases.create()
verwenden.
Apps Script
Java
Python
Kursaliasse abrufen
Sie können die Aliase für einen Kurs mit der Methode courses.aliases.list()
abrufen, wie im folgenden Beispiel gezeigt:
.NET
Java
Python