Eine Ressource für Erziehungsberechtigte steht für einen Nutzer, z. B. einen Elternteil, der Informationen zu den Kursen und Aufgaben eines Schülers erhält. Der Erziehungsberechtigte, der in der Regel kein Mitglied der Classroom-Domain des Schülers oder Studenten 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 erhält dann eine E-Mail, in der er aufgefordert wird, 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 annehmen kann.
Solange die Einladung den Status PENDING hat, kann der Nutzer sie annehmen. Dadurch wird eine Erziehungsberechtigte-Ressource erstellt und die GuardianInvitation wird mit dem Status COMPLETED gekennzeichnet. Eine Einladung kann auch den Status COMPLETED erhalten, wenn sie abläuft oder ein autorisierter Nutzer sie storniert (z. B. mit der Methode PatchGuardianInvitation). Eine Erziehungsberechtigte-Beziehung kann auch von einem Erziehungsberechtigten, einer Classroom-Lehrkraft oder einem Administrator über die Classroom-Benutzeroberfläche oder die DeleteGuardian-Methode aufgehoben werden.
Wer darf Erziehungsberechtigte verwalten?
In der folgenden Tabelle werden die Aktionen beschrieben, die je nach Nutzertyp ausgeführt werden können:
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.
- Unter https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly können Sie Erziehungsberechtigte und Erziehungsberechtigteinladungen für Schüler und Studenten aufrufen, die der Nutzer unterrichtet oder verwaltet.
- Mit https://www.googleapis.com/auth/classroom.guardianlinks.students können Sie Erziehungsberechtigte und Erziehungsberechtigteinladungen für Schüler und Studenten ansehen und ändern, die der Nutzer unterrichtet oder verwaltet.
Häufige Aktionen
In diesem Abschnitt werden einige der gängigen Aktionen von Erziehungsberechtigten beschrieben, die Sie mit der Google Classroom API ausführen können.
Einladung für Erziehungsberechtigten erstellen
Das folgende Beispiel zeigt, wie Sie mit der Methode userProfiles.guardianInvitations.create() eine Einladung für einen Erziehungsberechtigten erstellen:
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, die sich auf die GuardianInvitation beziehen lässt.
Einladung eines Erziehungsberechtigten zurücknehmen
Wenn Sie eine Einladung stornieren möchten, ändern Sie den Status der Einladung von PENDING in COMPLETE, indem Sie die Methode userProfiles.guardianInvitations.patch() aufrufen.
Das ist derzeit 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 oder 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 im Status COMPLETED abrufen, indem Sie einen Parameter für den Status angeben.
Aktive Erziehungsberechtigte auflisten
Wenn Sie herausfinden möchten, welche Nutzer die Erziehungsberechtigten eines bestimmten Schülers sind, können Sie die Methode userProfiles.guardians.list() verwenden. 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 oder Studenten entfernen:
Java
Python
service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
guardianId='guardian@gmail.com').execute()