Google Classroom API

Управляет курсами, списками учащихся и приглашениями в Google Классе.

Сервис: classroom.googleapis.com

Для вызова этого сервиса рекомендуем использовать клиентские библиотеки от Google. Если для вашего приложения требуется использование собственных библиотек для вызова сервиса, при выполнении запросов к API используйте следующую информацию.

Документ discovery

Документ Discovery – это машиночитаемая спецификация, которая позволяет описывать и использовать интерфейсы REST API. Он используется для построения клиентских библиотек, подключаемых модулей интегрированной среды разработки и других инструментов, которые взаимодействуют с API Google. Один сервис может предоставлять несколько discovery-документов. Этот сервис предоставляет следующий документ Discovery:

Конечная точка сервиса

Конечная точка сервиса – это базовый URL, который указывает на IP-адрес сервиса API. У одного сервиса может быть несколько конечных точек. Конечная точка этого сервиса указана ниже. К ней относятся все URI, которые также перечислены ниже.

  • https://classroom.googleapis.com

Ресурс REST: v1.courses

Методы
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Возвращает информацию о том, может ли пользователь создавать прикрепленные дополнения в определенном курсе.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Возвращает информацию о том, может ли пользователь обновлять GradingPeriodSettings на определенном курсе.
create POST /v1/courses
Создает курс.
delete DELETE /v1/courses/{id}
Удаляет курс.
get GET /v1/courses/{id}
Возвращает курс.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
Возвращает настройки академического периода в курсе.
list GET /v1/courses
Возвращает список курсов, которые пользователь может просматривать, ограниченный теми, которые соответствуют запросу.
patch PATCH /v1/courses/{id}
Обновляет одно или несколько полей в курсе.
update PUT /v1/courses/{id}
Обновляет курс.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
Обновляет настройки академического периода курса.

Ресурс REST: v1.courses.aliases

Методы
create POST /v1/courses/{courseId}/aliases
Создает псевдоним для курса.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Удаляет псевдоним курса.
list GET /v1/courses/{courseId}/aliases
Возвращает список псевдонимов курса.

Ресурс REST: v1.courses.announcements

Методы
create POST /v1/courses/{courseId}/announcements
Создает объявление.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Удаляет объявление.
get GET /v1/courses/{courseId}/announcements/{id}
Возвращает объявление.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Позволяет получить метаданные дополнений Google Класса в контексте определенной записи.
list GET /v1/courses/{courseId}/announcements
Возвращает список объявлений, которые разрешено просматривать отправителю запроса.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Изменяет режим назначения и параметры объявления.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Обновляет одно или несколько полей объявления.

Ресурс REST: v1.courses.announcements.addOnAttachments

Методы
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Создает прикрепленный файл дополнения в записи.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Удаляет прикрепленный файл дополнения.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Возвращает прикрепленное дополнение.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Возвращает все прикрепленные файлы, созданные дополнением в записи.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Обновляет прикрепленный файл дополнения.

Ресурс REST: v1.courses.courseWork

Методы
create POST /v1/courses/{courseId}/courseWork
Создает задания.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Удаляет задание.
get GET /v1/courses/{courseId}/courseWork/{id}
Возвращает задание курса.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Позволяет получить метаданные дополнений Google Класса в контексте определенной записи.
list GET /v1/courses/{courseId}/courseWork
Возвращает список заданий, которые разрешено просматривать отправителю запроса.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Изменяет режим и параметры назначения задания.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Обновляет одно или несколько полей задания.

Ресурс REST: v1.courses.courseWork.addOnAttachments

Методы
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Создает прикрепленный файл дополнения в записи.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Удаляет прикрепленный файл дополнения.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Возвращает прикрепленное дополнение.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Возвращает все прикрепленные файлы, созданные дополнением в записи.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Обновляет прикрепленный файл дополнения.

Ресурс REST: v1.courses.courseWork.addOnAttachments.studentSubmissions

Методы
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Возвращает работу учащегося для прикрепленного дополнения.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions
Возвращает список работ учащихся, которые отправитель запроса может просматривать.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Обновляет данные, связанные с прикрепленным файлом, опубликованным дополнением.

Ресурс REST: v1.courses.courseWork.rubrics

Методы
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Создает критерий оценки.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Удаляет критерий оценки.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Возвращает критерий оценки.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Возвращает список критериев оценки, которые разрешено просматривать отправителю запроса.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Обновляет критерий оценки.

Ресурс REST: v1.courses.courseWork.studentSubmissions

Методы
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Возвращает работу учащегося.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Возвращает список работ учащихся, которые отправитель запроса может просматривать с учетом областей действия OAuth.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Изменение прикрепленных файлов в работах учащихся.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Обновляет одно или несколько полей в работе учащегося.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Отменяет сдачу работы от имени учащегося, которому она принадлежит.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Возвращает работу учащегося.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Сдает работу учащегося.

Ресурс REST: v1.courses.courseWorkMaterials

Методы
create POST /v1/courses/{courseId}/courseWorkMaterials
Создает материал для задания.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Удаляет материал задания.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Возвращает материал задания.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Позволяет получить метаданные дополнений Google Класса в контексте определенной записи.
list GET /v1/courses/{courseId}/courseWorkMaterials
Возвращает список материалов курса, которые разрешено просматривать отправителю запроса.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Обновляет одно или несколько полей материала задания.

