Google Classroom API

Zarządza zajęciami, listami uczniów i zaproszeniami w Google Classroom.

Usługa: classroom.googleapis.com

Aby wywołać tę usługę, zalecamy użycie dostarczonych przez Google bibliotek klienta. Jeśli do wywoływania tej usługi aplikacja musi używać własnych bibliotek, podczas wysyłania żądań do interfejsu API stosuj się do poniższych informacji.

Dokument opisujący

Dokument opisujący to czytelna dla komputerów 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ółdziałają 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 interfejsu API. Jedna usługa może mieć wiele punktów końcowych. Ta usługa ma następujący punkt końcowy, a wszystkie poniższe identyfikatory URI odnoszą się do tego punktu końcowego:

  • https://classroom.googleapis.com

Zasób REST: v1.courses

Metody
checkAddOnCreationEligibility GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Wskazuje, czy użytkownik może tworzyć załączniki dodatków w ramach danego kursu.
create POST /v1/courses
Tworzy zajęcia.
delete DELETE /v1/courses/{id}
Usuwa zajęcia.
get GET /v1/courses/{id}
Zwraca kurs.
list GET /v1/courses
Zwraca listę zajęć, które może wyświetlać użytkownik wysyłający prośbę. Obowiązuje ograniczenie do tych zajęć, które są zgodne z żądaniem.
patch PATCH /v1/courses/{id}
Aktualizuje co najmniej 1 pole w zajęciach.
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 zajęć.
list GET /v1/courses/{courseId}/aliases
Zwraca listę aliasów kursu.

Zasób REST: v1.courses.announcements

Metody
create POST /v1/courses/{courseId}/announcements
Tworzy ogłoszenie.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Usuwa ogłoszenie.
get GET /v1/courses/{courseId}/announcements/{id}
Zwraca ogłoszenie.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Pobiera metadane dotyczące dodatków do Classroom w kontekście konkretnego posta.
list GET /v1/courses/{courseId}/announcements
Zwraca listę ogłoszeń, które osoba zgłaszająca może wyświetlać.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Modyfikuje tryb przypisywania osób i opcje ogłoszenia.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Aktualizuje co najmniej jedno pole ogłoszenia.

Zasób REST: v1.courses.announcements.addOnAttachments

Metody
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Tworzy załącznik dodatku pod postem.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Usuwa załącznik dodatku.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Zwraca załącznik dodatku.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Zwraca wszystkie załączniki utworzone przez dodatek pod postem.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Aktualizuje załącznik dodatku.

Zasób REST: v1.courses.courseWork

Metody
create POST /v1/courses/{courseId}/courseWork
Tworzy zadanie zajęć.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Usuwa zadanie.
get GET /v1/courses/{courseId}/courseWork/{id}
Zwraca zadania.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Pobiera metadane dotyczące dodatków do Classroom w kontekście konkretnego posta.
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
Modyfikuje tryb przypisywania uczestników i opcje zadania.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Aktualizuje jedno lub więcej pól zadania.

Zasób REST: v1.courses.courseWork.addOnAttachments

Metody
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Tworzy załącznik dodatku pod postem.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Usuwa załącznik dodatku.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Zwraca załącznik dodatku.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Zwraca wszystkie załączniki utworzone przez dodatek pod postem.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Aktualizuje załącznik dodatku.

Zasób REST: v1.courses.courseWork.addOnAttachments.studentSubmissions

Metody
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Zwraca zadanie przesłane przez ucznia jako załącznik dodatku.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Aktualizuje dane powiązane z przesłanym załącznikiem dodatku.

Zasób REST: v1.courses.courseWork.rubrics

Metody
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Tworzy ocenę cząstkową.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Usuwa ocenę cząstkową.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Zwraca ocenę cząstkową.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Zwraca listę ocen cząstkowych, które osoba zgłaszająca może wyświetlić.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Aktualizuje ocenę cząstkową.

Zasób REST: v1.courses.courseWork.studentSubmissions

