Method: courses.list

Gibt eine Liste der Kurse zurück, die der anfragende Nutzer ansehen darf, beschränkt auf die Kurse, die der Anfrage entsprechen. Zurückgegebene Kurse werden nach Erstellungszeit sortiert, wobei die zuletzt erstellten Kurse an erster Stelle stehen.

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 Kurse mit einem Schüler/Studenten mit der angegebenen ID. Folgende Kennzeichnungen sind möglich:

  • die numerische Kennung für den Nutzer,
  • 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 einer Lehrkraft mit der angegebenen ID. Folgende Kennzeichnungen sind möglich:

  • die numerische Kennung für den Nutzer,
  • die E-Mail-Adresse des Nutzers
  • Das Stringliteral "me", das den anfragenden Nutzer angibt
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 Elemente, die zurückgegeben werden sollen. Null oder nicht angegeben bedeutet, dass der Server einen Höchstwert 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. Dieser Wert gibt an, dass die nachfolgende 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 Leitfaden zur Autorisierung.