Verwenden Ihre Nutzer Classroom mit Google Meet? Weitere Informationen finden Sie unter Apps Script – Kurzanleitung.

Method: courses.list

Gibt eine Liste der Kurse zurück, die der anfragende Nutzer ansehen darf. Sie sind auf die Kurse beschränkt, die der Anfrage entsprechen. Die zurückgegebenen Kurse sind nach Erstellungszeitpunkt sortiert, wobei der aktuellste zuerst erscheint.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED für Zugriffsfehler.
  • INVALID_ARGUMENT, wenn das Abfrageargument fehlerhaft ist.
  • NOT_FOUND, wenn keine in den Abfrageargumenten angegebenen Nutzer 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 Kurse, die zurückgegeben wurden, auf Schüler und Studenten, die eine bestimmte ID haben. Die Kennung kann eine der folgenden sein:

  • 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 Kurse, die zurückgegeben wurden, auf diejenigen, die eine Lehrkraft mit der angegebenen Kennung haben. Die Kennung kann eine der folgenden sein:

  • 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 die Kurse in einem der angegebenen Zustände. Der Standardwert ist AKTIV, ARCHIVED, PROVISIONED, DECLINED.

pageSize

integer

Maximale Anzahl der Artikel, die zurückgegeben werden sollen. Null oder keine Angabe gibt an, 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 aus einem vorherigen list-Aufruf, der angibt, dass die nachfolgende Ergebnisseite zurückgegeben werden soll.

Die Anfrage list muss ansonsten mit der Anfrage identisch sein, die zu diesem Token geführt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

Antwort beim Auflisten der Kurse.

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

object (Course)

Kurse, die der Listenanfrage entsprechen.

nextPageToken

string

Token, das die nächste Ergebnisseite angibt, 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 in der OAuth 2.0-Übersicht.