Method: userProfiles.guardianInvitations.list

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

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

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

طلب HTTP

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

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

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

المعلمات
studentId

string

رقم تعريف الطالب الذي سيتم عرض دعوات الأوصياء له. يمكن أن يكون المعرّف واحدًا مما يلي:

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

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

المعلمات
invitedEmailAddress

string

في حال تحديدها، يتم عرض النتائج التي تحتوي على invitedEmailAddress المحدّد فقط.
states[]

enum (GuardianInvitationState)

في حال تحديدها، يتم عرض النتائج التي تحتوي على قيم state المحدّدة فقط. بخلاف ذلك، يتم عرض النتائج التي يكون فيها state يساوي PENDING.
pageToken

string

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

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

integer

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

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

نص الطلب

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

نص الاستجابة

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

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

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

object (GuardianInvitation)

دعوات الأوصياء التي تطابقت مع طلب القائمة
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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