Zasoby interfejsu API

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

Ten przewodnik zawiera omówienie głównych komponentów interfejsu Google Classroom API. Interfejs Google Classroom API składa się z zasobów i usług. Zasoby reprezentują elementy w Google Classroom, takie jak kurs lub zadanie, a usługi pobierają te zasoby i nimi zarządzają. Niektóre z tych jednostek mają dodatkowe właściwości specyficzne dla interfejsu API, oprócz tych, które są dostępne w Classroom. Główne typy elementów to:

Jednostka	Reprezentacja w Classroom
Kursy	Klasa, np. „M. Smith's 4th period math".
Aliasy	Alternatywny identyfikator zajęć.
Zaproszenia	Sposób dodawania użytkowników do zajęć.
Uczniowie	Uczeń na zajęciach.
Nauczyciele	Nauczyciel na zajęciach.
Profile użytkowników	Użytkownik w ogóle, bez kontekstu ucznia lub nauczyciela.
CourseWork	Projekt na zajęciach.
StudentSubmissions	Uczniowie mogą przesyłać zadania, np. odpowiedzi lub arkusze.
CourseWorkMaterials	Materiały dla uczniów na zajęciach.
Ogłoszenia	ogłoszenie dla uczniów na zajęciach,
AddOnAttachment	Treści lub zadania w ramach projektu lub materiału, które są zwykle wyświetlane jako osadzony element iframe.
Tematy	Wizualne grupowanie projektów i materiałów na zajęciach.
Rejestracje	instrukcje dotyczące wysyłania powiadomień do aplikacji w przypadku zmian danych, np. listy uczniów na zajęciach.

Większość zasobów ma metody usługi do wykonywania standardowych operacji, takich jak odczytywanie, aktualizowanie i usuwanie wystąpień zasobu. Niektóre zasoby mają też niestandardowe metody do innych operacji, takich jak modyfikowanie listy uczniów przypisanych do konkretnego projektu.

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

Omówienie relacji między zasobami

• Zajęcia to podstawowy obiekt danych w Google Classroom.
• Aliasy są używane jako alternatywne identyfikatory Courses.
• Zaproszenia służą do zapraszania profili użytkowników do pełnienia roli nauczycieli lub uczniów w Course. Użytkownicy mogą też być dodawani bezpośrednio przez administratorów domen Google Workspace for Education.
• Nauczyciele tworzą elementy strumienia danych i udostępniają je uczniom na swoich kursach. Możliwe typy elementów strumienia to Coursework, CourseWorkMaterials i Announcements. CourseWork i CourseWorkMaterials można wizualnie uporządkować w tematy. Mogą one zawierać załączniki z dodatków. Uczniowie przesyłają StudentSubmissions do projektu CourseWork.
• Deweloperzy mogą tworzyć rejestracje, aby otrzymywać powiadomienia o zmianach niektórych danych.

Google Classroom jest dostępna w domenach, które korzystają z Google Workspace for Education. Domena w kontekście Classroom zwykle reprezentuje okręg szkolny. Możesz utworzyć domenę testową Google Workspace for Education na potrzeby rozwoju, co zapewni Ci kontrolę nad produkcyjną instancją Classroom bez wpływu na rzeczywistych użytkowników.

Kursy i aliasy

Courses reprezentuje klasę, np. „M”. „4 period zajęć z matematyki Smitha” oraz przypisani nauczyciele, lista uczniów i metadane. Każdy kurs jest identyfikowany przez unikalny identyfikator przypisany przez serwer. Zasób Course zawiera wszystkie metadane dotyczące kursu, takie jak nazwa, opis, lokalizacja i czas. Listami uczniów zarządza się za pomocą zasobów Uczeń, Nauczyciel i Zaproszenie oraz ich metod.

Aliases to alternatywne identyfikatory zajęć, 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, kto może go utworzyć i wyświetlić. Obsługiwane są 2 przestrzenie nazw:

