Method: courses.aliases.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Retorna uma lista de aliases para um curso.
Esse método retorna os seguintes códigos de erro:
PERMISSION_DENIED se o usuário solicitante não tiver permissão para acessar o curso ou em caso de erros de acesso.NOT_FOUND se o curso não existir.
Solicitação HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
courseId |
string
O identificador do curso. Esse identificador pode ser o atribuído pelo Google Sala de Aula ou um alias.
|
Parâmetros de consulta
| Parâmetros |
pageSize |
integer
Número máximo de itens a serem retornados. Zero ou indefinido indica que o servidor pode atribuir um valor máximo. O servidor pode retornar menos resultados do que o especificado.
|
pageToken |
string
O valor nextPageToken retornado de uma chamada list anterior, indicando que a página de resultados subsequente precisa ser retornada. A solicitação list precisa ser idêntica à que resultou nesse token.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Resposta ao listar os aliases do curso.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"aliases": [
{
object (CourseAlias)
}
],
"nextPageToken": string
} |
| Campos |
aliases[] |
object (CourseAlias)
Os aliases do curso.
|
nextPageToken |
string
Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, não há mais resultados disponíveis.
|
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
Para mais informações, consulte o guia de autorização.
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,["# Method: courses.aliases.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCourseAliasesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if the course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` The identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.aliases/list#body.ListCourseAliasesResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.aliases/list#google.classroom.v1.Courses.ListCourseAliases) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.aliases/list#google.classroom.v1.Courses.ListCourseAliases) request must be otherwise identical to the one that resulted in this token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing course aliases.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"aliases\": [ { object (/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------|\n| `aliases[]` | `object (`[CourseAlias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias)`)` The course aliases. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n- `\n https://www.googleapis.com/auth/classroom.courses.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
