REST Resource: courses.aliases

• Recurso: CourseAlias
  • Representação JSON
• Métodos

Recurso: CourseAlias

Identificador alternativo de um curso.

Um alias identifica exclusivamente um curso. Ele precisa ser exclusivo em um destes escopos:

• domínio: um alias com escopo no domínio fica 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 com escopo de domínio geralmente é usado quando um curso tem um identificador externo ao Google Sala de Aula.

• projeto: um alias com escopo de projeto fica visível para qualquer solicitação de um aplicativo usando o ID do projeto do Console do desenvolvedor 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 na transmissão, já que a repetição de uma solicitação retornará ALREADY_EXISTS se a anterior for bem-sucedida.

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

Campos
alias	string String do alias. O formato da string indica o escopo de 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.