Method: courses.studentGroups.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Возвращает список групп в курсе.
Этот метод возвращает следующие коды ошибок:
-
NOT_FOUND , если курс не существует.
HTTP-запрос
GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups
URL использует синтаксис перекодировки gRPC .
Параметры пути
| Параметры |
|---|
courseId | string Обязательно. Идентификатор курса. |
Параметры запроса
| Параметры |
|---|
pageSize | integer Максимальное количество возвращаемых элементов. Ноль или не указано, что означает, что сервер может установить максимальное количество элементов, которое в настоящее время равно 75 элементам. Сервер может вернуть меньше указанного количества результатов. |
pageToken | string Значение nextPageToken , возвращаемое из предыдущего вызова list , указывает, что должна быть возвращена следующая страница результатов. В остальном запрос list должен быть идентичен тому, который привел к получению этого токена. |
previewVersion | enum ( PreviewVersion ) Необязательно. Предварительная версия API. Необходимо установить для доступа к новым возможностям API, доступным разработчикам в рамках программы предварительной версии. |
Текст запроса
Тело запроса должно быть пустым.
Тело ответа
Ответ при перечислении студенческих групп.
В случае успеха тело ответа содержит данные со следующей структурой:
| JSON-представление |
|---|
{
"studentGroups": [
{
object (StudentGroup)
}
],
"nextPageToken": string
} |
| Поля |
|---|
studentGroups[] | object ( StudentGroup ) Студенческие группы. |
nextPageToken | string Токен, идентифицирующий следующую страницу результатов, которую нужно вернуть. Если пусто, дальнейшие результаты недоступны. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/classroom.rosters -
https://www.googleapis.com/auth/classroom.rosters.readonly
Более подробную информацию смотрите в Руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-08-08 UTC.
[null,null,["Последнее обновление: 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)."]]
