Interfejs Classroom API udostępnia interfejs RESTowy, który umożliwia zarządzanie zajęciami i programami lojalnościowymi w Google Classroom. Oprócz tego przycisk udostępniania w Classroom umożliwia deweloperom i właścicielom treści udostępnianie swoich materiałów w Classroom.
Kto może korzystać z interfejsu API?
Administratorzy domeny Google Workspace for Education mogą używać tego interfejsu API do automatycznego udostępniania zajęć w imieniu nauczycieli, synchronizowania systemów informacji o uczniach z Classroom oraz uzyskania podstawowego wglądu w zajęcia prowadzone w domenie.
Interfejs Classroom API może być używany przez deweloperów aplikacji do integrowania swoich aplikacji z Classroom. Te aplikacje muszą korzystać z protokołu OAuth 2.0, aby prosić o uprawnienia do wyświetlania zajęć i list uczniów z nauczycieli. Administratorzy mogą określać, czy nauczyciele i uczniowie w domenie mogą zezwalać aplikacjom na dostęp do swoich danych w Google Classroom.
Właściciele witryn i deweloperzy treści mogą używać przycisku udostępniania Classroom, aby umożliwić uczniom i nauczycielom udostępnianie treści w Classroom.
Wszystkie funkcje integracji interfejsu API i przycisków udostępniania w Classroom muszą być zgodne ze wskazówkami dotyczącymi marki Classroom.
Przegląd interfejsów API
Interfejs Classroom API składa się z kilku typów elementów, które odpowiadają klasom, nauczycielom i uczniom w interfejsie Classroom. Niektóre z tych elementów mają dodatkowe właściwości specyficzne dla interfejsu API, oprócz opcji dostępnych w Classroom. Typy elementów głównych:
- Kursy
- Aliasy
- Zaproszenia
- Uczniowie
- Nauczyciele
- Profile użytkowników
- Zadania
- Tematy
- Zadania przesłane przez uczniów
Szczegółowe informacje o zasobach i metodach interfejsu API znajdziesz w dokumentacji interfejsu Classroom API.
Metadane i aliasy zajęć
Kursy oznaczają zajęcia, na przykład „M. „Matematyka IV okresu” oraz przypisanych do nich nauczycieli, lista uczniów i metadane. Każdy kurs jest identyfikowany przez unikalny identyfikator przypisany przez serwer. Zasób z kursem zawiera wszystkie metadane dotyczące kursu, w tym jego nazwę, opis, lokalizację i czas. Listami uczniów można zarządzać za pomocą zasobów Uczeń, Nauczyciela i Zaproszenia (oraz dostępnych w nich metod).
Aliasy to alternatywne identyfikatory zajęć, które można powiązać z kursem i używać ich zamiast unikalnego identyfikatora. Każdy alias istnieje w przestrzeni nazw, która ogranicza możliwość tworzenia i wyświetlania go. Obsługiwane są 2 przestrzenie nazw:
- Domena: przestrzeń nazw domeny przydaje się do tworzenia aliasów, do których użytkownicy potrzebują dostępu, ale które nie są związane z żadnym programem. Na przykład alternatywne strony zajęć, takie jak MATH 127 i COMSCI 127, należy tworzyć w przestrzeni nazw domeny. Aliasy w przestrzeni nazw domeny mogą być tworzone tylko przez administratorów domeny, ale są widoczne dla wszystkich użytkowników domeny.
- Projekt programisty: przestrzeń nazw projektu programisty przydaje się do zarządzania aliasami specyficznymi dla aplikacji. Na przykład aplikacja korzystająca z alternatywnych identyfikatorów kursów może tworzyć aliasy do mapowania swojego identyfikatora na kursy Classroom. Aliasy utworzone w tej przestrzeni nazw są powiązane z konkretną konsolą interfejsów API Google. Każdy użytkownik aplikacji może tworzyć i wyświetlać aliasy w przestrzeni nazw projektu programisty tej aplikacji.
Więcej informacji o zarządzaniu metadanymi i aliasami zajęć znajdziesz w artykule Zarządzanie zajęciami.
Listy uczniów i użytkownicy zajęć
Uczniowie i Nauczyciele to określone powiązania między profilem użytkownika a zajęciami, które reprezentują rolę użytkownika na zajęciach. Oznaczenia uczniów i nauczycieli nie są globalne: użytkownik może zostać przypisany jako nauczyciel na jednych zajęciach, a na drugim – jako uczeń. Termin „uczeń” lub „nauczyciel” odnosi się do zbioru uprawnień danego użytkownika na danych zajęciach.
- Uczniowie
- Zasób dla uczniów to użytkownik, który jest zapisany jako uczeń na danym kursie. Uczniowie mogą wyświetlać szczegóły zajęć i ich nauczycieli.
- Nauczyciele
- Zasób dla nauczyciela to użytkownik, który prowadzi dany kurs. Nauczyciele mogą wyświetlać i zmieniać szczegóły zajęć, wyświetlać nauczycieli i uczniów oraz zarządzać dodatkowymi nauczycielami i uczniami.
Zaproszenia i powiązane z nimi metody umożliwiają wygodne dodawanie uczniów i nauczycieli do zajęć. Dzięki temu użytkownicy mogą zdecydować, czy chcą wziąć udział w zajęciach. Nie musisz dodawać ich bezpośrednio za pomocą zasobów dla nauczycieli i uczniów.
UserProfiles reprezentują mapowanie na profil użytkownika w domenie identyfikowany przez unikalny identyfikator lub adres e-mail użytkownika zwróconego przez interfejs Directory API.
Bieżący użytkownik może się też powołać na własny identyfikator, korzystając ze skrótu "me".
Więcej informacji o zarządzaniu listami uczniów znajdziesz w artykule Zarządzanie nauczycielami i uczniami.
zadania i przesłane przez uczniów zadania;
Element CourseWork reprezentuje pojedyncze zadanie przypisane grupie uczniów na zajęciach. Zawiera szczegóły, takie jak opis, termin i materiały, a także metadane, takie jak czas utworzenia. Materiały obejmują tytuł, miniaturę i adres URL, a także identyfikatory, których można używać z odpowiednimi interfejsami API (np. Dysk czy YouTube).
Elementy CourseWork opisują jeden z następujących typów zadań:
- Projekt, który uczniowie wykonują, przesyłając arkusze robocze lub inne załączniki.
- Pytanie z krótką odpowiedzią lub pytanie jednokrotnego wyboru.
Zadania uczniów z elementu CourseWork są reprezentowane przez StudentSubmission. Składa się z odpowiedzi i dodatkowych metadanych, takich jak stan i przypisana ocena.
Zawartość elementu StudentSubmission jest uzależniona od typu odpowiadającego mu elementu CourseWork:
- Arkusze i załączniki przesłane do projektu, w tym ich tytuł, miniatura i adres URL, a także identyfikatory, których można używać z odpowiednimi interfejsami API, takimi jak Dysk czy YouTube.
- Odpowiedź na pytanie z krótką odpowiedzią lub pytanie jednokrotnego wyboru.
Więcej informacji o zarządzaniu zadaniami i przesłanymi przez uczniów zadaniami znajdziesz w artykule Zarządzanie zadaniami.
Krótkie wprowadzenia
Aby skonfigurować środowisko i od razu zacząć korzystać z interfejsu API, skorzystaj z jednego z krótkich wprowadzeń:
Eksperymenty z Classroom API Explorer
Aby poeksperymentować z metodami wywoływania danych z aktywnych danych, użyj narzędzia Classroom API Explorer. Aby rozpocząć, nie musisz pisać żadnego kodu, ale pamiętaj, że działania wykonywane za pomocą eksploratora interfejsów API mogą modyfikować istniejące dane.
Jednym ze sposobów na wywoływanie metod jest wywołanie metody courses.list(). Ta metoda nie wymaga żadnych parametrów żądania i możesz pobrać id ze zwróconej listy kursów, aby wykorzystać je jako parametr żądania w innych wywołaniach interfejsu API. Jeśli nie masz żadnych kursów, możesz je utworzyć, korzystając z metody courses.create().
Możesz też zapoznać się z dokumentacją interfejsu API.