Обзор

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

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

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

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

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

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

Обзор API

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

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

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

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

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

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

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

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

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

Студенты

Ресурс Student представляет пользователя, который зачислен в качестве студента в

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

Учителя

Ресурс «Учитель» представляет пользователя, который преподает определенный курс.

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

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

UserProfiles представляет собой сопоставление с профилем домена пользователя, идентифицируемым уникальным идентификатором или адресом электронной почты пользователя, возвращаемым API каталога . Текущий пользователь также может ссылаться на свой собственный идентификатор, используя сокращение "me" .

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

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

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

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

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

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

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

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

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

Дополнения для Класса

Надстройка – это пользовательский интерфейс и серверная часть, обслуживаемые партнерами, обычно отображаемые в iframe. Дополнения отображаются в виде вложений в публикации . Это могут быть Announcements , CourseWork или CourseWorkMaterials .

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

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

Дополнительную информацию см. в руководствах по разработке надстроек .

Краткое руководство

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

Поэкспериментируйте с Google API Explorer.

Чтобы поэкспериментировать с вызовом методов на реальных данных, попробуйте использовать Google APIs Explorer . Чтобы начать работу, вам не нужно писать какой-либо код, но имейте в виду, что действия, которые вы выполняете с помощью API Explorer, могут изменить существующие данные.

Один из способов начать вызов методов — вызвать courses.list() . Этот метод не требует каких-либо параметров запроса, и вы можете получить id из возвращаемого списка курсов, чтобы использовать его в качестве параметра запроса для других вызовов API. Если у вас нет курсов, вы можете создать их с помощью методаcourses.create courses.create() .

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