Verwenden Ihre Nutzer Classroom mit Google Meet? Sehen Sie sich die Apps Script-Kurzanleitung zum Ansehen der Teilnahme von Schülern/Studenten in Google Meet-Kursen an.

Method: courses.aliases.list

Gibt eine Liste der Aliasse für einen Kurs zurück.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der anfragende Nutzer nicht auf den Kurs zugreifen darf oder Fehler auftreten.
  • NOT_FOUND, wenn der Kurs nicht existiert.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

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

Suchparameter

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

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

object (CourseAlias)

Die Kursaliasse.

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.