Google Classroom API

Umożliwia zarządzanie zajęciami, listami uczniów i zaproszeniami w Google Classroom.

Usługa: classroom.googleapis.com

Zalecamy wywołanie tej usługi przy użyciu dostarczonych przez Google bibliotek klienta. Jeśli aplikacja musi wywoływać tę usługę przy użyciu własnych bibliotek, podczas tworzenia żądań interfejsu API należy używać poniższych informacji.

Dokument opisujący

Dokument opisujący to czytelna dla komputera specyfikacja opisująca interfejsy API REST i sposób ich używania. 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 i wszystkie poniższe identyfikatory URI odnoszą się do niego:

  • https://classroom.googleapis.com

Zasób REST: v1.courses

Metody
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Zwraca informację, czy użytkownik może tworzyć załączniki dodatków w danym kursie.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Zwraca informację, czy użytkownik może aktualizować ustawienia okresu oceniania na danych zajęciach.
create POST /v1/courses
Tworzy kurs.
delete DELETE /v1/courses/{id}
Usuwa zajęcia.
get GET /v1/courses/{id}
Zwraca kurs.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
Zwraca ustawienia okresu oceniania na zajęciach.
list GET /v1/courses
Zwraca listę kursów, które użytkownik wysyłający żądanie może wyświetlić, ograniczoną do tych, które pasują do żądania.
patch PATCH /v1/courses/{id}
Aktualizuje co najmniej jedno pole w kursie.
update PUT /v1/courses/{id}
Aktualizuje kurs.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
Aktualizuje ustawienia okresu oceniania w kursie.

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 dodatków do Classroom w kontekście konkretnego posta.
list GET /v1/courses/{courseId}/announcements
Zwraca listę ogłoszeń, które osoba wysyłająca żądanie może wyświetlić.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Zmienia tryb przypisania 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 w poście.
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 w poście.
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.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Usuwa projekt.
get GET /v1/courses/{courseId}/courseWork/{id}
Zwraca zadanie.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Pobiera metadane dodatków do Classroom w kontekście konkretnego posta.
list GET /v1/courses/{courseId}/courseWork
Zwraca listę prac domowych, które osoba wysyłająca żądanie może wyświetlić.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Modyfikuje tryb przypisywania i opcje zajęć.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Aktualizuje co najmniej jedno pole projektu.

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

Metody
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Tworzy załącznik dodatku w poście.
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 w poście.
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 w przypadku załącznika dodatku.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Aktualizuje dane powiązane z zadaniem z załącznika 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ę rubryk, które osoba wysyłająca prośbę 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 projekt ucznia.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Zwraca listę zadań odesłanych przez uczniów, które osoba wysyłająca żądanie może wyświetlić, z uwzględnieniem zakresów OAuth żądania.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Modyfikuje załączniki zadania przesłanego przez ucznia.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Aktualizuje co najmniej jedno pole przesłanego przez ucznia projektu.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Odzyskuje przesłaną pracę ucznia w imieniu ucznia, do którego należy.
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
Tworzy materiał do zadania.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Usuwa materiał do zajęć.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Zwraca materiał do zajęć.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Pobiera metadane dodatków do Classroom w kontekście konkretnego posta.
list GET /v1/courses/{courseId}/courseWorkMaterials
Zwraca listę materiałów do zajęć, które osoba wysyłająca prośbę może wyświetlić.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Aktualizuje co najmniej jedno pole materiału do zajęć.

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

Metody
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Tworzy załącznik dodatku w poście.
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 w poście.
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 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 w poście.
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 w poście.
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 w przypadku załącznika dodatku.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Aktualizuje dane powiązane z zadaniem z załącznika dodatku.

Zasób REST: v1.courses.studentGroups

Metody
create POST /v1/courses/{courseId}/studentGroups
Tworzy grupę uczniów na potrzeby kursu.
delete DELETE /v1/courses/{courseId}/studentGroups/{id}
Usuwa grupę uczniów.
list GET /v1/courses/{courseId}/studentGroups
Zwraca listę grup na kursie.
patch PATCH /v1/courses/{courseId}/studentGroups/{id}
Aktualizuje co najmniej 1 pole w grupie uczniów.

Zasób REST: v1.courses.studentGroups.studentGroupMembers

Metody
create POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Tworzy członka grupy uczniów w grupie uczniów.
delete DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
Usuwa członka grupy uczniów.
list GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Zwraca listę uczniów w grupie.

Zasób REST: v1.courses.students

Metody
create POST /v1/courses/{courseId}/students
Dodaje użytkownika jako ucznia zajęć.
delete DELETE /v1/courses/{courseId}/students/{userId}
Usuwa ucznia z zajęć.
get GET /v1/courses/{courseId}/students/{userId}
Zwraca ucznia zajęć.
list GET /v1/courses/{courseId}/students
Zwraca listę uczniów tego kursu, których może wyświetlić osoba wysyłająca żądanie.

Zasób REST: v1.courses.teachers

Metody
create POST /v1/courses/{courseId}/teachers
Tworzy nauczyciela kursu.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Usuwa określonego nauczyciela z określonego kursu.
get GET /v1/courses/{courseId}/teachers/{userId}
Zwraca nauczyciela zajęć.
list GET /v1/courses/{courseId}/teachers
Zwraca listę nauczycieli prowadzących te zajęcia, których może wyświetlić osoba wysyłająca żądanie.

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 użytkownik może wyświetlać.
patch PATCH /v1/courses/{courseId}/topics/{id}
Aktualizuje co najmniej jedno pole tematu.

Zasób REST: v1.invitations

Metody
accept POST /v1/invitations/{id}:accept
Akceptuje zaproszenie, usuwa je i dodaje zaproszonego użytkownika do nauczycieli lub uczniów (w zależności od przypadku) określonego 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 wysyłający żądanie może wyświetlić, ograniczoną do zaproszeń pasujących do żądania listy.

Zasób REST: v1.registrations

Metody
create POST /v1/registrations
Tworzy Registration, co powoduje, że Classroom zaczyna wysyłać powiadomienia z podanego adresu feed do miejsca docelowego podanego w cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
Usuwa Registration, co powoduje, że Classroom przestaje wysyłać powiadomienia dotyczące tego Registration.

Zasób REST: v1.userProfiles

Metody
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
Zwraca informację, czy użytkownik może korzystać z określonej funkcji Classroom.
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 dla 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 konkretne zaproszenie dla opiekuna.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Zwraca listę zaproszeń dla opiekunów, które użytkownik wysyłający żądanie może wyświetlić, 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órych może wyświetlić użytkownik wysyłający żądanie. Lista jest ograniczona do opiekunów pasujących do żądania.