Czy Twoi użytkownicy korzystają z Classroom w Google Meet? Zapoznaj się z krótkim przewodnikiem po Apps Script dotyczącym sprawdzania obecności uczniów w kursach Google Meet.

Rozpocznij

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Interfejs Classroom API udostępnia interfejs RESTowy, który pozwala zarządzać kursami i listami uczniów w Google Classroom. Dodatkowo przycisk udostępniania w Classroom umożliwia deweloperom i właścicielom treści udostępnianie funkcji w Classroom.

Kto może używać interfejsu API?

Administratorzy domen Google Workspace for Education mogą za pomocą interfejsu API automatycznie udostępniać zajęcia w imieniu nauczycieli, synchronizować systemy informacji o uczniach z Classroom i mają podstawowy wgląd w zajęcia prowadzone w ich domenie.

Deweloperzy aplikacji mogą korzystać z interfejsu Classroom API, aby integrować swoje aplikacje z Classroom. Te aplikacje muszą używać protokołu OAuth 2.0 do wyświetlania uprawnień nauczycieli do zajęć i list uczniów. Administratorzy mogą ograniczać, czy nauczyciele i uczniowie w swojej domenie mogą zezwalać aplikacjom na dostęp do swoich danych z Google Classroom.

Właściciele witryn i deweloperzy treści mogą używać przycisku udostępniania w Classroom, aby umożliwić uczniom i nauczycielom udostępnianie treści w Classroom.

Wszystkie funkcje integracji przycisków interfejsu API i interfejsu Classroom powinny być zgodne ze wskazówkami dotyczącymi promowania marki w Classroom.

Przegląd interfejsów API

Interfejs Classroom API zawiera kilka typów encji odpowiadających klasom, nauczycielom i uczniom w interfejsie Classroom. Oprócz tych elementów w Classroom niektóre z tych elementów mają dodatkowe właściwości specyficzne dla interfejsu API. Główne typy encji:

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

Metadane i aliasy zajęć

Kursy reprezentują zajęcia, na przykład „M. Smitha z 4 etapu” oraz przypisanych do niego nauczycieli, listy uczniów i metadanych. Każdy kurs jest identyfikowany przez unikalny identyfikator przypisany przez serwer. Zasób Course zawiera wszystkie metadane dotyczące zajęć, takie jak nazwa, opis, lokalizacja i czas. Do zarządzania listami zajęć służą zasoby Uczeń, Nauczyciel i Zaproszenie oraz ich metody.

Aliasy to alternatywne identyfikatory zajęć, które mogą być powiązane z kursem i używać zamiast nich unikalnych identyfikatorów. Każdy alias istnieje 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 do tworzenia aliasów, do których wszyscy użytkownicy muszą mieć dostęp, ale które nie są powiązane z żadnym programem. Na przykład alternatywne listy kursów, takie jak MATH 127 i COMSCI 127, powinny być tworzone w przestrzeni nazw domen. Aliasy w przestrzeni nazw domeny mogą być tworzone tylko przez administratorów, ale są widoczne dla wszystkich użytkowników w domenie.
  • Projekt programisty: przestrzeń nazw projektu dewelopera jest przydatna do zarządzania aliasami specyficznymi dla aplikacji. Aplikacja, która używa na przykład identyfikatorów alternatywnych do zajęć, może tworzyć aliasy mapujące identyfikator uczniów na zajęcia w Classroom. Aliasy utworzone w tej przestrzeni nazw są powiązane z konkretną konsolą interfejsu API Google. Każdy użytkownik aplikacji może tworzyć i wyświetlać aliasy w przestrzeni nazw projektu dewelopera tej aplikacji.

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

Listy uczniów i użytkownicy

Uczniowie i Nauczyciele to konkretne mapowania między profilem użytkownika a kursem, które odpowiadają roli tego użytkownika w zajęciach. Oceny uczniów i nauczycieli nie są globalne: użytkownik może zostać przypisany jako nauczyciel na jednych zajęciach, a uczeń na innych. Określenie „uczeń” lub „nauczyciel” oznacza zbiór uprawnień użytkownika w ramach określonych kursów.

Uczniowie
Zasób dla ucznia reprezentuje użytkownika, który jest zarejestrowany na zajęciach na określonych zajęciach. Uczniowie mogą wyświetlać szczegóły i nauczycieli zajęć.
Nauczyciele
Zasób dla nauczyciela reprezentuje użytkownika, który prowadzi konkretny 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ęć. Dzięki temu użytkownicy mogą sami zdecydować, czy chcą dołączyć do zajęć. Nie muszą to być bezpośrednie materiały dodawane przez nauczycieli i uczniów.

UserProfiles to mapowania na profile domen użytkowników określane za pomocą unikalnego identyfikatora lub adresu e-mail użytkownika zwróconego przez interfejs Directory API. Bieżący użytkownik może również odwoływać się do swojego identyfikatora za pomocą skrótu "me".

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

zadania i zadania przesłane przez uczniów,

Element CourseWork reprezentuje pojedyncze zadanie przypisane do grupy uczniów na zajęciach. Zawiera takie szczegóły jak opis, termin i materiały, a także metadane, takie jak czas utworzenia. Materiałami są tytuły, miniatury i adresy URL, a także identyfikatory, których można używać z odpowiednimi interfejsami API (np. Dysk czy YouTube).

Elementy CourseWork opisują jedno z tych typów zadań:

  • Projekt, który uczniowie wypełniają, przesyłając arkusze lub inne załączniki.
  • Pytanie z krótką odpowiedzią lub pytanie jednokrotnego wyboru.

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

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

  • Arkusze i załączniki przesłane w ramach projektu, w tym tytuł, miniatura i 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 zadaniami uczniów znajdziesz w artykule Zarządzanie zadaniami.

Krótkie wprowadzenia

Aby skonfigurować środowisko i od razu zacząć korzystać z interfejsu API, wypróbuj jeden z tych krótkich przewodników:

Eksperymentuj z eksploratorem interfejsu Classroom API

Aby poeksperymentować z metodami wywoływania danych na żywo, skorzystaj z eksploratora interfejsu Classroom API. Nie musisz pisać żadnego kodu, ale pamiętaj, że czynności wykonywane w eksploratorze interfejsu API mogą modyfikować istniejące dane.

Jednym ze sposobów na rozpoczęcie wywoływania metod jest wywołanie metody courses.list(). Ta metoda nie wymaga żadnych parametrów żądania, a z zwróconej listy kursów możesz pobrać id, który będzie używany jako parametr żądania w innych wywołaniach interfejsu API. Jeśli nie masz jeszcze żadnych kursów, możesz je utworzyć za pomocą metody courses.create().

Możesz też zapoznać się z materiałami referencyjnymi interfejsu API.