Method: courses.courseWork.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Возвращает список курсовой работы, которую запрашивающему разрешено просматривать.
Студенты курса могут просматривать только PUBLISHED
курсовые работы. Преподаватели курса и администраторы домена могут просматривать все работы курса.
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED
если запрашивающему пользователю не разрешен доступ к запрошенному курсу или в случае ошибок доступа . -
INVALID_ARGUMENT
, если запрос имеет неверный формат. -
NOT_FOUND
, если запрошенный курс не существует.
HTTP-запрос
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры |
---|
courseId | string Идентификатор курса. Этот идентификатор может быть либо идентификатором, присвоенным Классом, либо alias . |
Параметры запроса
Параметры |
---|
courseWorkStates[] | enum ( CourseWorkState ) Ограничение на рабочий статус для возврата. Возвращается только соответствующий курс CourseWork. Если не указано, возвращаются элементы с рабочим статусом PUBLISHED . |
orderBy | string Необязательный порядок сортировки результатов. Список полей, разделенных запятыми, с необязательным ключевым словом направления сортировки. Поддерживаемые поля: updateTime и dueDate . Поддерживаемые ключевые слова направления: asc и desc . Если не указано, updateTime desc является поведением по умолчанию. Примеры: dueDate asc,updateTime desc , updateTime,dueDate desc |
pageSize | integer Максимальное количество товаров для возврата. Ноль или не указано означает, что сервер может назначить максимум. Сервер может вернуть меньшее количество результатов, чем указано. |
pageToken | string Значение nextPageToken , возвращенное из предыдущего вызова list , указывает, что должна быть возвращена следующая страница результатов. В остальном запрос list должен быть идентичен тому, который привел к получению этого токена. |
previewVersion | enum ( PreviewVersion ) Необязательный. Предварительная версия API. Это необходимо настроить, чтобы получить доступ к новым возможностям API, доступным разработчикам в программе предварительной версии. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответ при перечислении курсовой работы.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"courseWork": [
{
object (CourseWork )
}
],
"nextPageToken": string
} |
Поля |
---|
courseWork[] | object ( CourseWork ) Элементы курсовой работы, соответствующие запросу. |
nextPageToken | string Токен, идентифицирующий следующую страницу результатов, которую нужно вернуть. Если пусто, дальнейшие результаты недоступны. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/classroom.coursework.students.readonly
-
https://www.googleapis.com/auth/classroom.coursework.me.readonly
-
https://www.googleapis.com/auth/classroom.coursework.students
-
https://www.googleapis.com/auth/classroom.coursework.me
Дополнительную информацию см. в руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 2025-07-25 UTC."],[],[],null,["# Method: courses.courseWork.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.ListCourseWorkResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if the requested course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseWorkStates[]` | `enum (`[CourseWorkState](/workspace/classroom/reference/rest/v1/courses.courseWork#CourseWorkState)`)` Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. |\n| `orderBy` | `string` Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` |\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.courseWork/list#body.ListCourseWorkResponse.FIELDS.next_page_token) value returned from a previous `list` call, indicating that the subsequent page of results should be returned. The `list` 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 course work.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"courseWork\": [ { object (/workspace/classroom/reference/rest/v1/courses.courseWork#CourseWork) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseWork[]` | `object (`[CourseWork](/workspace/classroom/reference/rest/v1/courses.courseWork#CourseWork)`)` Course work items that match the 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.coursework.students.readonly`\n- `\n https://www.googleapis.com/auth/classroom.coursework.me.readonly`\n- `\n https://www.googleapis.com/auth/classroom.coursework.students`\n- `\n https://www.googleapis.com/auth/classroom.coursework.me`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]