Google Classroom API

Zarządzanie 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.announcements.addOnAttachments
• Zasób REST: v1.courses.courseWork
• Zasób REST: v1.courses.courseWork.addOnAttachments
• Zasób REST: v1.courses.courseWork.addOnAttachments.studentSubmissions
• Zasób REST: v1.courses.courseWork.rubrics
• Zasób REST: v1.courses.courseWork.studentSubmissions
• Zasób REST: v1.courses.courseWorkMaterials
• Zasób REST: v1.courses.courseWorkMaterials.addOnAttachments
• Zasób REST: v1.courses.posts
• Zasób REST: v1.courses.posts.addOnAttachments
• Zasób REST: v1.courses.posts.addOnAttachments.studentSubmissions
• 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

Do wywołania tej usługi zalecamy użycie dostarczonych przez Google bibliotek klienta. Jeśli do wywoływania tej usługi aplikacja musi używać Twoich własnych bibliotek, podczas tworzenia żądań do interfejsu API użyj podanych niżej informacji.

Dokument opisujący

Dokument opisujący to czytelna dla komputera specyfikacja opisująca interfejsy API REST i ich używanie. 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 dostarczać wiele dokumentów opisujących. Ta usługa dostarcza następujący dokument opisujący interfejs API:

• https://classroom.googleapis.com/$discovery/rest?version=v1

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 są względne wobec 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 danych zajęć.
checkGradingPeriodsSetupEligibility	GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility Wersja przedpremierowa dla programistów: opcja dostępna w ramach programu testowania wersji Google Workspace dla programistów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w V1_20240401_PREVIEW i nowszych wersjach. Więcej informacji znajdziesz w artykule Dostęp do interfejsów API podglądu. Wskazuje, czy użytkownik może aktualizować ustawienia GradingPeriodSettings w danym kursie.
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 Wersja przedpremierowa dla programistów: opcja dostępna w ramach programu testowania wersji Google Workspace dla programistów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w V1_20240401_PREVIEW i nowszych wersjach. Więcej informacji znajdziesz w artykule Dostęp do interfejsów API podglądu. Zwraca ustawienia okresu oceniania danego zajęć.
list	GET /v1/courses Zwraca listę kursów, które może wyświetlać użytkownik wysyłający prośbę, 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 szkolenie.
updateGradingPeriodSettings	PATCH /v1/courses/{courseId}/gradingPeriodSettings Wersja przedpremierowa dla programistów: opcja dostępna w ramach programu testowania wersji Google Workspace dla programistów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w V1_20240401_PREVIEW i nowszych wersjach. Więcej informacji znajdziesz w artykule Dostęp do interfejsów API podglądu. Aktualizuje ustawienia okresu oceniania zajęć.

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 szkolenia.
list	GET /v1/courses/{courseId}/aliases Zwraca listę aliasów zajęć.

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 może wyświetlić osoba wysyłająca prośbę.
modifyAssignees	POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees Modyfikuje tryb przypisanej osoby oraz 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 zadania w ramach kursu.
delete	DELETE /v1/courses/{courseId}/courseWork/{id} Usuwa zadanie w ramach szkolenia.
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ę zadań, które osoba zgłaszająca prośbę może wyświetlić.
modifyAssignees	POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees Modyfikuje tryb przypisanych osób i opcje zadania.
patch	PATCH /v1/courses/{courseId}/courseWork/{id} Aktualizuje co najmniej jedno pole 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 załącznik dodatku przesłany przez ucznia.
patch	PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId} Aktualizuje dane związane z przesłaniem załącznika dodatku.

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

