Разработчики могут использовать API Google Classroom для взаимодействия с курсовыми работами в Google Classroom. Приложение, использующее API таким образом, называется интеграцией CourseWork
.
Этот путь интеграции обычно используется для создания и оценки заданий со ссылками на ресурсы за пределами Класса. Он предоставляет разработчикам больше доступа к управлению курсовыми работами по сравнению с кнопками «Поделиться в классе» .
Как это работает
Основная особенность интеграции CourseWork
— создание заданий, объявлений и материалов курса и управление ими с помощью Classroom API.
Одним из примеров обычного пути пользователя, который становится возможным благодаря интеграции CourseWork
является предоставление преподавателям возможности находить, назначать и оценивать контент на вашем веб-сайте или в приложении:
- Пользователь-учитель входит на ваш сайт.
- Учитель находит или создает контент, которым хочет поделиться со своим классом. Учитель нажимает кнопку на вашем веб-сайте, чтобы отправить этот контент в Google Classroom.
- Ваше приложение отправляет запрос на
courses.courseWork.create
. В теле запроса содержится объектCourseWork
, который содержит:- Идентификатор курса назначения.
- Название задания.
- Текстовое описание задания.
-
link
Material
с URL-адресом контента, выбранного учителем. - Необязательно, максимальный балл, достижимый для выбранного контента.
- В Классе появится новое задание со ссылкой. Ссылка ссылается на URL-адрес, указанный в запросе
create
. См. пример на рисунке 1. - В журнале оценок Класса также появится новый столбец для задания, в котором будет указан максимальный балл, если он указан.
- Учащиеся получают задание и нажимают
link Material
чтобы открыть предоставленный URL-адрес на новой вкладке и просмотреть или дополнить контент на вашем веб-сайте. При необходимости предоставьте учащемуся элементы управления, чтобы он мог сдать задание . - При желании отправьте запрос на
courses.courseWork.studentSubmissions.modifyAttachments
, чтобы добавить вложения к материалам учащегося, например файл на Google Диске илиlink Material
, указывающий на работу учащегося на вашем веб-сайте. - При желании отправьте запрос на
courses.courseWork.studentSubmissions.patch
, чтобы установить оценку учащегося за задание.
Рис. 1. Представление преподавателя при редактировании задания со link Material
созданной с помощью интеграции CourseWork
.
Альтернативно вы можете вызвать courses.announcements.create
courses.courseWorkMaterials.create
, чтобы создать объявление или материал курса вместо задания. Подробные описания соответствующих действий Classroom API см. на страницах «Создание курсовой работы и управление ею» и «Установка и обновление оценок» .
Соображения
Прежде чем решить, является ли интеграция CourseWork
правильным выбором для нужд вашего продукта, имейте в виду следующее.
- Вам необходимо авторизовать пользователя и запросить его согласие. Вы делаете запросы API от имени пользователя . Это означает, например, что вы не можете создавать курсовые работы ни в одном курсе Google Classroom; Вы можете создавать курсовые работы только на курсах, которые преподает авторизованный пользователь.
- Вам нужен способ, с помощью которого пользователь может выбрать курс для получения контента. Рассмотрите возможность использования
courses.list
для получения списка курсов, преподаваемых пользователем, а затем позвольте пользователю выбрать один или несколько курсов из списка. - Когда пользователь нажимает
link Material
в Классе, ссылка открывается на новой вкладке. Ваш сервер не получит никакой информации из Класса при открытии URL-адреса. - Преподаватель может изменить или удалить курсовую работу независимо от разработчика. Это означает, что знания разработчика о курсовой работе могут устареть. Если вам нужно быть в курсе изменений в курсовой работе, рассмотрите возможность настройки push-уведомлений об изменениях в курсовой работе.
- Преподаватель может создать курсовую работу в пользовательском интерфейсе Класса, вставив ссылки на URL-адреса на вашем веб-сайте. Курсовые работы, созданные таким образом, принадлежат исключительно преподавателю, поэтому вы не сможете просматривать, изменять или устанавливать оценки за отправку с помощью Classroom API.
Разработчики могут использовать API Google Classroom для взаимодействия с курсовыми работами в Google Classroom. Приложение, использующее API таким образом, называется интеграцией CourseWork
.
Этот путь интеграции обычно используется для создания и оценки заданий со ссылками на ресурсы за пределами Класса. Он предоставляет разработчикам больше доступа к управлению курсовыми работами по сравнению с кнопками «Поделиться в классе» .
Как это работает
Основная особенность интеграции CourseWork
— создание заданий, объявлений и материалов курса и управление ими с помощью Classroom API.
Одним из примеров обычного пути пользователя, который становится возможным благодаря интеграции CourseWork
является предоставление преподавателям возможности находить, назначать и оценивать контент на вашем веб-сайте или в приложении:
- Пользователь-учитель входит на ваш сайт.
- Учитель находит или создает контент, которым хочет поделиться со своим классом. Учитель нажимает кнопку на вашем веб-сайте, чтобы отправить этот контент в Google Classroom.
- Ваше приложение отправляет запрос на
courses.courseWork.create
. В теле запроса содержится объектCourseWork
, который содержит:- Идентификатор курса назначения.
- Название задания.
- Текстовое описание задания.
-
link
Material
с URL-адресом контента, выбранного учителем. - Необязательно, максимальный балл, достижимый для выбранного контента.
- В Классе появится новое задание со ссылкой. Ссылка ссылается на URL-адрес, указанный в запросе
create
. См. пример на рисунке 1. - В журнале оценок Класса также появится новый столбец для задания, в котором будет указан максимальный балл, если он указан.
- Учащиеся получают задание и нажимают
link Material
чтобы открыть предоставленный URL-адрес на новой вкладке и просмотреть или дополнить контент на вашем веб-сайте. При необходимости предоставьте учащемуся элементы управления, чтобы он мог сдать задание . - При желании отправьте запрос на
courses.courseWork.studentSubmissions.modifyAttachments
, чтобы добавить вложения к материалам учащегося, например файл на Google Диске илиlink Material
, указывающий на работу учащегося на вашем веб-сайте. - При желании отправьте запрос на
courses.courseWork.studentSubmissions.patch
, чтобы установить оценку учащегося за задание.
Рис. 1. Представление преподавателя при редактировании задания со link Material
созданной с помощью интеграции CourseWork
.
Альтернативно вы можете вызвать courses.announcements.create
courses.courseWorkMaterials.create
, чтобы создать объявление или материал курса вместо задания. Подробные описания соответствующих действий Classroom API см. на страницах «Создание курсовой работы и управление ею» и «Установка и обновление оценок» .
Соображения
Прежде чем решить, является ли интеграция CourseWork
правильным выбором для нужд вашего продукта, имейте в виду следующее.
- Вам необходимо авторизовать пользователя и запросить его согласие. Вы делаете запросы API от имени пользователя . Это означает, например, что вы не можете создавать курсовые работы ни в одном курсе Google Classroom; Вы можете создавать курсовые работы только на курсах, которые преподает авторизованный пользователь.
- Вам нужен способ, с помощью которого пользователь может выбрать курс для получения контента. Рассмотрите возможность использования
courses.list
для получения списка курсов, преподаваемых пользователем, а затем позвольте пользователю выбрать один или несколько курсов из списка. - Когда пользователь нажимает
link Material
в Классе, ссылка открывается на новой вкладке. Ваш сервер не получит никакой информации из Класса при открытии URL-адреса. - Преподаватель может изменить или удалить курсовую работу независимо от разработчика. Это означает, что знания разработчика о курсовой работе могут устареть. Если вам нужно быть в курсе изменений в курсовой работе, рассмотрите возможность настройки push-уведомлений об изменениях в курсовой работе.
- Преподаватель может создать курсовую работу в пользовательском интерфейсе Класса, вставив ссылки на URL-адреса на вашем веб-сайте. Курсовые работы, созданные таким образом, принадлежат исключительно преподавателю, поэтому вы не сможете просматривать, изменять или устанавливать оценки за отправку с помощью Classroom API.