Zarządzaje zajęciami, listami uczniów i zaproszeniami w Google Classroom.
- Zasób REST: v1.courses
- Zasób REST: v1.courses.aliases
- Zasób REST: v1.courses.announcements
- Zasób REST: v1.courses.courseWork
- Zasób REST: v1.courses.courseWork.studentSubmissions
- Zasób REST: v1.courses.courseWorkMaterials
- Zasób REST: v1.courses.students
- Zasób REST: v1.courses.teachers
- Zasób REST: v1.courses.topics
- Zasób REST: v1.invitations
- Zasób REST: v1.registrations
- Zasób REST: v1.userProfiles
- Zasób REST: v1.userProfiles.guardianInvitations
- Zasób REST: v1.userProfiles.guardians
Usługa: classroom.googleapis.com
Zalecamy korzystanie z bibliotek klienta dostarczonych przez Google. Jeśli aplikacja musi używać własnych bibliotek do wywoływania tej usługi, podczas przesyłania żądań do interfejsu API należy użyć poniższych informacji.
Dokument Discovery
Dokument opisujący to czytelna dla komputera specyfikacja opisująca interfejsy API REST i korzystanie z nich. Służy do tworzenia bibliotek klienta, wtyczek IDE i innych narzędzi, które współpracują z interfejsami API Google. Jedna usługa może udostępniać wiele dokumentów opisujących. Ta usługa dostarcza następujący dokument opisujący interfejs API:
Punkt końcowy usługi
Punkt końcowy usługi to podstawowy adres URL, który określa adres sieciowy usługi API. Jedna usługa może mieć wiele punktów końcowych. Ta usługa ma następujący punkt końcowy usługi i wszystkie poniższe identyfikatory URI odnoszą się do tego punktu końcowego usługi:
https://classroom.googleapis.com
Zasób REST: v1.courses
Metody | |
---|---|
create |
POST /v1/courses Utworzy kurs. |
delete |
DELETE /v1/courses/{id} Usuwa zajęcia. |
get |
GET /v1/courses/{id} Zwraca zajęcia. |
list |
GET /v1/courses Zwraca listę kursów, które może wyświetlić użytkownik wysyłający żądanie. Kurs jest ograniczony do zajęć, które spełniają wymagania. |
patch |
PATCH /v1/courses/{id} Aktualizuje co najmniej jedno pole w kursie. |
update |
PUT /v1/courses/{id} Aktualizuje kurs. |
Zasób REST: v1.courses.aliases
Metody | |
---|---|
create |
POST /v1/courses/{courseId}/aliases Tworzy alias zajęć. |
delete |
DELETE /v1/courses/{courseId}/aliases/{alias} Usuwa alias kursu. |
list |
GET /v1/courses/{courseId}/aliases Zwraca listę aliasów kursów. |
Zasób REST: v1.courses.announcements
Metody | |
---|---|
create |
POST /v1/courses/{courseId}/announcements Otworzy ogłoszenie. |
delete |
DELETE /v1/courses/{courseId}/announcements/{id} Usuwa ogłoszenie. |
get |
GET /v1/courses/{courseId}/announcements/{id} Zwraca ogłoszenie. |
list |
GET /v1/courses/{courseId}/announcements Zwraca listę ogłoszeń, które może wyświetlić osoba wnioskująca. |
modifyAssignees |
POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees Zmienia tryb osoby przypisanej i opcje ogłoszeń. |
patch |
PATCH /v1/courses/{courseId}/announcements/{id} Aktualizuje co najmniej jedno pole ogłoszenia. |
Zasób REST: v1.courses.courseWork
Metody | |
---|---|
create |
POST /v1/courses/{courseId}/courseWork Utworzy zadanie. |
delete |
DELETE /v1/courses/{courseId}/courseWork/{id} Usuwa zadanie. |
get |
GET /v1/courses/{courseId}/courseWork/{id} Zwraca zadania. |
list |
GET /v1/courses/{courseId}/courseWork Zwraca listę zadań, które osoba zgłaszająca może wyświetlić. |
modifyAssignees |
POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees Zmienia tryb osoby przypisanej i opcje opcji zadania. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{id} Aktualizuje co najmniej jedno pole zadania. |
Zasób REST: v1.courses.courseWork.studentSubmissions
Metody | |
---|---|
get |
GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id} Zwraca projekt ucznia. |
list |
GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions Zwraca listę przesłanych przez ucznia treści, które osoba zgłaszająca może wyświetlić, z uwzględnieniem zakresów protokołu OAuth tego żądania. |
modifyAttachments |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments Modyfikuje załączniki przesłane przez uczniów. |
patch |
PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id} Aktualizuje co najmniej jedno pole przesłane przez ucznia. |
reclaim |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim Odzyska zadanie przesłane przez ucznia, w imieniu jego właściciela. |
return |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return Zwraca projekt ucznia. |
turnIn |
POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn Oddaje zadanie przesłane przez ucznia. |
Zasób REST: v1.courses.courseWorkMaterials
Metody | |
---|---|
create |
POST /v1/courses/{courseId}/courseWorkMaterials Utworzy materiał do kursu. |
delete |
DELETE /v1/courses/{courseId}/courseWorkMaterials/{id} Usuwa materiały do kursu. |
get |
GET /v1/courses/{courseId}/courseWorkMaterials/{id} Zwraca wyniki zadania. |
list |
GET /v1/courses/{courseId}/courseWorkMaterials Zwraca listę zadań, które osoba zgłaszająca może wyświetlić. |
patch |
PATCH /v1/courses/{courseId}/courseWorkMaterials/{id} Aktualizuje co najmniej jedno pole w materiałach służbowych na kursie. |
Zasób REST: v1.courses.students
Metody | |
---|---|
create |
POST /v1/courses/{courseId}/students Dodaje użytkownika jako ucznia danego kursu. |
delete |
DELETE /v1/courses/{courseId}/students/{userId} Usuwa ucznia ucznia. |
get |
GET /v1/courses/{courseId}/students/{userId} Zwraca ucznia ucznia. |
list |
GET /v1/courses/{courseId}/students Zwraca listę uczniów biorących udział w tym kursie, którzy mogą wyświetlać tę osobę. |
Zasób REST: v1.courses.teachers
Metody | |
---|---|
create |
POST /v1/courses/{courseId}/teachers Utworzy nauczyciel zajęć. |
delete |
DELETE /v1/courses/{courseId}/teachers/{userId} Usuwa określonego nauczyciela z zajęć. |
get |
GET /v1/courses/{courseId}/teachers/{userId} Zwraca nauczyciel zajęć. |
list |
GET /v1/courses/{courseId}/teachers Zwraca listę nauczycieli danego kursu, które mogą zobaczyć osoby wysyłające prośbę. |
Zasób REST: v1.courses.topics
Metody | |
---|---|
create |
POST /v1/courses/{courseId}/topics Utworzy temat. |
delete |
DELETE /v1/courses/{courseId}/topics/{id} Usuwa temat. |
get |
GET /v1/courses/{courseId}/topics/{id} Zwraca temat. |
list |
GET /v1/courses/{courseId}/topics Zwraca listę tematów, które może wyświetlać osoba wnioskująca. |
patch |
PATCH /v1/courses/{courseId}/topics/{id} Aktualizuje co najmniej jedno pole w temacie. |
Zasób REST: v1.invitations
Metody | |
---|---|
accept |
POST /v1/invitations/{id}:accept Przyjmuje zaproszenie, usuwa je i dodaje zaproszonego do nauczycieli lub uczniów (w stosownych przypadkach) do danego kursu. |
create |
POST /v1/invitations tworzy zaproszenie. |
delete |
DELETE /v1/invitations/{id} Usuwa zaproszenie. |
get |
GET /v1/invitations/{id} Zwraca zaproszenie. |
list |
GET /v1/invitations Zwraca listę zaproszeń, które użytkownik może wyświetlić. Liczba ta jest ograniczona do osób, które spełniają warunki listy. |
Zasób REST: v1.registrations
Metody | |
---|---|
create |
POST /v1/registrations Utworzy Registration , przez co Classroom zacznie wysyłać powiadomienia z podanego feed do miejsca docelowego podanego w cloudPubSubTopic . |
delete |
DELETE /v1/registrations/{registrationId} Usuwa Registration , przez co Classroom przestaje wysyłać powiadomienia Registration . |
Zasób REST: v1.userProfiles
Metody | |
---|---|
get |
GET /v1/userProfiles/{userId} Zwraca profil użytkownika. |
Zasób REST: v1.userProfiles.guardianInvitations
Metody | |
---|---|
create |
POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations Utworzy zaproszenie dla opiekuna i wyśle do opiekuna e-maila z prośbą o potwierdzenie, że jest opiekunem ucznia. |
get |
GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId} Zwraca konkretne zaproszenie opiekuna. |
list |
GET /v1/userProfiles/{studentId}/guardianInvitations Zwraca listę zaproszeń do opiekuna, które może wyświetlić użytkownik filtrujący według podanych parametrów. |
patch |
PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId} Modyfikuje zaproszenie opiekuna. |
Zasób REST: v1.userProfiles.guardians
Metody | |
---|---|
delete |
DELETE /v1/userProfiles/{studentId}/guardians/{guardianId} Usuwanie opiekuna. |
get |
GET /v1/userProfiles/{studentId}/guardians/{guardianId} zwraca konkretnego opiekuna. |
list |
GET /v1/userProfiles/{studentId}/guardians Zwraca listę opiekunów, których mogą zobaczyć prośby użytkownika. |