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

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