Method: courses.courseWork.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Retorna uma lista de trabalhos do curso que o solicitante tem permissão para acessar.
Os estudantes do curso só podem acessar o trabalho do curso PUBLISHED
. Os professores e administradores do domínio podem acessar todo o trabalho do curso.
Esse método retorna os seguintes códigos de erro:
PERMISSION_DENIED
se o usuário solicitante não tiver permissão para acessar o curso solicitado ou por erros de acesso.
INVALID_ARGUMENT
se a solicitação estiver incorreta.
NOT_FOUND
, se o curso solicitado não existir.
Solicitação HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros |
courseId |
string
Identificador do curso. Esse identificador pode ser o atribuído pelo Google Sala de Aula ou um alias .
|
Parâmetros de consulta
Parâmetros |
courseWorkStates[] |
enum (CourseWorkState )
Restrição ao status do trabalho a ser retornado. Somente as atividades correspondentes são retornadas. Se não for especificado, os itens com um status de trabalho de PUBLISHED serão retornados.
|
orderBy |
string
Ordem de classificação opcional para os resultados. Uma lista de campos separados por vírgulas com uma palavra-chave opcional de direção de ordenação. Os campos aceitos são updateTime e dueDate . As palavras-chave de direção aceitas são asc e desc . Se não for especificado, o comportamento padrão será updateTime desc . Exemplos: dueDate asc,updateTime desc , updateTime,dueDate desc
|
pageSize |
integer
Número máximo de itens a serem retornados. Zero ou indefinido indica que o servidor pode atribuir um valor máximo. O servidor pode retornar menos resultados do que o especificado.
|
pageToken |
string
O valor nextPageToken retornado de uma chamada list anterior, indicando que a página de resultados subsequente precisa ser retornada. A solicitação list precisa ser idêntica à que resultou nesse token.
|
previewVersion |
enum (PreviewVersion )
Opcional. A versão de pré-lançamento da API. É necessário definir esse valor para acessar os novos recursos de API disponibilizados para os desenvolvedores no programa de visualização.
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Resposta ao listar o trabalho do curso.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
{
"courseWork": [
{
object (CourseWork )
}
],
"nextPageToken": string
} |
Campos |
courseWork[] |
object (CourseWork )
Itens de trabalho de curso que correspondem à solicitação.
|
nextPageToken |
string
Token que identifica a próxima página de resultados a serem retornados. Se estiver vazio, não há mais resultados disponíveis.
|
Escopos de autorização
Requer um dos seguintes escopos do 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
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-07-25 UTC.
[null,null,["Última atualização 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)."]]