API Google Classroom предоставляет программный интерфейс для разработчиков программного обеспечения, администраторов и руководителей учебных заведений, позволяющий управлять ресурсами Google Classroom. Вы можете создавать программное обеспечение для создания, извлечения и изменения курсов Classroom и их содержимого.
Некоторые типичные варианты использования включают в себя:
- Управление курсами, списками и опекунами
- Добавление заданий, объявлений и материалов курса
- Выставление оценок и изменение настроек оценок
- Генерация данных для анализа
- Обеспечение возможности обнаружения и доступа к контенту или инструментам внешнего поставщика в Classroom
Является ли Classroom API правильным решением для меня?
Google предлагает несколько продуктов для взаимодействия с Classroom. Ниже приведены некоторые распространённые сценарии и рекомендации по выбору продуктов, которые могут лучше всего подойти вашим потребностям.
Изменить ресурсы Google Classroom
| Сценарий | Рекомендуемые решения |
|---|---|
| Мне необходимо регулярно управлять большим количеством курсов, пользователей и других ресурсов Classroom. Я умею писать код и поддерживать программную инфраструктуру. | Напишите приложения, использующие Classroom API. |
| Мне нужно время от времени управлять небольшим объёмом ресурсов Classroom. Мне комфортно писать небольшие объёмы кода с минимальными накладными расходами. | Используйте Classroom API с Google Apps Script . |
| Мне нужно время от времени вносить изменения в отдельные ресурсы Classroom. Мне комфортно работать с командами терминала. | Используйте Менеджер приложений Google . |
| Мне нужен большой объем отчетов с подробностями о событиях в классе. | Используйте службу передачи данных BigQuery. |
| Я хочу провести расследование активности моих пользователей. | Создавайте отчеты в консоли администратора или используйте API отчетов . |
Интеграция с Google Classroom
| Сценарий | Рекомендуемые решения |
|---|---|
| Я хочу, чтобы преподаватели и ученики видели и запускали мой контент в Classroom. | Создайте дополнение для класса . |
| Я хочу, чтобы учителя нажимали кнопку на моем сайте или в приложении, которая встраивает мой контент в Classroom. | Создайте надстройку Classroom и создавайте вложения программным способом. |
| Я хочу, чтобы учителя нажимали кнопку на моем веб-сайте или в приложении, чтобы перейти к моему контенту в Classroom. | Создавайте курсовые работы с помощью Classroom API или встраивайте кнопки «Поделиться в Classroom» . |
| Я хочу, чтобы преподаватели класса синхронизировали информацию с моей системой информации о студентах или импортировали ее из нее. | Реализуйте OneRoster для SIS или создайте и получите доступ к ресурсам с помощью Classroom API. |
Начиная
Новым разработчикам рекомендуется сделать следующее перед началом нового проекта:
- Прочтите наше руководство по структуре API Classroom .
- Узнайте об оценках , типах пользователей , условиях доступа пользователей и действиях администратора . В этих руководствах объясняются уникальные концепции Google Classroom и Classroom API.
- Понять, как работают запросы API Classroom .
Чтобы начать разработку, убедитесь, что вы выполнили все необходимые предварительные шаги . Выберите соответствующие вашим потребностям области действия Classroom API , затем настройте свою среду и начните отправлять запросы, следуя одному из кратких руководств:
Эксперимент с обозревателем API Google
Чтобы поэкспериментировать с вызовом методов на реальных данных, попробуйте использовать Google APIs Explorer . Вам не нужно писать код, чтобы начать работу, но учтите, что действия, выполняемые с помощью APIs Explorer, могут изменить существующие данные.
Один из способов начать вызов методов — вызвать метод courses.list() . Этот метод не требует параметров запроса, и вы можете получить id из возвращаемого списка курсов, чтобы использовать его в качестве параметра запроса для других вызовов API. Если у вас нет курсов, вы можете создать их с помощью метода courses.create() .
Вы также можете изучить справочник по API Classroom .