Metody
create	POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics Wersja przedpremierowa dla programistów: opcja dostępna w ramach programu testowania wersji Google Workspace dla programistów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w V1_20231110_PREVIEW i nowszych wersjach. Więcej informacji znajdziesz w artykule Dostęp do interfejsów API podglądu. Tworzy ocenę cząstkową.
delete	DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} Wersja przedpremierowa dla programistów: opcja dostępna w ramach programu testowania wersji Google Workspace dla programistów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w V1_20231110_PREVIEW i nowszych wersjach. Więcej informacji znajdziesz w artykule Dostęp do interfejsów API podglądu. Usuwa ocenę cząstkową.
get	GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} Wersja przedpremierowa dla programistów: opcja dostępna w ramach programu testowania wersji Google Workspace dla programistów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w V1_20231110_PREVIEW i nowszych wersjach. Więcej informacji znajdziesz w artykule Dostęp do interfejsów API podglądu. Zwraca ocenę cząstkową.
list	GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics Wersja przedpremierowa dla programistów: opcja dostępna w ramach programu testowania wersji Google Workspace dla programistów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w V1_20231110_PREVIEW i nowszych wersjach. Więcej informacji znajdziesz w artykule Dostęp do interfejsów API podglądu. Zwraca listę ocen cząstkowych, które może wyświetlić osoba wysyłająca prośbę.
patch	PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} Wersja przedpremierowa dla programistów: opcja dostępna w ramach programu testowania wersji Google Workspace dla programistów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w V1_20231110_PREVIEW i nowszych wersjach. Więcej informacji znajdziesz w artykule Dostęp do interfejsów API podglądu. 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ń 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 ucznia.
patch	PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id} Aktualizuje co najmniej jedno pole zadania przesłanego przez ucznia.
reclaim	POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim Odzyskuje projekt przesłany przez ucznia w imieniu ucznia, do którego należy.
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ły szkoleniowe.
delete	DELETE /v1/courses/{courseId}/courseWorkMaterials/{id} Usuwa materiały związane z kursem.
get	GET /v1/courses/{courseId}/courseWorkMaterials/{id} Zwraca materiały szkoleniowe.
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 szkoleniowych, które osoba zgłaszająca prośbę może przeglądać.
patch	PATCH /v1/courses/{courseId}/courseWorkMaterials/{id} Aktualizuje co najmniej jedno pole materiału szkoleniowego.

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 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 załącznik dodatku przesłany przez ucznia.
patch	PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId} Aktualizuje dane związane z przesłaniem załącznika dodatku.

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 danego szkolenia.
list	GET /v1/courses/{courseId}/students Zwraca listę uczestników zajęć, które osoba zgłaszająca prośbę może wyświetlić.

Zasób REST: v1.courses.teachers

Metody
create	POST /v1/courses/{courseId}/teachers Tworzy nauczyciela zajęć.
delete	DELETE /v1/courses/{courseId}/teachers/{userId} Usuwa określonego nauczyciela z określonych zajęć.
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óre osoba wysyłająca prośbę może wyświetlić.

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 może wyświetlać osoba wysyłająca prośbę.
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 Przyjmuje zaproszenie, usuwa je oraz dodaje zaproszonego użytkownika do nauczycieli lub uczniów (jeśli dotyczy) określonych zajęć.
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 prośbę może wyświetlić, ograniczoną do tych, które pasują do żądania listy.

Zasób REST: v1.registrations

Metody
create	POST /v1/registrations Tworzy element Registration, przez co Classroom zaczyna wysyłać powiadomienia z podanej metody feed do miejsca docelowego podanego w cloudPubSubTopic.
delete	DELETE /v1/registrations/{registrationId} Usuwa element Registration, przez co Classroom przestanie wysyłać związane z nim 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 Tworzy zaproszenie 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 opiekuna.
list	GET /v1/userProfiles/{studentId}/guardianInvitations Zwraca listę zaproszeń opiekuna, które użytkownik wysyłający prośbę 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 określonego opiekuna.
list	GET /v1/userProfiles/{studentId}/guardians Zwraca listę opiekunów, które użytkownik wysyłający prośbę może wyświetlać, ograniczoną do tych, którzy pasują do żądania.