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

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