É possível fazer referência a cursos com um nome diferente usando um recurso de alias de curso. Os apelidos de curso são um mapeamento entre identificadores de curso do Google Sala de Aula e identificadores de curso externos.
Sempre que você criar um curso em um SIA ou vincular um curso a
um SIA, recomendamos que o courseID do SIA seja usado como o alias do curso. A API Classroom
permite fazer isso diretamente na criação de cursos especificando o parâmetro id
do
curso como o alias. Se o alias já existir, a criação do curso vai falhar
com um erro ALREADY_EXISTS (409)
. Isso vai evitar a criação de cursos
duplicados se houver um bug no programa de sincronização.
Os aliases são divididos em dois tipos: em todo o domínio e em todo o projeto.
- Os aliases em todo o domínio usam um prefixo de
d:
e podem ser vistos por qualquer pessoa que use a API Classroom. - Os aliases do projeto usam um prefixo de
p:
e só podem ser vistos e usados pelo aplicativo (projeto do console do desenvolvedor) que os criou.
Os aliases podem ser usados em qualquer lugar na API que espera um identificador de curso. Isso significa que, depois que um alias é registrado usando a API, ele pode ser usado para ler e modificar informações de cursos e listas.
Do ponto de vista da sincronização do SIS, isso significa que o identificador interno do SIS 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 SIE e ao Google Sala de Aula pode usar o identificador do SIE para interagir com os dados do Google Sala de Aula.
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 a um novo curso, defina course.id
como o alias desejado 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 alias
como o nome de alias desejado 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