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