Gibt eine Liste der Einladungen zurück, die der anfragende Nutzer anzeigen darf, beschränkt auf diejenigen, die der Listenanfrage entsprechen.
Hinweis:Es muss entweder userId
oder courseId
angegeben werden. Beide Felder können angegeben werden.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED
für Zugriffsfehler.
HTTP-Anfrage
GET https://classroom.googleapis.com/v1/invitations
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
Parameter | |
---|---|
userId |
Beschränkt zurückgegebene Einladungen auf diejenigen für einen bestimmten Nutzer. Folgende Kennzeichnungen sind möglich:
|
courseId |
Beschränkt zurückgegebene Einladungen auf diejenigen für einen Kurs mit der angegebenen ID. |
pageSize |
Maximale Anzahl der Elemente, die zurückgegeben werden sollen. Falls nicht angegeben, ist der Standardwert 500 oder Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen zurück. |
pageToken |
Die |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Antwort beim Auflisten von Einladungen.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{
"invitations": [
{
object ( |
Felder | |
---|---|
invitations[] |
Einladungen, die der Listenanfrage entsprechen. |
nextPageToken |
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.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.