Method: courses.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Renvoie la liste des cours que l'utilisateur à l'origine de la requête est autorisé à afficher, limitée à ceux qui correspondent à la requête. Les cours renvoyés sont classés par date de création, les plus récents en premier.
Cette méthode renvoie les codes d'erreur suivants:
PERMISSION_DENIED pour les erreurs d'accès.INVALID_ARGUMENT si l'argument de la requête est incorrect.NOT_FOUND si des utilisateurs spécifiés dans les arguments de la requête n'existent pas.
Requête HTTP
GET https://classroom.googleapis.com/v1/courses
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de requête
| Paramètres |
studentId |
string
Limite les cours renvoyés à ceux ayant un élève avec l'identifiant spécifié. L'identifiant peut être l'un des éléments suivants:
- Identifiant numérique de l'utilisateur
- l'adresse e-mail de l'utilisateur ;
- le littéral de chaîne
"me", qui indique l'utilisateur à l'origine de la requête
|
teacherId |
string
Limite les cours renvoyés à ceux dont l'enseignant possède l'identifiant spécifié. L'identifiant peut être l'un des éléments suivants:
- Identifiant numérique de l'utilisateur
- l'adresse e-mail de l'utilisateur ;
- le littéral de chaîne
"me", qui indique l'utilisateur à l'origine de la requête
|
courseStates[] |
enum (CourseState)
Limite les cours renvoyés à ceux qui se trouvent dans l'un des états spécifiés. La valeur par défaut est "ACTIVE", "ARCHIVED", "PROVISIONED" et "DECLINED".
|
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 cours.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"courses": [
{
object (Course)
}
],
"nextPageToken": string
} |
| Champs |
courses[] |
object (Course)
Cours correspondant à la requête de liste.
|
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.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCoursesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the query argument is malformed.\n- `NOT_FOUND` if any users specified in the query arguments do not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `teacherId` | `string` Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `courseStates[]` | `enum (`[CourseState](/workspace/classroom/reference/rest/v1/courses#CourseState)`)` Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. |\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/list#body.ListCoursesResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses/list#google.classroom.v1.Courses.ListCourses) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses/list#google.classroom.v1.Courses.ListCourses) 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 courses.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"courses\": [ { object (/workspace/classroom/reference/rest/v1/courses#Course) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------|\n| `courses[]` | `object (`[Course](/workspace/classroom/reference/rest/v1/courses#Course)`)` Courses that match the list request. |\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)."]]
