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