Eine Guardian-Ressource repräsentiert einen Nutzer, beispielsweise einen Elternteil, der Informationen zu den Kursen und Aufgaben eines Schülers erhält. Der Erziehungsberechtigte, der normalerweise kein Mitglied der Classroom-Domain des Schülers ist, muss mit seiner E-Mail-Adresse eingeladen werden, Erziehungsberechtigte zu werden.
Mit dieser Einladung wird eine GuardianInvite resource mit dem Status PENDING erstellt. Der Nutzer erhält dann eine E-Mail mit der Aufforderung, die Einladung anzunehmen. Falls die E-Mail-Adresse nicht mit einem Google-Konto verknüpft ist, wird der Nutzer vor der Annahme der Einladung aufgefordert, eines zu erstellen.
Während die Einladung den Status PENDING hat, kann der Nutzer die Einladung annehmen. Dadurch wird eine Guardian-Ressource erstellt und die Guardian-Einladung mit dem Status COMPLETED gekennzeichnet. 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). Eine Begleiterbeziehung kann auch von einem Erziehungsberechtigten, einer Classroom-Lehrkraft oder einem Administrator über die Classroom-Benutzeroberfläche oder die Methode DeleteGuardian aufgehoben werden.
Wer darf Erziehungsberechtigte verwalten?
In der folgenden Tabelle werden die Aktionen beschrieben, die für Erziehungsberechtigte je nach Art des derzeit authentifizierten Nutzers auszuführen sind:
Ebenen
Es gibt drei Bereiche, mit denen Sie Erziehungsberechtigte verwalten können:
- Mit https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly können Sie sich die Erziehungsberechtigten eines Nutzers ansehen.
- Mit https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly können Sie sich Erziehungsberechtigte und Erziehungsberechtigte für Teilnehmer ansehen, die der Nutzer unterrichtet oder verwaltet.
- Mit https://www.googleapis.com/auth/classroom.guardianlinks.students können Sie Erziehungsberechtigte und Einladungen zu Erziehungsberechtigten, die der Nutzer unterrichtet oder verwaltet, aufrufen und ändern.
Häufige Aktionen
In diesem Abschnitt werden einige gängige Aktionen für Erziehungsberechtigte beschrieben, die Sie möglicherweise mit der Google Classroom API ausführen können.
Erziehungsberechtigte Einladung erstellen
Im folgenden Beispiel wird gezeigt, wie Sie mit der Methode userProfiles.guardianInvitations.create() eine Erziehungsberechtigte Einladung 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, mit der auf die Guardian-Einladung verwiesen werden kann.
Einladung eines Erziehungsberechtigten zurücknehmen
Wenn Sie eine Einladung zurücknehmen möchten, ändern Sie den Status der Einladung von PENDING zu COMPLETE. Rufen Sie dazu die Methode userProfiles.guardianInvitations.patch() auf.
Beachten Sie, dass dies derzeit die einzige Möglichkeit ist, 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 oder Studenten auflisten
Mit der Methode userProfiles.guardianInvitations.list() können Sie eine Liste aller Einladungen abrufen, die für 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 mit dem Status COMPLETED abrufen, indem Sie einen Parameter für den Bundesstaat angeben.
Aktive Erziehungsberechtigte auflisten
Mit der Methode userProfiles.guardians.list() können Sie feststellen, welche Nutzer aktive Erziehungsberechtigte für einen bestimmten Schüler oder Studenten 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 mithilfe der Methode userProfiles.guardians.delete() auch von einem Schüler oder Studenten entfernen:
Java
Python
service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
guardianId='guardian@gmail.com').execute()