Method: courses.list

Gibt eine Liste der Kurse zurück, die der anfragende Nutzer aufrufen darf, beschränkt auf die, die der Anfrage entsprechen. Die zurückgegebenen Kurse werden nach Erstellungszeit sortiert, wobei die zuletzt erstellten zuerst angezeigt werden.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED für Zugriffsfehler.
  • INVALID_ARGUMENT, wenn das Abfrageargument fehlerhaft ist.
  • NOT_FOUND, wenn Nutzer, die in den Abfrageargumenten angegeben sind, nicht vorhanden sind.

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/courses

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
studentId

string

Beschränkt die zurückgegebenen Kurse auf Kurse mit einem Schüler/Studenten mit der angegebenen Kennung. Die Kennung kann eine der folgenden sein:

  • die numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das Stringliteral "me", das den anfragenden Nutzer angibt
teacherId

string

Beschränkt die zurückgegebenen Kurse auf Kurse mit einem Lehrkräften mit der angegebenen Kennung. Die Kennung kann eine der folgenden sein:

  • die numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das Stringliteral "me", das den anfragenden Nutzer angibt
courseStates[]

enum (CourseState)

Die zurückgegebenen Kurse werden auf Kurse mit einem der angegebenen Status beschränkt. Der Standardwert ist „AKTIV“, „ARCHIVIERT“, „Bereitgestellt“ oder „ABGELEHNT“.
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.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort bei der Auflistung von Kursen.

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

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

object (Course)

Kurse, die der Listenanfrage 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.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.