Você pode referenciar cursos com 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, você pode definir um alias de curso para corresponder ao ID de um curso em um sistema de informações dos estudantes (SIE).
O alias do curso tem duas formas: em todo o domínio e em todo o projeto.
Os apelidos 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 nenhum programa. Por exemplo, as listagens alternativas de um curso, como MAT 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 ficam visíveis para todos os usuários em um domínio.Os aliases em todo o projeto usam um prefixo
p:
e só podem ser vistos 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 dele para os cursos do Google Sala de Aula. Os aliases criados nesse 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 Classroom. Isso significa que o alias pode ser usado para ler e modificar informações de cursos e listas de alunos.
Usar um alias para sincronização com sistemas de informações de estudantes
O identificador interno do SIA de um curso pode ser registrado como um alias em todo o domínio. Assim, qualquer desenvolvedor que se integre 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 ou vincular um curso a um SIE, recomendamos que o ID do curso do SIE seja usado como alias 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
vai 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 SIE for school
e o identificador interno usado pelo SIE 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 a um novo curso, defina course.id
como um alias ao
fazer a solicitação courses.create()
.
Apps Script
Java
Python
Adicionar um alias a um curso
Para adicionar o alias a um curso existente, defina o campo alias
e use o método courses.aliases.create()
.
Apps Script
Java
Python
Recuperar aliases de cursos
Você pode recuperar os aliases de um curso usando o método
courses.aliases.list()
, conforme mostrado no
exemplo a seguir:
.NET
Java
Python