Przegląd

Interfejs Classroom API udostępnia interfejs typu REST, który umożliwia zarządzanie zajęciami i listami uczniów w Google Classroom. Oprócz tego przycisk udostępniania Classroom umożliwia programistom i właścicielom treści udostępnianie swoich treści w Classroom.

Kto może korzystać z interfejsu API?

Za pomocą tego interfejsu API administratorzy domeny Google Workspace for Education mogą programowo udostępniać zajęcia w imieniu nauczycieli, synchronizować systemy informacji o uczniach z Classroom oraz uzyskiwać podstawowy wgląd w zajęcia prowadzone w ich domenie.

Programiści aplikacji mogą używać interfejsu Classroom API do integrowania swoich aplikacji z Classroom. Te aplikacje muszą korzystać z protokołu OAuth 2.0, aby prosić o zgodę na wyświetlanie zajęć i list uczniów od nauczycieli. Administratorzy mogą ograniczać możliwość zezwalania aplikacjom na dostęp do ich danych w Google Classroom przez nauczycieli i uczniów w domenie.

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 integracje interfejsów API i przycisków udostępniania Classroom powinny 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ą zajęciom, nauczycielom i uczniom w interfejsie Classroom. Niektóre z tych elementów mają dodatkowe właściwości specyficzne dla interfejsu API, oprócz tych, które istnieją w Classroom. Główne typy encji to:

Szczegółowe informacje o zasobach i metodach interfejsu API znajdziesz w dokumentacji interfejsu Classroom API.

Metadane i aliasy kursu

Kursy oznaczają klasę, na przykład „M. „Matematyka z IV okresu” oraz przypisane do niej nauczycieli, lista uczniów i metadane. Każde szkolenie jest identyfikowane przez unikalny identyfikator przypisany przez serwer. Zasób kursu zawiera wszystkie metadane dotyczące kursu, takie jak jego nazwa, opis, lokalizacja i godzina. Listami uczniów zajęć można zarządzać za pomocą zasobów uczniów, nauczyciela i zaproszenia oraz ich metod.

Aliasy to alternatywne identyfikatory klasy, które mogą być powiązane z kursem i używane zamiast unikalnego identyfikatora. Każdy alias znajduje się w przestrzeni nazw, która ogranicza możliwość jego tworzenia i wyświetlania. Obsługiwane są 2 przestrzenie nazw:

  • Domena: przestrzeń nazw domeny jest przydatna przy tworzeniu aliasów, do których muszą mieć dostęp wszyscy użytkownicy, ale które nie są związane z konkretnym programem. Na przykład alternatywne wizytówki kursów, takie jak MATH 127 i COMSCI 127, powinny być tworzone w przestrzeni nazw domeny. Aliasy w przestrzeni nazw domeny mogą tworzyć tylko administratorzy domeny, ale są one 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 używająca alternatywnych identyfikatorów kursów może tworzyć aliasy do zmapowania swojego identyfikatora na zajęcia w 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 aplikacji.

Więcej informacji o zarządzaniu metadanymi i aliasami zajęć znajdziesz w artykule Zarządzanie kursami.

Listy uczniów i użytkownicy zajęć

Uczniowie i Nauczyciele to konkretne powiązania między profilem użytkownika a zajęciami, które reprezentują jego rolę w tych zajęciach. Oznaczenia uczniów i nauczycieli nie są globalne: użytkownika można przypisać w jednym kursie jako nauczyciel, a na drugim – jako nauczyciel. Termin „uczeń” lub „nauczyciel” odnosi się do zestawu uprawnień danego użytkownika na danym kursie.

Uczniowie

Zasób dla uczniów oznacza użytkownika, który jest zapisany jako uczeń w

konkretnego kursu. Uczniowie mogą wyświetlać szczegóły zajęć i ich nauczycieli.

Nauczyciele

Zasób dla nauczyciela reprezentuje użytkownika, który prowadzi określony 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 pozwalają w wygodny sposób dodawać uczniów i nauczycieli do zajęć. Tworzenie zaproszeń pozwala użytkownikom zdecydować, czy chcą dołączyć do zajęć. Nie trzeba dodawać ich bezpośrednio z poziomu zasobów dla nauczycieli i uczniów.

UserProfiles reprezentują mapowanie na profil użytkownika w domenie na podstawie unikalnego identyfikatora lub adresu e-mail użytkownika zwróconego przez interfejs Directory API. Bieżący użytkownik może się też odwoływać do własnego identyfikatora, używając skrótu "me".

Więcej informacji o zarządzaniu listami uczniów znajdziesz w artykule Zarządzanie nauczycielami i uczniami.

zadania i prace przesłane przez uczniów,

Element CourseWork reprezentuje pojedyncze zadanie przypisane grupie uczniów biorących udział w zajęciach. Zawiera szczegółowe informacje, 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 identyfikator, który można używać z odpowiednimi interfejsami API (takimi jak Dysk czy YouTube).

Elementy CourseWork opisują jeden z następujących typów zadań:

  • projekt realizowany przez ucznia, przesyłanie arkuszy lub innych załączników.
  • Pytanie z krótką odpowiedzią lub pytanie jednokrotnego wyboru.

Zadania uczniów związane z elementem CourseWork są reprezentowane przez StudentSubmission. Składa się z odpowiedzi i dodatkowych metadanych, takich jak stan i przypisana ocena.

Zawartość elementu StudentSubmission zależy od typu odpowiedniego elementu CourseWork:

  • Arkusze i załączniki przesłane do projektu, w tym 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.

Dodatki do Classroom

Dodatek to interfejs użytkownika obsługiwany przez partnerów i backend, który jest zwykle wyświetlany w elemencie iframe. Dodatki są wyświetlane jako załączniki do postów. Mogą to być Announcements, CourseWork lub CourseWorkMaterials.

Załącznikami mogą być aktywność lub treść.

  • Załączniki do zadań wymagają od ucznia ukończenia i oddania pojedynczego zadania. Mogą to być na przykład quizy, rysunki lub gry. Przesłane działanie może być opcjonalnie oceniane.
  • Załączniki treści nie wymagają przesyłania przez ucznia. Uczeń nie musi oddawać załącznika i nie zostanie on oceniony. Mogą to być zdjęcia, artykuły i filmy.

Więcej informacji znajdziesz w przewodnikach po tworzeniu dodatków.

Krótkie wprowadzenia

Aby skonfigurować środowisko i od razu zacząć korzystać z interfejsu API, zapoznaj się z jednym z krótkich wprowadzeń:

Eksperymentuj z narzędziem Google APIs Explorer

Jeśli chcesz poeksperymentować z metodami wywoływania danych na bieżąco, użyj eksploratora interfejsów API Google. Nie musisz pisać żadnego kodu, ale pamiętaj, że działania wykonywane w narzędziu APIs Explorer mogą modyfikować istniejące dane.

Jednym ze sposobów na wywołanie 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.