Verwenden Ihre Nutzer Classroom mit Google Meet? Sehen Sie sich die Apps Script-Kurzanleitung zum Ansehen der Teilnahme von Schülern/Studenten in Google Meet-Kursen an.

Method: invitations.list

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

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

Hinweis: Es muss in jedem Fall entweder userId oder courseId angegeben werden. Beide Felder können ausgefüllt 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änkte Rückgaben auf Einladungen für einen bestimmten Nutzer. 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 die zurückgegebenen Einladungen auf einen Kurs mit der angegebenen ID.

pageSize

integer

Maximale Anzahl der zurückzugebenden Elemente. 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. Damit wird angegeben, dass die folgende 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

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 mit der Listenanfrage übereinstimmen.

nextPageToken

string

Token, das die nächste Ergebnisseite angibt. 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 Übersicht zu OAuth 2.0.