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

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