W zasobie aliasu zajęć możesz odwoływać się do zajęć pod inną nazwą. Aliasy zajęć służą do mapowania identyfikatorów zajęć w Google Classroom na zewnętrzne identyfikatory zajęć.
Zalecamy, aby za każdym razem, gdy tworzysz zajęcia w systemie informacji o uczniach lub łączysz je z tym systemem, jako alias zajęć używany jest identyfikator zajęć z systemu informacji o uczniach. Dzięki interfejsowi Classroom API możesz robić to bezpośrednio podczas tworzenia zajęć, określając parametr id
jako alias. Jeśli alias już istnieje, utworzenie kursu zakończy się niepowodzeniem i wyświetleniem błędu ALREADY_EXISTS (409)
. Zapobiegnie to tworzeniu zduplikowanych kursów w przypadku wystąpienia błędu w programie do synchronizacji.
Są 2 rodzaje aliasów: obejmujące całą domenę lub projekt.
- Aliasy w całej domenie używają prefiksu
d:
i mogą być widoczne dla każdego, kto korzysta z interfejsu Classroom API. - Aliasy obejmujące cały projekt używają prefiksu
p:
i są widoczne tylko dla aplikacji (projektu w konsoli programisty), która je utworzyła.
Aliasów można używać w dowolnym miejscu interfejsu API, które wymaga podania identyfikatora kursu. Oznacza to, że po zarejestrowaniu aliasu za pomocą interfejsu API można go używać do odczytywania i modyfikowania informacji o kursach oraz listach uczniów.
Z perspektywy synchronizacji z systemem informacji o uczniach oznacza to, że wewnętrzny identyfikator zajęć z systemu informacji o uczniach można zarejestrować jako alias kursu w całej domenie. Dzięki temu każdy deweloper, który przeprowadza integrację zarówno z systemem informacji o uczniach, jak i z Classroom, może po prostu używać identyfikatora systemu informacji o uczniach do interakcji z danymi Classroom.
Jeśli na przykład zakładamy, że nazwa systemu informacji o uczniach to school
, a wewnętrzny identyfikator używany przez system informacji o uczniach na potrzeby konkretnych zajęć to math_101
, możesz utworzyć alias jako d:school_math_101
.
Dodawanie aliasu dla nowych zajęć
Aby dodać alias do nowych zajęć, ustaw course.id
na odpowiedni alias podczas tworzenia żądania courses.create()
.
Google Apps Script
Java
Python
Dodawanie aliasu do istniejącego zajęć
Aby dodać alias do istniejącego kursu, ustaw alias
na odpowiednią nazwę aliasu i użyj metody courses.aliases.create()
.
Google Apps Script
Java
Python
Pobieranie aliasów zajęć
Aliasy zajęć możesz pobrać za pomocą metody courses.aliases.list()
, jak widać w tym przykładzie:
.NET
Java
Python