Google Classroom API

Управляет классами, расписаниями и приглашениями в Google Classroom.

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

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

Документ открытия

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

Конечная точка службы

Конечная точка сервиса — это базовый URL-адрес, который определяет сетевой адрес сервиса 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
Получает метаданные для дополнений Classroom в контексте конкретной публикации.
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
Получает метаданные для дополнений Classroom в контексте конкретной публикации.
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}
Возвращает студенческую заявку на присоединение дополнительного вложения.
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
Получает метаданные для дополнений Classroom в контексте конкретной публикации.
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
Получает метаданные для дополнений Classroom в контексте конкретной публикации.

Ресурс 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 , в результате чего Classroom начинает отправлять уведомления из предоставленного feed в пункт назначения, указанный в cloudPubSubTopic .
delete DELETE /v1/registrations/{registrationId}
Удаляет Registration , в результате чего Classroom прекращает отправку уведомлений для этой 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
Возвращает список опекунов, которых запрашивающему пользователю разрешено просматривать, ограничиваясь теми, которые соответствуют запросу.