Sie können Kurse mit einem anderen Namen referenzieren, indem Sie einen Kursalias verwenden. Kursaliasse können als Zuordnung zwischen Google Classroom-Kurs-IDs und externen Kurs-IDs dienen. Sie können beispielsweise einen Kursalias festlegen, der mit der Kurs-ID aus einem Schüler-/Studenteninformationssystem (SIS) übereinstimmt.
Der Kursalias hat zwei Formen: domainweit und projektweit.
Domainweite Aliase haben das Präfix
d:und sind für alle Nutzer der Classroom API sichtbar. Der Domain-Namespace ist nützlich, um Aliase zu erstellen, auf die alle Nutzer Zugriff benötigen, die aber nicht spezifisch für ein bestimmtes Programm sind. Beispielsweise sollten alternative Einträge für einen Kurs wie MATH 127 und COMSCI 127 im Domain-Namespace erstellt werden. Aliasse im Domain-Namespace können nur von Domainadministratoren erstellt werden, sind aber für alle Nutzer in einer Domain sichtbar.Projektweite Aliase haben das Präfix
p:und können nur vom Google Cloud-Projekt, in dem sie erstellt wurden, gesehen und verwendet werden. Der Namespace für das Entwicklerprojekt ist nützlich, um Aliase zu verwalten, die spezifisch für eine Anwendung sind. Beispielsweise kann eine Anwendung, die alternative IDs für Kurse verwendet, Aliase erstellen, um ihre ID Classroom-Kursen zuzuordnen. Aliasse, die in diesem Namespace erstellt wurden, sind mit einem bestimmten Google Cloud-Projekt verknüpft. 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 verwendet werden kann, um Kurs- und Teilnehmerlisteninformationen zu lesen und zu ändern.
Alias für die Synchronisierung mit Schüler-/Studenteninformationssystemen verwenden
Die interne SIS-ID für einen Kurs kann als domainweiter Alias für den Kurs registriert werden. So kann jeder Entwickler, der sowohl in das SIS als auch in Classroom integriert ist, die SIS-ID verwenden, um mit Classroom-Daten zu interagieren.
Wenn Sie einen Kurs aus einem 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 courses.create() Methode erstellen, können Sie den Alias im
id Feld der Anfrage angeben. Wenn der Alias bereits vorhanden ist, schlägt die Kurserstellung mit dem Fehler 409 ALREADY_EXISTS fehl. So wird verhindert, dass bei einem Problem im Synchronisierungsprogramm doppelte Kurse erstellt werden.
Wenn der SIS-Name beispielsweise school ist und die interne ID
, die vom SIS für einen bestimmten Kurs verwendet wird, math_101 lautet, 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 bei der Anfrage courses.create() auf einen Alias fest.
Apps Script
Java
Python
Alias für einen vorhandenen Kurs hinzufügen
Wenn Sie den Alias für einen 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
courses.aliases.list() Methode abrufen, wie im
folgenden Beispiel gezeigt:
.NET
Java
Python