Method: invitations.list

Gibt eine Liste der Einladungen zurück, die der anfragende Nutzer ansehen darf, wobei die Einladung auf die Einladungen beschränkt ist, die mit der Listenanfrage übereinstimmen.

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

Zurückgegebene Einladungen werden auf Einladungen für einen bestimmten Nutzer beschränkt. Folgende Kennzeichnungen sind möglich:

  • Numerische Kennung des Nutzers
  • die E-Mail-Adresse des Nutzers
  • das String-Literal "me", das den anfragenden Nutzer angibt
courseId

string

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

integer

Maximale Anzahl der Artikel, die zurückgegeben werden sollen. Wenn kein Wert angegeben oder 0, ist der Standardwert 500.

Der Server gibt möglicherweise weniger Ergebnisse als die angegebene Anzahl zurück.
pageToken

string

nextPageToken-Wert, der von einem vorherigen list-Aufruf zurückgegeben wurde. Dieser gibt an, dass die nachfolgende Ergebnisseite zurückgegeben werden soll.

Die list-Anfrage muss ansonsten mit der Anfrage übereinstimmen, 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 mit der Listenanfrage übereinstimmen.
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.