تتوفّر الآن إضافات Google Classroom بشكل عام للمطوّرين. يُرجى الاطّلاع على مستندات الإضافات للحصول على مزيد من المعلومات.

تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Method: invitations.list

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

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

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

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` رمز مميز يحدِّد الصفحة التالية من النتائج التي سيتم عرضها. إذا كان الحقل فارغًا، لن تتوفّر أي نتائج أخرى.

invitations[]

object (Invitation)

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

nextPageToken

string

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

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

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