Method: courses.studentGroups.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Retorna uma lista de grupos em um curso.Esse método retorna os seguintes códigos de erro:
NOT_FOUND se o curso não existir.
Solicitação HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
courseId |
string
Obrigatório. O identificador do curso.
|
Parâmetros de consulta
| Parâmetros |
pageSize |
integer
Número máximo de itens a serem retornados. Zero ou não especificado indica que o servidor pode atribuir um máximo, que atualmente está definido como 75 itens. O servidor pode retornar menos resultados do que o número especificado.
|
pageToken |
string
Valor nextPageToken retornado de uma chamada list anterior, indicando que a página de resultados subsequente deve ser retornada. A solicitação list precisa ser idêntica àquela que resultou neste token.
|
previewVersion |
enum (PreviewVersion)
Opcional. A versão de prévia da API. Isso precisa ser definido para acessar os novos recursos de API disponibilizados aos desenvolvedores no programa de prévia.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Resposta ao listar grupos de estudantes.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
{
"studentGroups": [
{
object (StudentGroup)
}
],
"nextPageToken": string
} |
| Campos |
studentGroups[] |
object (StudentGroup)
Os grupos de estudantes.
|
nextPageToken |
string
Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, não haverá mais resultados disponíveis.
|
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.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-08-08 UTC.
[null,null,["Última atualização 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)."]]
