Method: userProfiles.guardians.list

عرض قائمة بالأوصياء المسموح للمستخدم المُقدّم للطلب بالاطّلاع عليها، مع حصرها في الأوصياء الذين يتطابقون مع الطلب

لإدراج الأوصياء لأي طالب يمكن للمستخدم المُقدّم للطلب الاطّلاع على الأوصياء له، استخدِم الحرف الأبجدي - لمعرّف الطالب.

تُرجع هذه الطريقة رموز الأخطاء التالية:

  • PERMISSION_DENIED إذا تم تحديد studentId، ولم يُسمح للمستخدم المُقدّم للطلب بعرض معلومات الأوصياء لهذا الطالب، إذا تم تحديد "-" على أنّه studentId ولم يكن المستخدم مشرف نطاق، إذا لم يتم تفعيل الأوصياء للنطاق المعنيّ، إذا ضبط مستخدم غير مشرف النطاق فلتر invitedEmailAddress، أو أخطاء وصول أخرى.
  • INVALID_ARGUMENT إذا تم تحديد studentId، ولكن لا يمكن التعرّف على تنسيقه (ليس عنوان بريد إلكتروني، ولا studentId من واجهة برمجة التطبيقات، ولا السلسلة الحرفية me). ويمكن أيضًا أن يتم إرجاعه إذا تم تقديم pageToken غير صالح.
  • NOT_FOUND إذا تم تحديد studentId، ويمكن التعرّف على تنسيقه، ولكن لا يتوفّر لدى Classroom سجلّ لهذا الطالب.

طلب HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
studentId

string

فلترة النتائج حسب الطالب المرتبط به الوصي يمكن أن يكون المعرّف واحدًا مما يلي:

  • المعرّف الرقمي للمستخدم
  • عنوان البريد الإلكتروني للمستخدم
  • السلسلة الحرفية "me" التي تشير إلى المستخدم الذي يقدّم الطلب
  • السلسلة الثابتة "-"، التي تشير إلى أنّه يجب عرض النتائج لجميع الطلاب الذين يمكن للمستخدم المُقدّم للطلب الاطّلاع عليهم

مَعلمات طلب البحث

المعلمات
invitedEmailAddress

string

يمكنك فلترة النتائج حسب عنوان البريد الإلكتروني الذي تم إرسال الدعوة الأصلية إليه، ما يؤدي إلى ظهور رابط الوصي هذا. لا يمكن استخدام هذا الفلتر إلا من قِبل مشرفي النطاق.
pageToken

string

قيمة nextPageToken التي تم إرجاعها من طلب list سابق، ما يشير إلى أنّه يجب عرض الصفحة التالية من النتائج.

يجب أن يكون طلب list مطابقًا للطلب الذي أدّى إلى إنشاء هذا الرمز المميّز.
pageSize

integer

الحد الأقصى لعدد العناصر التي سيتم عرضها تشير القيمة صفر أو غير محدّد إلى أنّ الخادم قد يحدّد حدًا أقصى.

قد يعرض الخادم عددًا أقل من العدد المحدّد من النتائج.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

الردّ عند إدراج الأوصياء

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
الحقول
guardians[]

object (Guardian)

تظهر في هذه الصفحة النتائج التي تستوفي المعايير المحدّدة في الطلب.
nextPageToken

string

رمز مميز يحدِّد الصفحة التالية من النتائج التي سيتم عرضها. إذا كان الحقل فارغًا، لن تتوفّر أي نتائج أخرى.

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • 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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.