Dodatki do Google Classroom są teraz ogólnie dostępne dla programistów. Więcej informacji znajdziesz w dokumentacji dodatków.

Ta strona została przetłumaczona przez Cloud Translation API.

Google Classroom API

Umożliwia 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ływania 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 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:

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 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` Wersja przedpremierowa dla programistów: opcja dostępna w ramach programu testowania wersji Google Workspace dla deweloperów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w wersji `V1_20240401_PREVIEW` lub nowszej. Więcej informacji znajdziesz w artykule Dostęp do interfejsów API podglądu. Zwraca informację, czy użytkownik może zaktualizować ustawienia GradingPeriodSettings w danym kursie.
`create`	`POST /v1/courses` Tworzy kurs.
`delete`	`DELETE /v1/courses/{id}` Usuwanie zajęć.
`get`	`GET /v1/courses/{id}` Zwraca kurs.
`getGradingPeriodSettings`	`GET /v1/courses/{courseId}/gradingPeriodSettings` Podgląd dla deweloperów: dostępny w ramach programu Google Workspace Developer Preview, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w wersji `V1_20240401_PREVIEW` lub nowszej. Więcej informacji znajdziesz w artykule Interfejsy API w wersji testowej. Zwraca ustawienia okresu oceniania danego zajęć.
`list`	`GET /v1/courses` Zwraca listę kursów, które użytkownik może wyświetlić, ograniczając ją 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 zajęcia.
`updateGradingPeriodSettings`	`PATCH /v1/courses/{courseId}/gradingPeriodSettings` Podgląd dla deweloperów: dostępny w ramach programu Google Workspace Developer Preview, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w wersji `V1_20240401_PREVIEW` lub nowszej. Więcej informacji znajdziesz w artykule Dostęp do interfejsów API podglądu. 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}` Usuwanie ogłoszenia.
`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 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}` Zaktualizuje co najmniej 1 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.
`delete`	`DELETE /v1/courses/{courseId}/courseWork/{id}` Usuwanie pracy zaliczeniowej.
`get`	`GET /v1/courses/{courseId}/courseWork/{id}` Zwraca zadania z kursu.
`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ń z zajęć, które może wyświetlić osoba przesyłająca prośbę.
`modifyAssignees`	`POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees` Modyfikuje tryb i opcje przypisania kursu.
`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 przesłane przez ucznia załączniki dodatkowe.
`patch`	`PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}` Aktualizuje dane związane z przesłanym plikiem 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 deweloperów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w wersji `V1_20231110_PREVIEW` lub nowszej. 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 deweloperów, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w wersji `V1_20231110_PREVIEW` lub nowszej. Więcej informacji znajdziesz w artykule Interfejsy API w wersji testowej. usuwa ocenę cząstkową.
`get`	`GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}` Podgląd dla deweloperów: dostępny w ramach programu Google Workspace Developer Preview, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w wersji `V1_20231110_PREVIEW` lub nowszej. 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` Podgląd dla deweloperów: dostępny w ramach programu Google Workspace Developer Preview, 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 Interfejsy API w wersji testowej. Zwraca listę kryteriów, które może wyświetlić osoba przesyłająca prośbę.
`patch`	`PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}` Podgląd dla deweloperów: dostępny w ramach programu Google Workspace Developer Preview, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w wersji `V1_20231110_PREVIEW` lub nowszej. Więcej informacji znajdziesz w artykule Interfejsy API w wersji testowej. aktualizować oceny cząstkowej.

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

Metody
`get`	`GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}` Zwraca projekt przesłany przez ucznia.
`list`	`GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions` Zwraca listę prac uczniów, które można wyświetlić, uwzględniając zakresy protokołu OAuth żądania.
`modifyAttachments`	`POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments` Modyfikuje załączniki zadań przesłanych przez uczniów.
`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 projekt przesłany 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ł z pracy domowej.
`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 z kursu, które może wyświetlić osoba przesyłająca prośbę.
`patch`	`PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}` Zaktualizuj co najmniej jedno pole materiału z zadania w kursie.

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}` Usuwanie załącznika 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}` Usuwanie załącznika 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 przesłane przez ucznia załączniki dodatkowe.
`patch`	`PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}` Aktualizuje dane związane z przesłanym plikiem 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}` Usuwanie ucznia z zajęć.
`get`	`GET /v1/courses/{courseId}/students/{userId}` Zwraca ucznia na zajęciach.
`list`	`GET /v1/courses/{courseId}/students` Zwraca listę uczniów tego kursu, których dane może wyświetlić osoba przesyłająca żądanie.

Zasób REST: v1.courses.teachers

Metody
`create`	`POST /v1/courses/{courseId}/teachers` Tworzy nauczyciela zajęć.
`delete`	`DELETE /v1/courses/{courseId}/teachers/{userId}` Usuwanie nauczyciela z określonego kursu.
`get`	`GET /v1/courses/{courseId}/teachers/{userId}` Zwraca nauczyciela prowadzącego zajęcia.
`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}` Usuwanie tematu.
`get`	`GET /v1/courses/{courseId}/topics/{id}` Zwraca temat.
`list`	`GET /v1/courses/{courseId}/topics` Zwraca listę tematów, które może przeglądać 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}` Usuwanie zaproszenia.
`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 `Registration`, co powoduje, że Classroom zacznie wysyłać powiadomienia z podanego `feed` do miejsca docelowego podanego w `cloudPubSubTopic`.
`delete`	`DELETE /v1/registrations/{registrationId}` Usuwa `Registration`, co powoduje, że Classroom przestanie wysyłać powiadomienia dotyczące tego `Registration`.

Zasób REST: v1.userProfiles

Metody

Metody
`checkUserCapability`	`GET /v1/userProfiles/{userId}:checkUserCapability` Podgląd dla deweloperów: dostępny w ramach programu Google Workspace Developer Preview, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w `V1_20240930_PREVIEW` i nowszych wersjach. Więcej informacji znajdziesz w artykule Interfejsy API w wersji testowej. Zwraca informację, czy użytkownik może korzystać z określonej funkcji Classroom.
`get`	`GET /v1/userProfiles/{userId}` Zwraca profil użytkownika.

checkUserCapability

GET /v1/userProfiles/{userId}:checkUserCapability

Podgląd dla deweloperów: dostępny w ramach programu Google Workspace Developer Preview, który zapewnia wcześniejszy dostęp do niektórych funkcji. Ta funkcja jest dostępna w V1_20240930_PREVIEW i nowszych wersjach. Więcej informacji znajdziesz w artykule Interfejsy API w wersji testowej.

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 on opiekunem ucznia.
`get`	`GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}` Zwraca zaproszenie do opiekuna.
`list`	`GET /v1/userProfiles/{studentId}/guardianInvitations` Zwraca listę zaproszeń dla opiekuna, które użytkownik może wyświetlić, posortowaną 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 określonego opiekuna.
`list`	`GET /v1/userProfiles/{studentId}/guardians` Zwraca listę opiekunów, których dane użytkownik może wyświetlić, ograniczoną do tych, które pasują do żądania.