تعرض قائمة بالدعوات التي يُسمح للمستخدم مقدم الطلب بعرضها، وتقتصر على تلك التي تطابق طلب القائمة.
ملاحظة: يجب تقديم سمة واحدة على الأقل من userId
أو courseId
. يمكن تقديم كلا الحقلَين.
تعرض هذه الطريقة رموز الخطأ التالية:
PERMISSION_DENIED
في ما يتعلق بأخطاء الوصول.
طلب HTTP
GET https://classroom.googleapis.com/v1/invitations
يستخدم عنوان URL بنية تحويل ترميز gRPC.
معلمات طلب البحث
المَعلمات | |
---|---|
userId |
يعمل هذا الخيار على قصر الدعوات التي يتم عرضها على تلك الدعوات الخاصة بمستخدم محدّد. يمكن أن يكون المعرّف واحدًا مما يلي:
|
courseId |
يعمل هذا الخيار على قصر الدعوات التي تم عرضها على الدعوات الخاصة بدورة تدريبية ذات المعرّف المحدّد. |
pageSize |
الحدّ الأقصى لعدد السلع المطلوب إرجاعها وتكون القيمة التلقائية 500 إذا لم يتم تحديدها أو إذا كانت قد يعرض الخادم نتائج أقل من العدد المحدّد من النتائج. |
pageToken |
تم عرض قيمة ويجب أن يكون طلب |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
الرد عند إدراج الدعوات.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"invitations": [
{
object ( |
الحقول | |
---|---|
invitations[] |
هي الدعوات التي تتطابق مع طلب القائمة. |
nextPageToken |
رمز مميز يحدّد الصفحة التالية من النتائج المطلوب عرضها إذا كان هذا الحقل فارغًا، لن تتوفّر أي نتائج أخرى. |
نطاقات التفويض
يتطلب استخدام أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
لمزيد من المعلومات، يُرجى الاطِّلاع على دليل التفويض.