É possível referenciar cursos com um nome diferente usando um alias de curso. Os aliases de curso podem servir como um mapeamento entre identificadores de curso externos e do Google Sala de Aula. Por exemplo, é possível definir um alias de curso para corresponder ao ID do curso de um sistema de informações de estudantes (SIE).
O alias do curso tem duas formas: em todo o domínio e em todo o projeto.
Os aliases em todo o domínio usam o prefixo
d:
e podem ser acessados por qualquer pessoa que use a API Classroom. O namespace de domínio é útil para criar aliases a que todos os usuários precisam ter acesso, mas que não são específicos de nenhum programa. Por exemplo, as listagens alternativas de um curso, como MATH 127 e COMSCI 127, precisam ser criadas no namespace do domínio. Os aliases no namespace do domínio só podem ser criados por administradores do domínio, mas são visíveis para todos os usuários em um domínio.Os pseudônimos em todo o projeto usam o prefixo
p:
e só podem ser acessados e usados pelo projeto do Google Cloud que os criou. O namespace do projeto do desenvolvedor é útil para gerenciar aliases específicos de um aplicativo. Por exemplo, um aplicativo que usa identificadores alternativos para cursos pode criar aliases para mapear o identificador para cursos do Google Sala de Aula. Os aliases criados neste namespace estão vinculados a um projeto específico do Google Cloud. Qualquer usuário de um aplicativo pode criar e visualizar aliases no namespace do projeto de desenvolvedor desse aplicativo.
Um alias de curso pode ser usado no lugar do ID do curso do Google Sala de aula para qualquer endpoint da API do Google Sala de aula. Isso significa que o alias pode ser usado para ler e modificar informações de cursos e listas.
Usar um alias para sincronização com sistemas de informações dos estudantes
O identificador interno do SIA para um curso pode ser registrado como um alias em todo o domínio para o curso. Dessa forma, qualquer desenvolvedor que se integrar ao SIA e ao Google Sala de Aula pode usar o identificador do SIA para interagir com os dados do Google Sala de Aula.
Se você criar um curso a partir de um SIS ou vincular um curso a um SIS, recomendamos
que o ID do curso do SIS seja usado como a abreviação do curso. Ao criar um
curso usando o método courses.create()
, é possível especificar o alias no
campo id
da solicitação. Se o alias já existir, a criação do curso
falhará com um erro 409 ALREADY_EXISTS
. Isso evita a criação de
cursos duplicados se houver um problema no programa de sincronização.
Por exemplo, se o nome do SIS for school
e o identificador interno
usado pelo SIS para um curso específico for math_101
, crie um alias
como d:school_math_101
.
Adicionar um alias para um novo curso
Para adicionar um alias a um novo curso, defina course.id
como um alias ao
fazer a solicitação courses.create()
.
Apps Script
Java
Python
Adicionar um alias para um curso
Para adicionar o alias a um curso atual, defina o campo alias
e use o método courses.aliases.create()
.
Apps Script
Java
Python
Recuperar aliases de curso
É possível recuperar os aliases de um curso usando o método
courses.aliases.list()
, conforme mostrado no
exemplo abaixo:
.NET
Java
Python