Method: invitations.list

تعرض قائمة بالدعوات التي يُسمح للمستخدم مقدّم الطلب بالاطّلاع عليها، مقتصرة على تلك التي تتطابق مع طلب القائمة.

ملاحظة: يجب تقديم سمة واحدة على الأقل من userId أو courseId. يمكن تقديم كلا الحقلين.

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

طلب HTTP

GET https://classroom.googleapis.com/v1/invitations

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

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

المَعلمات
userId

string

يتم تقييد الدعوات التي يتم عرضها لتقتصر على تلك الدعوات لمستخدم معيَّن. يمكن أن يكون المعرّف واحدًا مما يلي:

  • المعرّف الرقمي للمستخدم
  • عنوان البريد الإلكتروني للمستخدم
  • القيمة الحرفية للسلسلة "me"، ما يشير إلى المستخدم الذي قدّم الطلب
courseId

string

لتقييد الدعوات التي يتم عرضها على الدعوات الخاصة بدورة دراسية بالمعرّف المحدّد.
pageSize

integer

الحدّ الأقصى لعدد السلع المطلوب إرجاعها وتكون القيمة التلقائية 500 في حال عدم تحديدها أو 0.

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

string

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

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

نص الطلب

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

نص الاستجابة

الرد عند إدراج الدعوات.

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

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

object (Invitation)

الدعوات التي تطابق طلب القائمة.
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

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