Используют ли ваши пользователи Класс с Google Meet? Ознакомьтесь с кратким руководством по скрипту приложений, в котором рассказывается, как проверить посещаемость учащихся на курсах Google Meet .

Обзор

Classroom API предоставляет интерфейс RESTful для управления курсами и списками в Google Classroom. Кроме того, кнопка «Поделиться в Классе » позволяет разработчикам и владельцам контента предоставлять доступ к своему контенту в Классе.

Кто может использовать API?

Администраторы домена G Suite for Education могут использовать API для программной подготовки курсов от имени учителей, синхронизации информационных систем учащихся с Classroom и получения базовой информации о классах, которые преподаются в их домене.

Разработчики приложений могут использовать Classroom API для интеграции своих приложений с Classroom. Эти приложения должны использовать OAuth 2.0, чтобы запрашивать разрешение на просмотр классов и списков у учителей. Администраторы могут запретить учителям и учащимся в своем домене разрешать приложениям доступ к своим данным Google Classroom.

Владельцы веб-сайтов и разработчики контента могут использовать кнопку «Поделиться в Классе», чтобы позволить учащимся и преподавателям делиться контентом обратно в Класс.

Все интеграции API и кнопки «Поделиться» в Классе должны соответствовать рекомендациям бренда Класса .

Обзор API

Classroom API состоит из нескольких типов сущностей, которые соответствуют классам, учителям и учащимся в интерфейсе Classroom. Некоторые из этих объектов имеют дополнительные свойства, характерные для API, в дополнение к тем, которые существуют в Классе. Основные типы сущностей:

Подробную информацию о ресурсах и методах API см. в справочнике API Classroom .

Метаданные курса и псевдонимы

Курсы представляют класс, например «Математика 4-го урока М. Смита», и назначенных ему учителей, список учащихся и метаданные. Каждый курс идентифицируется уникальным идентификатором, присвоенным сервером. Ресурс курса специально инкапсулирует все метаданные о курсе, такие как название, описание, местоположение и время. Списки курсов управляются с помощью ресурсов « Студент », « Преподаватель » и « Приглашение » и их методов.

Псевдонимы — это альтернативные идентификаторы для класса, которые могут быть связаны с курсом и использоваться вместо уникального идентификатора. Каждый псевдоним существует в пространстве имен, которое ограничивает круг лиц, которые могут его создавать и просматривать. Поддерживаются два пространства имен:

  • Домен: Пространство имен домена полезно для создания псевдонимов, доступ к которым необходим всем пользователям, но которые не являются специфическими для какой-либо одной программы. Например, альтернативные списки для курса, такие как MATH 127 и COMSCI 127, должны быть созданы в пространстве имен домена. Псевдонимы в пространстве имен домена могут создаваться только администраторами домена, но они видны всем пользователям домена.
  • Проект разработчика: Пространство имен проекта разработчика полезно для управления псевдонимами, характерными для приложения. Например, приложение, использующее альтернативные идентификаторы для курсов, может создавать псевдонимы для сопоставления своего идентификатора с курсами Classroom. Псевдонимы, созданные в этом пространстве имен, привязаны к конкретной консоли Google API . Любой пользователь приложения может создавать и просматривать псевдонимы в пространстве имен для проекта разработчика этого приложения.

Дополнительные сведения об управлении метаданными и псевдонимами курса см. в разделе Управление курсами .

Списки курсов и пользователи

Студенты и преподаватели — это определенные сопоставления между профилем пользователя и курсом, представляющие роль этого пользователя в курсе. Назначения студента и преподавателя не являются глобальными: пользователь может быть назначен преподавателем для одного курса и студентом для другого. Обозначение «ученик» или «преподаватель» представляет собой набор разрешений для конкретного пользователя в конкретном курсе.

Ученики
Ресурс Student представляет пользователя, зачисленного в качестве студента на определенный курс. Учащимся разрешено просматривать сведения о курсе и преподавателях этого курса.
Учителя
Ресурс «Учитель» представляет пользователя, который преподает определенный курс. Учителям разрешено просматривать и изменять сведения о курсе, просматривать преподавателей и учащихся, а также управлять дополнительными учителями и учащимися.

Приглашения и связанные с ними методы обеспечивают удобный способ добавления студентов и преподавателей на курсы. Создание приглашений позволяет пользователям выбирать, присоединяться к курсу или нет, вместо того, чтобы вы напрямую добавляли их через ресурсы учителя и ученика.

Профили пользователей представляют собой сопоставление с профилем домена пользователя, определяемым уникальным идентификатором или адресом электронной почты пользователя, возвращаемым Google Admin SDK . Текущий пользователь также может ссылаться на свой собственный идентификатор, используя сокращение "me" .

Дополнительные сведения об управлении списками см. в разделе Управление учителями и учениками .

Курсовые работы и работы студентов

Элемент CourseWork представляет собой одну задачу, назначенную группе студентов в рамках курса. Он содержит такие детали, как описание, срок выполнения и материалы, а также метаданные, такие как время создания. Материалы включают заголовок, миниатюру и URL-адрес, а также идентификатор, который можно использовать с соответствующими API (например, Диск, YouTube).

Элементы CourseWork описывают один из следующих типов задач:

  • Задание, которое учащиеся выполняют, отправляя рабочие листы или другие вложения.
  • Вопрос с кратким ответом или вопрос с несколькими вариантами ответов.

Студенческая работа над элементом CourseWork представлена ​​StudentSubmission . Он состоит из ответа и дополнительных метаданных, таких как состояние и присвоенная оценка.

Содержимое StudentSubmission зависит от типа соответствующего элемента CourseWork:

  • Рабочие листы и вложения, отправленные для задания, включая их название, миниатюру и URL-адрес, а также идентификаторы, которые можно использовать с соответствующими API, такими как Диск или YouTube.
  • Ответ на вопрос с кратким ответом или вопрос с множественным выбором.

Дополнительные сведения об управлении курсовыми работами и отправленными учащимися работами см. в разделе Управление классной работой .

Начать

Чтобы настроить среду и сразу приступить к работе с API, воспользуйтесь одним из кратких руководств:

Вы также можете изучить справку по API .