Verwenden Ihre Nutzer Classroom mit Google Meet? Weitere Informationen finden Sie unter Apps Script – Kurzanleitung.

Method: invitations.list

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

Hinweis: Es muss in jedem Fall 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 die Einladungen eines bestimmten Nutzers. Die Kennung kann eine der folgenden sein:

  • 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 Kennung.
pageSize

integer

Maximale Anzahl der Artikel, die zurückgegeben werden sollen. Wenn 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 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 von Einladungen.

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

object (Invitation)

Einladungen, die der Listenanfrage entsprechen
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.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

Weitere Informationen finden Sie in der OAuth 2.0-Übersicht.