É possível referenciar cursos por um nome diferente usando um alias de curso. Os aliases de curso podem servir como um mapeamento entre os identificadores de curso do Google Sala de Aula e os identificadores de curso externos. Por exemplo, é possível definir um alias de curso para corresponder ao ID do curso de um sistema de informações de estudantes (SIS).
O alias do curso tem duas formas: em todo o domínio e em todo o projeto.
Aliases em todo o domínio usam o prefixo
d:e podem ser vistos por qualquer pessoa que use a API Classroom. O namespace de domínio é útil para criar aliases que todos os usuários precisam acessar, mas que não são específicos de um programa. Por exemplo, listagens alternativas para um curso, como MATH 127 e COMSCI 127, precisam ser criadas no namespace de domínio. Os aliases no namespace de domínio só podem ser criados por administradores de domínio, mas ficam visíveis para todos os usuários em um domínio.Aliases em todo o projeto usam um prefixo de
p:e só podem ser vistos e usados pelo projeto na nuvem 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 nesse namespace estão vinculados a um projeto na nuvem específico do Google Cloud. Qualquer usuário de um aplicativo pode criar e visualizar aliases no namespace do projeto do desenvolvedor desse aplicativo.
Um alias de curso pode ser usado no lugar do ID do curso do Google Sala de Aula para qualquer endpoint de API do Google Sala de Aula. Isso significa que o alias pode ser usado para ler e modificar cursos e informações de lista.
Usar um alias para sincronização com sistemas de informações de estudantes
O identificador interno do SIS para um curso pode ser registrado como um alias de domínio para o curso. Dessa forma, qualquer desenvolvedor que se integre ao SIS e ao Google Sala de Aula pode usar o identificador do SIS para interagir com os dados do Google Sala de Aula.
Se você criar um curso em um SIS ou vincular um curso a um SIS, é recomendável
que o ID do curso do SIS seja usado como o alias do curso. Ao criar um
curso usando o courses.create() método, é possível especificar o alias no
id campo da solicitação. Se o alias já existir, a criação do curso falhará com um erro 409 ALREADY_EXISTS. Isso impede 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, você poderá criar um alias
como d:school_math_101.
Adicionar um alias para um novo curso
Para adicionar um alias para um novo curso, defina course.id como um alias ao
fazer a courses.create() solicitação.
Apps Script
Java
Python
Adicionar um alias para um curso atual
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
courses.aliases.list() método, conforme mostrado no
exemplo a seguir:
.NET
Java
Python