Ресурс REST: v1.courses.courseWorkMaterials.addOnAttachments

Методы
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Создает прикрепленный файл дополнения в записи.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Удаляет прикрепленный файл дополнения.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Возвращает прикрепленное дополнение.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Возвращает все прикрепленные файлы, созданные дополнением в записи.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Обновляет прикрепленный файл дополнения.

Ресурс REST: v1.courses.posts

Методы
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Позволяет получить метаданные дополнений Google Класса в контексте определенной записи.

Ресурс REST: v1.courses.posts.addOnAttachments

Методы
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Создает прикрепленный файл дополнения в записи.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Удаляет прикрепленный файл дополнения.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Возвращает прикрепленное дополнение.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Возвращает все прикрепленные файлы, созданные дополнением в записи.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Обновляет прикрепленный файл дополнения.

Ресурс REST: v1.courses.posts.addOnAttachments.studentSubmissions

Методы
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Возвращает работу учащегося для прикрепленного дополнения.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Обновляет данные, связанные с прикрепленным файлом, опубликованным дополнением.

Ресурс REST: v1.courses.studentGroups

Методы
create POST /v1/courses/{courseId}/studentGroups
Создает группу учащихся для курса.
delete DELETE /v1/courses/{courseId}/studentGroups/{id}
Удаляет группу учащихся.
list GET /v1/courses/{courseId}/studentGroups
Возвращает список групп в курсе.
patch PATCH /v1/courses/{courseId}/studentGroups/{id}
Обновляет одно или несколько полей в группе учащихся.

Ресурс REST: v1.courses.studentGroups.studentGroupMembers

Методы
create POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Добавляет учащегося в группу.
delete DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
Удаляет участника группы учащихся.
list GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Возвращает список учащихся в группе.

Ресурс REST: v1.courses.students

Методы
create POST /v1/courses/{courseId}/students
Добавляет пользователя в качестве учащегося курса.
delete DELETE /v1/courses/{courseId}/students/{userId}
Удаляет учащегося с курса.
get GET /v1/courses/{courseId}/students/{userId}
Возвращает учащегося курса.
list GET /v1/courses/{courseId}/students
Возвращает список учащихся курса, которых отправитель запроса может просматривать.

Ресурс REST: v1.courses.teachers

Методы
create POST /v1/courses/{courseId}/teachers
Добавляет преподавателя курса.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Удаляет указанного преподавателя из указанного курса.
get GET /v1/courses/{courseId}/teachers/{userId}
Возвращает преподавателя курса.
list GET /v1/courses/{courseId}/teachers
Возвращает список преподавателей курса, которых отправитель запроса может просматривать.

Ресурс REST: v1.courses.topics

Методы
create POST /v1/courses/{courseId}/topics
Создает тему.
delete DELETE /v1/courses/{courseId}/topics/{id}
Удаляет тему.
get GET /v1/courses/{courseId}/topics/{id}
Возвращает тему.
list GET /v1/courses/{courseId}/topics
Возвращает список тем, которые разрешено просматривать пользователю, отправившему запрос.
patch PATCH /v1/courses/{courseId}/topics/{id}
Обновляет одно или несколько полей темы.

Ресурс REST: v1.invitations

Методы
accept POST /v1/invitations/{id}:accept
Принимает приглашение, удаляя его и добавляя приглашенного пользователя в список преподавателей или учащихся (в зависимости от роли) указанного курса.
create POST /v1/invitations
Создает приглашение.
delete DELETE /v1/invitations/{id}
Удаляет приглашение.
get GET /v1/invitations/{id}
Возвращает приглашение.
list GET /v1/invitations
Возвращает список приглашений, которые запрашивающий пользователь может просматривать, ограниченный теми, которые соответствуют запросу списка.

Ресурс REST: v1.registrations

Методы
create POST /v1/registrations
Создает Registration, в результате чего Класс начинает отправлять уведомления из указанного feed в место назначения, указанное в cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
Удаляет Registration, в результате чего Класс перестает отправлять уведомления для этого Registration.

Ресурс REST: v1.userProfiles

Методы
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
Возвращает информацию о том, может ли пользователь использовать указанную функцию Класса.
get GET /v1/userProfiles/{userId}
Возвращает профиль пользователя.

Ресурс REST: v1.userProfiles.guardianInvitations

Методы
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Создает приглашение для законного представителя и отправляет ему электронное письмо с просьбой подтвердить, что он является законным представителем учащегося.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Возвращает определенное приглашение законного представителя.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Возвращает список приглашений законных представителей, которые пользователь, отправивший запрос, может просматривать. Список отфильтрован по указанным параметрам.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Изменяет приглашение законного представителя.

Ресурс REST: v1.userProfiles.guardians

Методы
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
Удаляет законного представителя.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Возвращает данные определенного законного представителя.
list GET /v1/userProfiles/{studentId}/guardians
Возвращает список законных представителей, которых пользователь, отправивший запрос, может просматривать. Список ограничен теми представителями, которые соответствуют запросу.