Google Classroom API

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

• Ресурс REST: v1.courses
• Ресурс REST: v1.courses.aliases
• Ресурс REST: v1.courses.announcements.
• Ресурс REST: v1.courses.announcements.addOnAttachments.
• Ресурс REST: v1.courses.courseWork
• Ресурс REST: v1.courses.courseWork.addOnAttachments.
• Ресурс REST: v1.courses.courseWork.addOnAttachments.studentSubmissions
• Ресурс REST: v1.courses.courseWork.rubrics.
• Ресурс REST: v1.courses.courseWork.studentSubmissions
• Ресурс REST: v1.courses.courseWorkMaterials.
• Ресурс REST: v1.courses.courseWorkMaterials.addOnAttachments.
• Ресурс REST: v1.courses.posts
• Ресурс REST: v1.courses.posts.addOnAttachments
• Ресурс REST: v1.courses.posts.addOnAttachments.studentSubmissions
• Ресурс REST: v1.courses.students.
• Ресурс REST: v1.courses.teachers
• Ресурс REST: v1.courses.topics
• Ресурс REST: v1.invitations
• Ресурс REST: v1.registrations
• Ресурс REST: v1.userProfiles
• Ресурс REST: v1.userProfiles.guardianInvitations.
• Ресурс REST: v1.userProfiles.guardians

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

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

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

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

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

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

Конечная точка службы — это базовый URL-адрес, указывающий сетевой адрес службы API. Одна служба может иметь несколько конечных точек службы. Эта служба имеет следующую конечную точку службы, и все приведенные ниже URI относятся к этой конечной точке службы:

• https://classroom.googleapis.com

Ресурс REST: v1.courses

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

Ресурс 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 Получает метаданные для надстроек Класса в контексте определенного сообщения.
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 Получает метаданные для надстроек Класса в контексте определенного сообщения.
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 Предварительная версия для разработчиков: доступна в рамках программы Google Workspace Developer Preview Program , которая предоставляет ранний доступ к определенным функциям. Эта функция доступна в V1_20231110_PREVIEW и более поздних версиях. Дополнительные сведения см. в разделе API Access Preview . Создает рубрику.
delete	DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} Предварительная версия для разработчиков: доступна в рамках программы Google Workspace Developer Preview Program , которая предоставляет ранний доступ к определенным функциям. Эта функция доступна в V1_20231110_PREVIEW и более поздних версиях. Дополнительные сведения см. в разделе API Access Preview . Удаляет рубрику.
get	GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} Предварительная версия для разработчиков: доступна в рамках программы Google Workspace Developer Preview Program , которая предоставляет ранний доступ к определенным функциям. Эта функция доступна в V1_20231110_PREVIEW и более поздних версиях. Дополнительные сведения см. в разделе API Access Preview . Возвращает рубрику.
list	GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics Предварительная версия для разработчиков: доступна в рамках программы Google Workspace Developer Preview Program , которая предоставляет ранний доступ к определенным функциям. Эта функция доступна в V1_20231110_PREVIEW и более поздних версиях. Дополнительные сведения см. в разделе API Access Preview . Возвращает список рубрик, которые запрашивающему разрешено просматривать.
patch	PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id} Предварительная версия для разработчиков: доступна в рамках программы Google Workspace Developer Preview Program , которая предоставляет ранний доступ к определенным функциям. Эта функция доступна в V1_20231110_PREVIEW и более поздних версиях. Дополнительные сведения см. в разделе API Access Preview . Обновляет рубрику.

Ресурс 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 Получает метаданные для надстроек Класса в контексте определенного сообщения.
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 Получает метаданные для надстроек Класса в контексте определенного сообщения.

Ресурс 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.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 , в результате чего Класс перестает отправлять уведомления об этой Registration .

Ресурс REST: v1.userProfiles

Методы
checkUserCapability	GET /v1/userProfiles/{userId}:checkUserCapability Предварительная версия для разработчиков: доступна в рамках программы Google Workspace Developer Preview Program , которая предоставляет ранний доступ к определенным функциям. Эта функция доступна в V1_20240930_PREVIEW и более поздних версиях. Дополнительные сведения см. в разделе API Access Preview . Возвращает, может ли пользователь использовать указанную возможность Класса.
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 Возвращает список опекунов, которых разрешено просматривать запрашивающему пользователю, ограниченный теми, которые соответствуют запросу.