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 sortiert, wobei der zuletzt erstellte Kurs zuerst angezeigt wird.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED für Zugriffsfehler.
  • INVALID_ARGUMENT, wenn das Abfrageargument fehlerhaft ist.
  • NOT_FOUND, wenn einer der in den Abfrageargumenten angegebenen Nutzer nicht vorhanden ist.

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 mit der angegebenen ID. Die ID kann eine der folgenden sein:

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

Wenn angegeben, muss teacherId leer sein.
teacherId

string

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

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

Wenn angegeben, muss studentId leer sein.
courseStates[]

enum (CourseState)

Beschränkt die zurückgegebenen Kurse auf Kurse in einem der angegebenen Status. Der Standardwert ist ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
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 die angegebene Anzahl zurück.
pageToken

string

Der Wert nextPageToken, der von einem vorherigen list-Aufruf zurückgegeben wurde und angibt, dass die nächste Seite mit Ergebnissen 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 Seite mit Ergebnissen angibt, die zurückgegeben werden sollen. Wenn 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 Autorisierungsleitfaden.