Możesz odwoływać się do zajęć, korzystając z innej nazwy, za pomocą zasobu aliasu kursu. Nazwy skrótowe zajęć to mapowanie identyfikatorów zajęć w Google Classroom i zewnętrznych identyfikatorów zajęć.
Zalecamy, aby za każdym razem, gdy tworzysz kurs w systemie informacji o uczniach lub łączysz kurs z systemem informacji o uczniach, używać identyfikatora kursu z systemu informacji o uczniach jako aliasu kursu. Interfejs Classroom API umożliwia to bezpośrednio podczas tworzenia zajęć przez określenie parametru id
zajęć jako aliasu. Jeśli alias już istnieje, utworzenie zajęć zakończy się niepowodzeniem i wystąpi błąd ALREADY_EXISTS (409)
. Zapobiegnie to tworzeniu zduplikowanych kursów, jeśli w programie synchronizacji wystąpi błąd.
Istnieją 2 rodzaje aliasów: w całej domenie i w całym projekcie.
- Aliasy w całej domenie używają prefiksu
d:
i mogą być widoczne dla każdego, kto korzysta z interfejsu Classroom API. - Aliasy na poziomie projektu mają prefiks
p:
i mogą być widoczne oraz używane tylko przez aplikację (projekt w konsoli dewelopera), która je utworzyła.
Aliasów można używać w dowolnym miejscu interfejsu API, w którym wymagany jest identyfikator kursu. Oznacza to, że po zarejestrowaniu aliasu za pomocą interfejsu API można go używać do odczytywania i modyfikowania informacji o kursach i wymaganiach.
Z punktu widzenia synchronizacji z systemem informacji o uczniach oznacza to, że wewnętrzny identyfikator kursu można zarejestrować jako alias kursu w całej domenie. Dzięki temu każdy deweloper, który integruje się z systemem informacji o uczniach i Classroom, może po prostu używać identyfikatora systemu informacji o uczniach do interakcji z danymi Classroom.
Jeśli na przykład nazwa systemu informacji o uczniach to school
, a identyfikator wewnętrzny używany przez system informacji o uczniach w przypadku konkretnego kursu to math_101
, możesz utworzyć alias d:school_math_101
.
Dodawanie aliasu do nowych zajęć
Aby dodać alias dla nowego kursu, ustaw parametr course.id
na żądany alias podczas wysyłania żądania courses.create()
.
Google Apps Script
Java
Python
Dodawanie aliasu do istniejącego kursu
Aby dodać alias do istniejącego kursu, możesz ustawić wartość parametru alias
na żądaną nazwę aliasu i użyć metody courses.aliases.create()
.
Google Apps Script
Java
Python
Pobieranie aliasów kursów
Aliasy kursu możesz pobrać za pomocą metody courses.aliases.list()
, jak pokazano w tym przykładzie:
.NET
Java
Python