• Domena: przestrzeń nazw domeny jest przydatna do tworzenia aliasów, do których dostęp muszą mieć wszyscy użytkownicy, ale które nie są specyficzne dla żadnego programu. Na przykład alternatywne listy 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ą widoczne dla wszystkich użytkowników w domenie.
• Projekt dewelopera: przestrzeń nazw projektu dewelopera jest przydatna do zarządzania aliasami związanymi z konkretną aplikacją. Na przykład aplikacja, która używa alternatywnych identyfikatorów kursów, może tworzyć aliasy, aby mapować identyfikator na kursy w Classroom. Aliasy utworzone w tym zakresie 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 dewelopera tej aplikacji.

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

Listy uczniów i uczniowie

Students i Teachers to konkretne odwzorowania profilu użytkownika i kursu, które wskazują rolę użytkownika w kursie. Użytkownik może być nauczycielem na jednych zajęciach i uczniem na innych. Oznaczenie „uczeń” lub „nauczyciel” oznacza zestaw uprawnień danego użytkownika w danym kursie. Kurs może mieć więcej niż 1 nauczyciela lub 0 uczniów. Nauczycieli i uczniów można dodawać do kursu lub usuwać z niego w dowolnym momencie.

Uczniowie

Zasób Student reprezentuje użytkownika, który jest uczniem na konkretnych zajęciach.

Uczniowie mogą wyświetlać informacje o zajęciach i nauczycielach.

Nauczyciele

Zasób Teacher reprezentuje użytkownika, który prowadzi konkretny kurs.

Nauczyciele mogą wyświetlać i zmieniać szczegóły kursu, wyświetlać nauczycieli oraz uczniów i zarządzać dodatkowymi nauczycielami i uczniami.

Invitations i powiązane z nimi metody umożliwiają wygodne dodawanie uczniów i nauczycieli do zajęć. Tworzenie zaproszeń pozwala użytkownikom decydować, czy chcą dołączyć do kursu, a nie dodawać ich bezpośrednio za pomocą zasobów dla nauczycieli i uczniów.

UserProfiles to mapowanie do profilu domeny użytkownika zidentyfikowanego na podstawie unikalnego identyfikatora lub adresu e-mail użytkownika zwróconego przez interfejs Directory API. Bieżący użytkownik może też odwoływać się do swojego identyfikatora za pomocą skrótu "me".

Usługi UserProfiles można też używać do zarządzania i zapraszania Guardians, czyli mapowania między uczniem a opiekunem. Opiekunowie w Classroom mają dostęp do niektórych informacji o uczniach, takich jak przypisane im zadania.

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

Elementy strumienia

Elementy strumienia to opublikowane treści udostępnione uczestnikom kursu. Deweloperzy i nauczyciele mogą tworzyć 3 typy elementów strumienia: Announcement, CourseWork i CourseWorkMaterial.

Nauczyciele tworzą Announcements u góry strony Strumień w interfejsie Google Classroom. Nauczyciele tworzą CourseWork i CourseWorkMaterials, klikając przycisk Utwórz na karcie Zadania. Deweloperzy mogą tworzyć wszystkie typy elementów strumienia programowo za pomocą interfejsu API Classroom.

W przypadku elementów strumienia obowiązują te zasady:

• Wszystkie elementy strumienia mogą zawierać materiały dodatkowe, takie jak pliki z Dysku Google, filmy z YouTube, Formularze Google, hiperlinki do stron internetowych i załączniki z dodatku do Google Classroom.
• Wszystkie elementy strumienia można przypisać do podzbioru uczniów na kursie.
• CourseWork może być oceniony lub nieoceniony. Nauczyciele mogą w każdej chwili zmienić stan ocenianiaCourseWork zadania.
• Element strumienia może mieć więcej niż 1 załącznik.
• Element strumienia może zawierać załączniki różnych typów. Na przykład jedno zadanieCourseWork może zawierać jednocześnie pliki z Dysku Google, filmy z YouTube i dodatki do Classroom.
• Element strumienia może zawierać załączniki dodatków od więcej niż 1 programisty.
• Deweloperzy mogą uzyskiwać i modyfikować szczegóły dotyczące dowolnego zasobu elementu strumienia, do którego jest dołączony jeden z ich dodatków.
• Deweloperzy mogą oddawać, odzyskiwać lub zwracać projekty uczniów w ramach zadania CourseWork, które zawiera jeden z ich załączników.
• Deweloperzy mogą tylko zatwierdzać oceny za poszczególne projekty uczniów w ramach stworzonych przez siebie projektów.

