يمثل مورد الأوصياء مستخدمًا، مثل أحد الوالدين، الذي يتلقى معلومات حول الدورات التدريبية والأعمال للطالب. يجب دعوة الوصي، الذي لا يكون عادةً عضوًا في نطاق Classroom للطالب، باستخدام عنوان بريده الإلكتروني ليصبح وصيًا.
تؤدي هذه الدعوة إلى إنشاء
مورد الأوصياء
بحالة PENDING
. يتلقى المستخدم بعد ذلك رسالة إلكترونية تطالبه بقبول الدعوة. إذا لم يكن عنوان البريد الإلكتروني مرتبطًا بحساب في Google،
فسيُطلب من المستخدم إنشاء حساب قبل قبول الدعوة.
على الرغم من أنّ حالة الدعوة هي PENDING
، قد يقبل المستخدم الدعوة، ما يؤدي إلى إنشاء مورد "الوصي" وتمييز "دعوة الوصي" بالحالة 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.
إنشاء دعوة وصي
يوضّح المثال التالي كيفية إنشاء دعوة وصي باستخدام طريقة 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')))
تتضمن النتيجة معرّفًا يعيّنه الخادم يمكن استخدامه للإشارة إلى GuardianInvite.
إلغاء دعوة الوصي
يوضّح المثال التالي كيفية إلغاء دعوة باستخدام طريقة
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()
سرد الدعوات لطالب معين
يمكنك الحصول على قائمة بجميع الدعوات التي تم إرسالها لطالب معين باستخدام طريقة 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()