Вы можете ссылаться на курсы по другому названию, используя псевдоним курса . Псевдонимы курсов служат для сопоставления идентификаторов курсов Google Classroom с внешними идентификаторами курсов. Например, вы можете задать псевдоним курса, соответствующий идентификатору курса из информационной системы для студентов (SIS).
Псевдоним курса имеет две формы: для всего домена и для всего проекта.
Псевдонимы, охватывающие весь домен, используют префикс
d:
и видны всем пользователям Classroom API. Пространство имён домена полезно для создания псевдонимов, к которым нужен доступ всем пользователям, но которые не привязаны к какой-либо одной программе. Например, альтернативные списки для курса, такие как MATH 127 и COMSCI 127, следует создавать в пространстве имён домена. Псевдонимы в пространстве имён домена могут создавать только администраторы домена, но они видны всем пользователям домена.Псевдонимы, действующие на уровне всего проекта, используют префикс
p:
и могут быть видны и использоваться только в рамках проекта Google Cloud, создавшего их. Пространство имён проекта разработчика полезно для управления псевдонимами, специфичными для приложения. Например, приложение, использующее альтернативные идентификаторы для курсов, может создавать псевдонимы для сопоставления своего идентификатора с курсами Classroom. Псевдонимы, созданные в этом пространстве имён, привязаны к конкретному проекту Google Cloud. Любой пользователь приложения может создавать и просматривать псевдонимы в пространстве имён проекта разработчика этого приложения.
Псевдоним курса можно использовать вместо идентификатора курса Classroom для любой конечной точки API Classroom. Это означает, что псевдоним можно использовать для чтения и изменения информации о курсах и расписании занятий.
Используйте псевдоним для синхронизации с информационными системами студентов
Внутренний идентификатор SIS для курса можно зарегистрировать как общедоменный псевдоним для этого курса. Таким образом, любой разработчик, интегрирующийся как с SIS, так и с Classroom, сможет использовать этот идентификатор SIS для взаимодействия с данными Classroom.
Если вы создаёте курс из SIS или привязываете курс к SIS, рекомендуется использовать идентификатор курса SIS в качестве псевдонима курса. При создании курса с помощью метода courses.create()
псевдоним можно указать в поле id
запроса. Если псевдоним уже существует, создание курса завершится ошибкой 409 ALREADY_EXISTS
. Это предотвращает создание дубликатов курсов в случае возникновения проблем в программе синхронизации.
Например, если мы предположим, что имя SIS — school
, а внутренний идентификатор, используемый SIS для конкретного курса, — math_101
, вы можете создать псевдоним d:school_math_101
.
Добавить псевдоним для нового курса
Чтобы добавить псевдоним для нового курса, задайте для course.id
псевдоним при выполнении запроса courses.create()
.
Скрипт приложений
Ява
Питон
Добавить псевдоним для существующего курса
Чтобы добавить псевдоним к существующему курсу, вы можете задать поле alias
и использовать метод courses.aliases.create()
.
Скрипт приложений
Ява
Питон
Получить псевдонимы курса
Вы можете получить псевдонимы для курса с помощью метода courses.aliases.list()
, как показано в следующем примере: