Google Classroom-Add-ons sind jetzt allgemein für Entwickler verfügbar. Weitere Informationen finden Sie in der
Dokumentation zu Add-ons.
Method: courses.courseWork.list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Gibt eine Liste der Kursarbeiten zurück, die der Antragsteller ansehen darf.
Kursteilnehmer können sich nur PUBLISHED
Kursarbeiten ansehen. Lehrkräfte und Domainadministratoren können alle Kursarbeiten aufrufen.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED
, wenn der anfragende Nutzer keinen Zugriff auf den angeforderten Kurs hat, oder bei Zugriffsfehlern.
INVALID_ARGUMENT
, wenn die Anfrage fehlerhaft ist.
NOT_FOUND
, wenn der angeforderte Kurs nicht existiert.
HTTP-Anfrage
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter |
courseId |
string
Kennung des Kurses. Diese Kennung kann entweder die in Classroom zugewiesene Kennung oder eine alias sein.
|
Abfrageparameter
Parameter |
courseWorkStates[] |
enum (CourseWorkState )
Einschränkung des zurückzugebenden Arbeitsstatus. Es wird nur der übereinstimmende Kurs zurückgegeben. Wenn keine Angabe gemacht wird, werden Elemente mit dem Arbeitsstatus PUBLISHED zurückgegeben.
|
orderBy |
string
Optionale Sortierreihenfolge für Ergebnisse. Eine durch Kommas getrennte Liste von Feldern mit einem optionalen Keyword für die Sortierrichtung. Unterstützte Felder sind updateTime und dueDate . Unterstützte Richtungs-Keywords sind asc und desc . Wenn keine Angabe erfolgt, ist updateTime desc das Standardverhalten. Beispiele: dueDate asc,updateTime desc , updateTime,dueDate desc
|
pageSize |
integer
Die maximale Anzahl der Elemente, die zurückgegeben werden sollen. „0“ oder „nicht angegeben“ bedeutet, dass der Server ein Maximum zuweisen kann. Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen zurück.
|
pageToken |
string
nextPageToken -Wert, der von einem vorherigen list -Aufruf zurückgegeben wurde und angibt, dass die nächste Ergebnisseite zurückgegeben werden soll.
Die list -Anfrage muss ansonsten mit der Anfrage identisch sein, die zu diesem Token geführt hat.
|
previewVersion |
enum (PreviewVersion )
Optional. Die Vorabversion der API. Diese Einstellung muss festgelegt sein, um auf neue API-Funktionen zugreifen zu können, die Entwicklern im Vorabprogramm zur Verfügung gestellt werden.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Antwort beim Auflisten von Kursarbeiten.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
{
"courseWork": [
{
object (CourseWork )
}
],
"nextPageToken": string
} |
Felder |
courseWork[] |
object (CourseWork )
Kurselemente, die der Anfrage entsprechen.
|
nextPageToken |
string
Token, das die nächste Ergebnisseite identifiziert, die zurückgegeben werden soll. Ist das Feld leer, sind keine weiteren Ergebnisse verfügbar.
|
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
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
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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)."]]