Method: invitations.list

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:

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 diejenigen für einen bestimmten Nutzer. Folgende Kennzeichnungen sind möglich:

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

string

Beschränkt zurückgegebene Einladungen auf diejenigen für einen Kurs mit der angegebenen ID.

pageSize

integer

Maximale Anzahl der Elemente, die zurückgegeben werden sollen. Falls nicht angegeben, ist der Standardwert 500 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. Dieser Wert gibt an, dass die nachfolgende 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 beim Auflisten von Einladungen.

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