Los complementos de Google Classroom ya están en fase de disponibilidad general para desarrolladores. Consulta la
documentación sobre complementos para obtener más información.
Method: courses.studentGroups.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Devuelve una lista de los grupos de un curso.Este método devuelve los siguientes códigos de error:
NOT_FOUND si el curso no existe.
Solicitud HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros |
courseId |
string
Es obligatorio. Es el identificador del curso.
|
Parámetros de consulta
| Parámetros |
pageSize |
integer
Es la cantidad máxima de elementos que se devolverán. Si se especifica cero o no se especifica, se indica que el servidor puede asignar un máximo, que actualmente está establecido en 75 elementos. Es posible que el servidor devuelva menos resultados de los que se especificaron.
|
pageToken |
string
Valor de nextPageToken que se devolvió de una llamada list anterior, lo que indica que se debe devolver la página siguiente de resultados. La solicitud list debe ser idéntica a la que generó este token.
|
previewVersion |
enum (PreviewVersion)
Opcional. Es la versión preliminar de la API. Se debe configurar para acceder a las nuevas capacidades de la API que se ponen a disposición de los desarrolladores en el Programa de versión preliminar.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Es la respuesta cuando se enumeran los grupos de estudiantes.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
| Representación JSON |
{
"studentGroups": [
{
object (StudentGroup)
}
],
"nextPageToken": string
} |
| Campos |
studentGroups[] |
object (StudentGroup)
Son los grupos de estudiantes.
|
nextPageToken |
string
Es un token que identifica la siguiente página de resultados que se devolverá. Si está vacío, no hay más resultados disponibles.
|
Permisos de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
Para obtener más información, consulta la Guía de autorización.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-08-08 (UTC)
[null,null,["Última actualización: 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)."]]
