Method: courses.list

Gibt eine Liste der Kurse zurück, die der anfragende Nutzer ansehen darf. Die Liste ist auf die Kurse beschränkt, die der Anfrage entsprechen. Die zurückgegebenen Kurse sind nach Erstellungszeit geordnet, wobei die zuletzt erstellten Kurse 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 in den Abfrageargumenten angegebene Nutzer 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 diejenigen mit einem Schüler/Studenten mit der angegebenen ID. Die Kennung kann einer der folgenden Werte sein:

  • Die numerische Kennung für den Nutzer
  • die E‑Mail-Adresse des Nutzers
  • das Stringliteral "me", das den anfragenden Nutzer angibt

Falls angegeben, muss teacherId leer sein.
teacherId

string

Beschränkt die zurückgegebenen Kurse auf diejenigen mit einem Lehrer mit der angegebenen ID. Die Kennung kann einer der folgenden Werte sein:

  • Die numerische Kennung für den Nutzer
  • die E‑Mail-Adresse des Nutzers
  • das Stringliteral "me", das den anfragenden Nutzer angibt

Falls angegeben, muss studentId leer sein.
courseStates[]

enum (CourseState)

Beschränkt die zurückgegebenen Kurse auf diejenigen, die sich in einem der angegebenen Status befinden. Wenn nicht angegeben, werden Kurse in jedem Status zurückgegeben.
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 als die angegebene Anzahl von Ergebnissen zurück.
pageToken

string

Der 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 beim Auflisten 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. Wenn das Feld leer ist, 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 Autorisierungsleitfaden.