Eine Ressource für Erziehungsberechtigte stellt einen Nutzer wie einen Elternteil dar, der Informationen über die Kurse und Arbeiten eines Schülers/Studenten erhält. Der Erziehungsberechtigte, der normalerweise kein Mitglied der Classroom-Domain des Schülers ist, muss über seine E-Mail-Adresse eingeladen werden, um Erziehungsberechtigter zu werden.
Mit dieser Einladung wird eine GuardianInvitation-Ressource mit dem Status PENDING
erstellt. Der Nutzer wird dann per E-Mail aufgefordert, die Einladung anzunehmen. Wenn die E-Mail-Adresse nicht mit einem Google-Konto verknüpft ist, wird der Nutzer aufgefordert, ein Konto zu erstellen, bevor er die Einladung annimmt.
Während die Einladung den Status PENDING
hat, kann der Nutzer die Einladung annehmen. Dadurch wird eine Guardian-Ressource erstellt und Guardian Invitation mit dem Status COMPLETED
markiert. Eine Einladung kann auch zu COMPLETED
werden, wenn sie abläuft oder wenn ein autorisierter Nutzer die Einladung zurückzieht (z. B. mit der Methode PatchGuardianInvitation
). Die Beziehung eines Erziehungsberechtigten kann auch von einem Erziehungsberechtigten, einer Classroom-Lehrkraft oder einem Administrator über die Classroom-Benutzeroberfläche oder die Methode DeleteGuardian
aufgelöst werden.
Wer darf Erziehungsberechtigte verwalten?
In der folgenden Tabelle werden die Aktionen beschrieben, die für Erziehungsberechtigte ausgeführt werden können, je nach aktuell authentifiziertem Nutzertyp:
Ebenen
Es gibt drei Bereiche, in denen Sie Erziehungsberechtigte verwalten können:
- Mit https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly können Sie die eigenen Erziehungsberechtigten eines Nutzers aufrufen.
- https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly ermöglicht Ihnen, Guardians und Guardian Invitations für Schüler/Studenten aufzurufen, die der Nutzer unterrichtet oder verwaltet.
- Mit https://www.googleapis.com/auth/classroom.guardianlinks.students können Sie Guardians und Guardian Invitations für Schüler abrufen und bearbeiten, die vom Nutzer unterrichtet oder verwaltet werden.
Häufige Aktionen
In diesem Abschnitt werden einige gängige Aktionen für Erziehungsberechtigte beschrieben, die Sie mit der Google Classroom API ausführen können.
Einladung für Erziehungsberechtigte erstellen
Das folgende Beispiel zeigt, wie Sie mit der Methode userProfiles.guardianInvitations.create()
eine Einladung für Erziehungsberechtigte erstellen können:
Java
Python
guardianInvitation = {
'invitedEmailAddress': 'guardian@gmail.com',
}
guardianInvitation = service.userProfiles().guardianInvitations().create(
studentId='student@mydomain.edu',
body=guardianInvitation).execute()
print("Invitation created with id: {0}".format(guardianInvitation.get('invitationId')))
Das Ergebnis enthält eine vom Server zugewiesene Kennung, mit der auf die GuardianInvitation verwiesen werden kann.
Einladung eines Erziehungsberechtigten zurücknehmen
Wenn Sie eine Einladung zurücknehmen möchten, ändern Sie den Status der Einladung von PENDING
in COMPLETE
. Rufen Sie dazu die Methode userProfiles.guardianInvitations.patch()
auf.
Derzeit ist dies die einzige Möglichkeit, eine Einladung zu entfernen.
Java
Python
guardian_invite = {
'state': 'COMPLETE'
}
guardianInvitation = service.userProfiles().guardianInvitations().patch(
studentId='student@mydomain.edu',
invitationId=1234, # Replace with the invitation ID of the invitation you want to cancel
updateMask='state',
body=guardianInvitation).execute()
Einladungen für einen bestimmten Schüler/Studenten auflisten
Mit der Methode userProfiles.guardianInvitations.list()
können Sie eine Liste aller Einladungen abrufen, die an einen bestimmten Schüler/Studenten gesendet wurden:
Java
Python
guardian_invites = []
page_token = None
while True:
response = service.userProfiles().guardianInvitations().list(
studentId='student@mydomain.edu').execute()
guardian_invites.extend(response.get('guardian_invites', []))
page_token = response.get('nextPageToken', None)
if not page_token:
break
if not courses:
print('No guardians invited for this {0}.'.format(response.get('studentId')))
else:
print('Guardian Invite:')
for guardian in guardian_invites:
print('An invite was sent to '.format(guardian.get('id'),
guardian.get('guardianId')))
Standardmäßig werden nur PENDING
Einladungen zurückgegeben. Als Domainadministrator können Sie auch Einladungen mit dem Status COMPLETED
abrufen, indem Sie einen Statusparameter angeben.
Aktive Erziehungsberechtigte auflisten
Mit der Methode userProfiles.guardians.list()
können Sie ermitteln, welche Nutzer aktive Erziehungsberechtigte für einen bestimmten Schüler sind. Aktive Erziehungsberechtigte sind Erziehungsberechtigte, die die E-Mail-Einladung angenommen haben.
Java
Python
guardian_invites = []
page_token = None
while True:
response = service.userProfiles().guardians().list(studentId='student@mydomain.edu').execute()
guardian_invites.extend(response.get('guardian_invites', []))
page_token = response.get('nextPageToken', None)
if not page_token:
break
if not courses:
print('No guardians invited for this {0}.'.format(response.get('studentId')))
else:
print('Guardian Invite:')
for guardian in guardian_invites:
print('An invite was sent to '.format(guardian.get('id'),
guardian.get('guardianId')))
Erziehungsberechtigte entfernen
Sie können einen Erziehungsberechtigten auch mit der Methode userProfiles.guardians.delete()
von einem Schüler entfernen:
Java
Python
service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
guardianId='guardian@gmail.com').execute()