Method: courses.aliases.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Renvoie la liste des alias d'un cours.
Cette méthode renvoie les codes d'erreur suivants:
PERMISSION_DENIED si l'utilisateur à l'origine de la demande n'est pas autorisé à accéder au cours ou en cas d'erreurs d'accès.NOT_FOUND si le cours n'existe pas.
Requête HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
courseId |
string
Identifiant du cours. Cet identifiant peut être l'identifiant attribué par Classroom ou un alias.
|
Paramètres de requête
| Paramètres |
pageSize |
integer
Nombre maximal d'éléments à renvoyer. Une valeur nulle ou non spécifiée indique que le serveur peut attribuer une valeur maximale. Le serveur peut renvoyer un nombre inférieur au nombre de résultats spécifié.
|
pageToken |
string
Valeur nextPageToken renvoyée par un appel list précédent, indiquant que la page de résultats suivante doit être renvoyée. La requête list doit être identique à celle qui a généré ce jeton.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse lors de la liste des alias de cours.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"aliases": [
{
object (CourseAlias)
}
],
"nextPageToken": string
} |
| Champs |
aliases[] |
object (CourseAlias)
Alias du cours.
|
nextPageToken |
string
Jeton identifiant la page de résultats suivante à renvoyer. Si ce champ est vide, aucun autre résultat n'est disponible.
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
Pour en savoir plus, consultez le guide d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 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)."]]
