अभिभावक के लिए संसाधन, किसी ऐसे उपयोगकर्ता को दिखाता है जिसे छात्र/छात्रा के कोर्स और उसके काम की जानकारी मिलती है. जैसे, माता-पिता. अभिभावक, जो आम तौर पर छात्र या छात्रा के Classroom डोमेन का सदस्य नहीं होता है उसे अभिभावक बनने के लिए, अपने ईमेल पते का इस्तेमाल करके न्योता भेजना होगा.
इस न्योते से, PENDING
स्थिति वाला एक GuardianInvitation रिसॉर्स बनता है. इसके बाद, उपयोगकर्ता को एक ईमेल मिलेगा. इसमें उपयोगकर्ता से न्योता स्वीकार करने के लिए कहा जाएगा. अगर ईमेल पता किसी 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 को रेफ़र करने के लिए किया जा सकता है.
अभिभावक के लिए भेजा गया न्योता रद्द करना
किसी न्योते को रद्द करने के लिए, userProfiles.guardianInvitations.patch()
तरीके को कॉल करके, न्योते की स्थिति को PENDING
से COMPLETE
पर बदलें.
ध्यान दें कि न्योता हटाने का यह फ़िलहाल एकमात्र तरीका है.
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()
किसी छात्र/छात्रा को भेजे गए न्योतों की सूची देखना
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
स्थिति में न्योते वापस पाने का विकल्प भी है.
ऐक्टिव अभिभावकों की सूची
अगर आपको यह पता करना है कि किसी छात्र के लिए कौनसे उपयोगकर्ता, ऐक्टिव अभिभावक हैं, तो 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()