Skopiowane elementy strumienia

Nauczyciele mogą kopiować elementy strumienia, kopiując zajęcia, używając ponownie projektu lub publikując element strumienia na wielu zajęciach. Wszystkie nowe kopie będą miały odrębne identyfikatory, co może być ważne, jeśli opracowujesz dodatek do Google Classroom. Aby dowiedzieć się, jak w takich sytuacjach może działać dodatek, przeczytaj nasz przewodnik dotyczący kopiowanych treści.

Zadania i prace uczniów

Element CourseWork to projekt dla grupy uczniów na zajęciach. Jest to jedyny typ elementu strumienia, który może zawierać zadania uczniów. CourseWork zasób zawiera takie informacje jak opis, termin, maksymalna ocena i metadane, takie jak czas utworzenia.

Każdy zasób CourseWork odpowiada jednemu z tych typów zadań:

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

Zadania uczniów dotyczące elementu CourseWork są oznaczone symbolem StudentSubmission. Zawiera odpowiedź i dodatkowe metadane, takie jak stan i przypisana ocena.

Treści StudentSubmission zależą od typu odpowiadającego elementu CourseWork i mogą obejmować:

• Arkusze i załączniki przesłane w ramach 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 lub YouTube.
• Odpowiedź na pytanie z krótką odpowiedzią lub pytanie jednokrotnego wyboru.

Więcej informacji o zarządzaniu pracami dydaktycznymi i pracami przesłanymi przez uczniów znajdziesz w artykule Zarządzanie pracami dydaktycznymi.

Materiały szkoleniowe i ogłoszenia

Podobnie jak CourseWork, CourseWorkMaterials to treści przypisane grupie uczniów w kursie. Każdy zasób zawiera informacje takie jak tytuł i opis oraz materiały dodatkowe. W przeciwieństwie do CourseWork projekty CourseWorkMaterials nie wymagają od uczniów przesyłania żadnych artefaktów. W związku z tym nie ma podanego terminu, a w przypadku pola CourseWorkMaterials nie ma wartości.StudentSubmissions Nauczyciele mogą używać CourseWorkMaterials do publikowania sugerowanych lektur, programu nauczania lub zasad obowiązujących na zajęciach.

Announcements to również treści udostępniane grupie uczniów, ale nie zawierają one szczegółów, takich jak tytuł, i nie można ich porządkować według Topics, tak jak w przypadku CourseWork lub CourseWorkMaterials. Nauczyciele mogą używać tych funkcji do ogłaszania przypomnień lub powiadomień dla klasy.

Tematy

Topics służą do wizualnego porządkowania tabel CourseWork i CourseWorkMaterials w ramach zajęć. Można ich używać do grupowania zadań na „opcjonalne” i „wymagane” lub na przykład „moduł 1” i „moduł 2”.

Dodatki do Classroom

Dodatek to interfejs użytkownika i back-end obsługiwany przez dewelopera, który jest zwykle wyświetlany w ramce iframe. Dodatki są wyświetlane jako załączniki w elementach strumienia. Element strumienia może być dowolnym elementem typu Announcements, CourseWork lub CourseWorkMaterials. Załączniki dodatku są oznaczone symbolem AddOnAttachment.

Załączniki dodatków mogą być aktywnościami lub treściami.

• Załączniki do aktywności wymagają, aby uczeń ukończył i złożył indywidualne zgłoszenie. Przykłady: quizy, rysunki lub gry. Zgłoszenie aktywności może być opcjonalnie ocenione.
• Załączniki z treściami nie wymagają przesłania przez ucznia. Uczeń nie musi oddawać załącznika, a jego ocena nie jest uwzględniana. Przykłady to zdjęcia, artykuły i filmy.

Więcej informacji znajdziesz w przewodnikach dotyczących tworzenia dodatków.

Rejestracje

Aplikacje mogą subskrybować powiadomienia o zmianach określonych danych w Google Classroom. Na przykład gdy zaktualizowany zostanie skład grupy zajęć. Registrations to instrukcja wysyłania tych powiadomień do aplikacji.

Więcej informacji znajdziesz w przewodniku na temat powiadomień push.