Method: courses.studentGroups.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Renvoie la liste des groupes d'un cours.Cette méthode renvoie les codes d'erreur suivants :
NOT_FOUND si le cours n'existe pas.
Requête HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
courseId |
string
Obligatoire. Identifiant du cours.
|
Paramètres de requête
| Paramètres |
pageSize |
integer
Nombre maximal d'éléments à renvoyer. Si la valeur est zéro ou non spécifiée, le serveur peut attribuer un maximum, qui est actuellement défini sur 75 éléments. Le serveur peut renvoyer un nombre de résultats inférieur à celui 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.
|
previewVersion |
enum (PreviewVersion)
Facultatif. Version preview de l'API. Ce paramètre doit être défini pour accéder aux nouvelles fonctionnalités d'API mises à la disposition des développeurs dans le programme Preview.
|
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 groupes d'élèves.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
| Représentation JSON |
{
"studentGroups": [
{
object (StudentGroup)
}
],
"nextPageToken": string
} |
| Champs |
studentGroups[] |
object (StudentGroup)
Groupes d'élèves.
|
nextPageToken |
string
Jeton identifiant la page de résultats suivante à renvoyer. Si ce champ est vide, cela signifie qu'il n'y a plus de résultats.
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.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/08/08 (UTC).
[null,null,["Dernière mise à jour le 2025/08/08 (UTC)."],[],[],null,["# Method: courses.studentGroups.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.ListStudentGroupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\n\u003cbr /\u003e\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20250630_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more.\nReturns a list of groups in a course.\n\n\u003cbr /\u003e\n\nThis method returns the following error codes:\n\n- `NOT_FOUND` if the course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|--------------------------------------------------|\n| `courseId` | `string` Required. The identifier of the course. |\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, which is currently set to 75 items. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.studentGroups/list#body.ListStudentGroupsResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.studentGroups/list#google.classroom.v1.Courses.ListStudentGroups) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.studentGroups/list#google.classroom.v1.Courses.ListStudentGroups) request must be otherwise identical to the one that resulted in this token. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The preview version of the API. This must be set in order to access new API capabilities made available to developers in the Preview Program. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing student groups.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"studentGroups\": [ { object (/workspace/classroom/reference/rest/v1/courses.studentGroups#StudentGroup) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `studentGroups[]` | `object (`[StudentGroup](/workspace/classroom/reference/rest/v1/courses.studentGroups#StudentGroup)`)` The student groups. |\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.rosters`\n- `\n https://www.googleapis.com/auth/classroom.rosters.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
