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

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