Method: courses.topics.list

Gibt die Liste der Themen zurück, die der Anfragende ansehen darf.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der anfragende Nutzer keinen Zugriff auf den angeforderten Kurs hat, oder bei Zugriffsfehlern.
  • INVALID_ARGUMENT, wenn die Anfrage fehlerhaft ist.
  • NOT_FOUND, wenn der angeforderte Kurs nicht existiert.

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/courses/{courseId}/topics

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

Kennung des Kurses. Diese Kennung kann entweder die in Classroom zugewiesene Kennung oder eine alias sein.

Abfrageparameter

Parameter
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 Themen.

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

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

object (Topic)

Themenelemente, die mit der Anfrage übereinstimmen.
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 den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/classroom.topics.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.