REST Resource: courses.aliases

Recurso: CourseAlias

Identificador alternativo de um curso.

Um alias identifica exclusivamente um curso. Ele precisa ser exclusivo dentro de um dos seguintes escopos:

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

  • project: um alias com escopo de projeto é visível para qualquer solicitação de um aplicativo usando o ID do projeto do Developer Console que criou o alias e pode ser criado por qualquer projeto. Um alias com escopo de projeto geralmente é usado 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 repetir uma solicitação vai retornar ALREADY_EXISTS se uma anterior for bem-sucedida.

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

string

String do 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

Este campo tem um tamanho 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 de um curso.