Method: courses.courseWorkMaterials.list

Gibt eine Liste mit Kursmaterialien zurück, die der Anfragende ansehen darf.

Kursteilnehmer können nur PUBLISHED-Kursmaterialien ansehen. Kurslehrer und Domainadministratoren können alle Kursmaterialien ansehen.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der anfragende Nutzer nicht auf den angeforderten Kurs zugreifen darf oder bei Zugriffsfehlern.
  • INVALID_ARGUMENT, wenn die Anfrage fehlerhaft ist.
  • NOT_FOUND, wenn der angeforderte Kurs nicht vorhanden ist.

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

Kennung des Kurses. Diese Kennung kann entweder die von Classroom zugewiesene Kennung oder ein alias sein.

Suchparameter

Parameter
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

Beschränkung des zurückzugebenden Arbeitsstatus. Es werden nur Kursmaterialien zurückgegeben, die übereinstimmen. Wenn nicht angegeben, 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 Schlüsselwort für die Sortierrichtung. Das unterstützte Feld ist updateTime. Die unterstützten Schlüsselwörter für die Richtung sind asc und desc. Wenn nichts angegeben ist, ist updateTime desc das Standardverhalten. Beispiele: updateTime asc, updateTime
pageSize

integer

Maximale Anzahl der zurückzugebenden Elemente. Wenn der Wert 0 oder nicht angegeben ist, kann der Server ein Maximum zuweisen.

Der Server gibt möglicherweise weniger Ergebnisse als angegeben zurück.
pageToken

string

Wert nextPageToken, 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.
materialDriveId

string

Optionale Filterung nach Kursmaterialien mit mindestens einem Drive-Material, dessen ID mit dem angegebenen String übereinstimmt. Wenn auch materialLink angegeben ist, müssen die Kursmaterialien Materialien enthalten, die beiden Filtern entsprechen.
previewVersion

enum (PreviewVersion)

Optional. Die Preview-Version der API. Diese Option muss festgelegt werden, um auf neue API-Funktionen zuzugreifen, die Entwicklern im Vorschauprogramm zur Verfügung stehen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort beim Auflisten von Kursmaterialien.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "courseWorkMaterial": [
    {
      object (CourseWorkMaterial)
    }
  ],
  "nextPageToken": string
}
Felder
courseWorkMaterial[]

object (CourseWorkMaterial)

Kursmaterialien, die der Anfrage entsprechen.
nextPageToken

string

Token, das die nächste Ergebnisseite angibt, die zurückgegeben werden soll. Wenn leer, sind keine weiteren Ergebnisse verfügbar.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/classroom.courseworkmaterials
  • https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.