Metody
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Zwraca zadanie przesłane przez ucznia.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Zwraca listę zadań przesłanych przez uczniów, które osoba zgłaszająca może przeglądać, z uwzględnieniem zakresów OAuth żą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 w zgłoszeniu ucznia.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Odzyskuje zadanie przesłane przez ucznia w imieniu ucznia, który jest właścicielem.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Zwraca zadanie przesłane przez 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
Tworzy materiał roboczy do kursu.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Usuwa materiał do zadania.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Zwraca materiał do zadania.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Pobiera metadane dotyczące dodatków do Classroom w kontekście konkretnego posta.
list GET /v1/courses/{courseId}/courseWorkMaterials
Zwraca listę materiałów do nauki, które osoba zgłaszająca może przeglądać.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Aktualizuje jedno lub więcej pól w materiałach szkoleniowych.

Zasób REST: v1.courses.courseWorkMaterials.addOnAttachments

Metody
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Tworzy załącznik dodatku pod postem.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Usuwa załącznik dodatku.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Zwraca załącznik dodatku.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Zwraca wszystkie załączniki utworzone przez dodatek pod postem.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Aktualizuje załącznik dodatku.

Zasób REST: v1.courses.posts

Metody
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Pobiera metadane dotyczące dodatków do Classroom w kontekście konkretnego posta.

Zasób REST: v1.courses.posts.addOnAttachments

Metody
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Tworzy załącznik dodatku pod postem.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Usuwa załącznik dodatku.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Zwraca załącznik dodatku.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Zwraca wszystkie załączniki utworzone przez dodatek pod postem.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Aktualizuje załącznik dodatku.

Zasób REST: v1.courses.posts.addOnAttachments.studentSubmissions

Metody
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Zwraca zadanie przesłane przez ucznia jako załącznik dodatku.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Aktualizuje dane powiązane z przesłanym załącznikiem dodatku.

Zasób REST: v1.courses.students

Metody
create POST /v1/courses/{courseId}/students
Dodaje użytkownika jako ucznia na zajęciach.
delete DELETE /v1/courses/{courseId}/students/{userId}
Usuwa ucznia z zajęć.
get GET /v1/courses/{courseId}/students/{userId}
Zwraca ucznia biorącego udział w zajęciach.
list GET /v1/courses/{courseId}/students
Zwraca listę uczniów tego kursu, którzy mogą ją wyświetlać.

Zasób REST: v1.courses.teachers

Metody
create POST /v1/courses/{courseId}/teachers
Tworzy nauczyciela zajęć.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Usuwa wskazanego nauczyciela z wybranego zajęć.
get GET /v1/courses/{courseId}/teachers/{userId}
Zwraca nauczyciela zajęć.
list GET /v1/courses/{courseId}/teachers
Zwraca listę nauczycieli zajęć, którzy mogą wyświetlać prośbę.

Zasób REST: v1.courses.topics

Metody
create POST /v1/courses/{courseId}/topics
Tworzy 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 osoba zgłaszająca może wyświetlać.
patch PATCH /v1/courses/{courseId}/topics/{id}
Aktualizuje jedno lub więcej pól tematu.

Zasób REST: v1.invitations

Metody
accept POST /v1/invitations/{id}:accept
akceptuje zaproszenie i usuwa je i dodaje (stosownie do potrzeb) zaproszonych użytkowników do nauczycieli lub uczniów na danych zajęciach.
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 może wyświetlać użytkownik wysyłający żądanie, ograniczony do tych pasujących do żądania listy.

Zasób REST: v1.registrations

Metody
create POST /v1/registrations
Tworzy Registration, dzięki czemu Classroom zaczyna wysyłać powiadomienia z podanego adresu feed do miejsca docelowego podanego w cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
Usuwa Registration, przez co Classroom przestaje wysyłać powiadomienia dotyczące tego zasobu (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
Tworzy zaproszenie do opiekuna i wysyła do niego e-maila z prośbą o potwierdzenie, że jest opiekunem ucznia.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Zwraca określone zaproszenie do opiekuna.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Zwraca listę zaproszeń opiekunów, które może wyświetlać użytkownik wysyłający prośbę, przefiltrowaną 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}
Usuwa opiekuna.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Zwraca konkretnego opiekuna.
list GET /v1/userProfiles/{studentId}/guardians
Zwraca listę opiekunów, którą użytkownik wysyłający prośbę może wyświetlić. Zwracana jest tylko lista opiekunów prawnych pasujących do żądania.