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

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