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: userProfiles.guardianInvitations.list

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

Gibt eine Liste der Einladungen von Erziehungsberechtigten zurück, die der anfragende Nutzer ansehen darf. Diese Liste ist nach den angegebenen Parametern gefiltert.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn ein studentId angegeben ist und der anfragende Nutzer keine Einladungen für Erziehungsberechtigte für diesen Schüler oder Student sehen darf, wenn "-" als studentId angegeben wurde und der Nutzer kein Domainadministrator ist, Wenn Erziehungsberechtigte für die betreffende Domain nicht aktiviert sind oder wenn andere Zugriffsfehler auftreten
  • INVALID_ARGUMENT, wenn ein studentId angegeben wird, sein Format jedoch nicht erkannt wird (es ist weder eine E-Mail-Adresse noch ein studentId-Wert aus der API oder der Literalstring me). Kann auch zurückgegeben werden, wenn eine ungültige pageToken oder eine state angegeben wurde.
  • NOT_FOUND, wenn eine studentId angegeben und ihr Format erkannt wird. Classroom hat aber keine Informationen zu diesem Schüler/Studenten.

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
studentId

string

ID des Schülers/Studenten, dessen Einladungen von Erziehungsberechtigten zurückgegeben werden sollen. 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
  • Das Stringliteral "-" gibt an, dass Ergebnisse für alle Kursteilnehmer zurückgegeben werden sollen, die den anfragenden Nutzer berechtigt haben, Erziehungsberechtigte Einladungen aufzurufen.

Suchparameter

Parameter
invitedEmailAddress

string

Wenn angegeben, werden nur Ergebnisse mit der angegebenen invitedEmailAddress zurückgegeben.

states[]

enum (GuardianInvitationState)

Wenn angegeben, werden nur Ergebnisse mit den angegebenen state-Werten zurückgegeben. Andernfalls werden Ergebnisse mit einer state von PENDING zurückgegeben.

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.

pageSize

integer

Maximale Anzahl der Artikel, die zurückgegeben werden sollen. Null oder keine Angabe gibt an, dass der Server ein Maximum zuweisen kann.

Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen zurück.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

Antwort beim Auflisten von Einladungen für Erziehungsberechtigte.

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

object (GuardianInvitation)

Einladungen für Erziehungsberechtigte, die mit der Listenanfrage übereinstimmen.

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.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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