משאב של אפוטרופוס מייצג משתמש, כמו הורה, שמקבל מידע על הקורסים והעבודות של התלמיד/ה. כדי להפוך לאפוטרופוס, צריך להזמין את האפוטרופוס באמצעות כתובת האימייל שלו. בדרך כלל, האפוטרופוס לא נכלל בדומיין Classroom של התלמיד או התלמידה.
ההזמנה הזו יוצרת משאב GuardianInvitation עם המצב PENDING
. לאחר מכן, המשתמש יקבל אימייל עם בקשה לאשר את ההזמנה. אם כתובת האימייל לא משויכת לחשבון Google, המשתמש יתבקש ליצור חשבון לפני שיתקבל את ההזמנה.
כשהסטטוס של ההזמנה הוא PENDING
, המשתמש יכול לאשר אותה. הפעולה הזו יוצרת משאב של Guardian ומסמנת את GuardianInvitation בסטטוס COMPLETED
. סטטוס ההזמנה עשוי להשתנות ל-COMPLETED
גם אם התוקף שלה פג, או אם משתמש מורשה ביטל אותה (לדוגמה, באמצעות השיטה PatchGuardianInvitation
). הורה, מורה ב-Classroom או אדמין יכולים גם לבטל את הקשר עם האפוטרופוס באמצעות ממשק המשתמש של Classroom או באמצעות השיטה DeleteGuardian
.
מי יכול לנהל את האפוטרופוסים?
בטבלה הבאה מפורטות הפעולות שאפשר לבצע ביחס לאפוטרופסים, בהתאם לסוג המשתמש המאומת:
טווחים
יש שלוש רמות הרשאה לניהול הורים ואפוטרופסים:
- בדף https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly אפשר לראות את האפוטרופוסים של המשתמש.
- https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly מאפשרת להציג את רשימת המשגיחים ואת ההזמנות למשגיחים של תלמידים שהמשתמש מלמד או מנהל.
- https://www.googleapis.com/auth/classroom.guardianlinks.students מאפשרת להציג ולשנות את המשגיחים ואת ההזמנות למשגיחים של תלמידים שהמשתמש מלמד או מנהל.
פעולות נפוצות
בקטע הזה מתוארות חלק מהפעולות הנפוצות שיכולים לבצע הורים ואפוטרופוסים באמצעות Google Classroom API.
יצירת הזמנה להורה או לאפוטרופוס
בדוגמה הבאה מוסבר איך יוצרים הזמנה להורה או למבוגר אחראי באמצעות השיטה userProfiles.guardianInvitations.create()
:
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')))
התוצאה כוללת מזהה שהוקצה על ידי השרת, שאפשר להשתמש בו כדי להפנות אל GuardianInvitation.
ביטול ההזמנה של האפוטרופוס
כדי לבטל הזמנה, משנים את המצב שלה מ-PENDING
ל-COMPLETE
באמצעות קריאה ל-method userProfiles.guardianInvitations.patch()
.
חשוב לזכור שזו הדרך היחידה להסיר הזמנה כרגע.
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()
הצגת רשימת ההזמנות לתלמידים ספציפיים
אתם יכולים לראות את רשימת כל ההזמנות שנשלחו לתלמיד/ה מסוים באמצעות method userProfiles.guardianInvitations.list()
:
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')))
כברירת מחדל, יוחזרו רק PENDING
הזמנות. מנהלי דומיינים יכולים גם לאחזר הזמנות בסטטוס COMPLETED
על ידי ציון פרמטר states.
הצגת רשימה של אפוטרופסים פעילים
כדי לקבוע אילו משתמשים יהיו אפוטרופוסים פעילים של תלמיד/ה מסוים, תוכלו להשתמש בשיטה userProfiles.guardians.list()
. אפוטרופוסים פעילים הם אפוטרופוסים שקיבלו אישור להזמנה באימייל.
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')))
הסרת אפוטרופסים
אפשר גם להסיר הורה או אפוטרופוס מתלמיד/ה באמצעות השיטה userProfiles.guardians.delete()
:
Java
Python
service.userProfiles().guardians().delete(studentId='student@mydomain.edu',
guardianId='guardian@gmail.com').execute()