REST Resource: courses.aliases

Recurso: CourseAlias

Identificador alternativo de um curso.

Um alias identifica um curso de forma exclusiva. Ele precisa ser exclusivo em um dos seguintes escopos:

  • domínio: um alias no escopo do domínio é visível para todos os usuários no domínio do criador do alias e só pode ser criado por um administrador do domínio. Um alias no escopo do domínio é usado com frequência quando um curso tem um identificador externo ao Google Sala de Aula.

  • project: um alias no escopo do projeto é visível para qualquer solicitação de um aplicativo que use o ID do projeto do console do desenvolvedor que criou o alias e pode ser criado por qualquer projeto. Um alias no escopo do projeto é usado com frequência quando um aplicativo tem identificadores alternativos. Um valor aleatório também pode ser usado para evitar cursos duplicados em caso de falhas de transmissão, já que a repetição de uma solicitação vai retornar ALREADY_EXISTS se uma anterior tiver sido bem-sucedida.

Representação JSON 
{
  "alias": string
}
Campos
alias

string

String de alias. O formato da string indica o escopo do alias desejado.

  • d:<name> indica um alias no escopo do domínio. Exemplo: d:math_101
  • p:<name> indica um alias no escopo do projeto. Exemplo: p:abc123

Esse campo tem um comprimento máximo de 256 caracteres.

Métodos

create

 Cria um alias para um curso.

delete

 Exclui um alias de um curso.

list

 Retorna uma lista de aliases para um curso.