REST Resource: courses.aliases
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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_101p:<name> indica um alias no escopo do projeto. Exemplo: p:abc123 Esse campo tem um comprimento máximo de 256 caracteres.
|
Métodos |
|
|
Cria um alias para um curso. |
|
|
Exclui um alias de um curso. |
|
|
Retorna uma lista de aliases para um curso. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],[],null,["# REST Resource: courses.aliases\n\n- [Resource: CourseAlias](#CourseAlias)\n - [JSON representation](#CourseAlias.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CourseAlias\n---------------------\n\nAlternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the following scopes:\n\n- domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom.\n\n- project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.\n\n| JSON representation |\n|-----------------------------|\n| ``` { \"alias\": string } ``` |\n\n| Fields ||\n|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `alias` | `string` Alias string. The format of the string indicates the desired alias scoping. - `d:\u003cname\u003e` indicates a domain-scoped alias. Example: `d:math_101` - `p:\u003cname\u003e` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------|-----------------------------------------|\n| ### [create](/workspace/classroom/reference/rest/v1/courses.aliases/create) | Creates an alias for a course. |\n| ### [delete](/workspace/classroom/reference/rest/v1/courses.aliases/delete) | Deletes an alias of a course. |\n| ### [list](/workspace/classroom/reference/rest/v1/courses.aliases/list) | Returns a list of aliases for a course. |"]]
