Method: invitations.list

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

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

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

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

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

المعلّمات
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

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