Method: invitations.list

Gibt eine Liste der Einladungen zurück, die der anfragende Nutzer sich ansehen darf. Sie ist auf die Einladungen beschränkt, die der Listenanfrage entsprechen.

Hinweis:Es muss mindestens eine der beiden Optionen userId oder courseId angegeben werden. Beide Felder können angegeben werden.

Diese Methode gibt die folgenden Fehlercodes zurück:

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/invitations

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
userId

string

Beschränkt zurückgegebene Einladungen auf Einladungen für einen bestimmten Nutzer. Die Kennung kann eine der folgenden sein:

  • die numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das Stringliteral "me", das den anfragenden Nutzer angibt
courseId

string

Beschränkt die zurückgegebenen Einladungen auf Einladungen für einen Kurs mit der angegebenen Kennung.
pageSize

integer

Die maximale Anzahl der Elemente, die zurückgegeben werden sollen. Der Standardwert ist 500, wenn nicht angegeben, oder 0.

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, wenn Einladungen aufgelistet werden.

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

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

object (Invitation)

Einladungen, die der Listenanfrage entsprechen.
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 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.