Method: courses.announcements.list

تعرض قائمة بالإعلانات التي يُسمح لمقدِّم الطلب بالاطّلاع عليها.

يمكن لطلاب الدورة التدريبية عرض إشعارات PUBLISHED فقط. يمكن لمعلّمي الدورة التدريبية ومشرفي النطاق الاطّلاع على جميع الإشعارات.

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

  • PERMISSION_DENIED، إذا لم يكن المستخدم الذي قدّم الطلب مسموحًا له بالوصول إلى الدورة التدريبية المطلوبة أو إذا كان هناك أخطاء في الوصول
  • INVALID_ARGUMENT إذا كان الطلب مكتوبًا بصيغة غير صحيحة.
  • NOT_FOUND إذا لم تكن الدورة التدريبية المطلوبة متوفّرة.

طلب HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements

يستخدم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
courseId

string

تمثّل هذه السمة معرّف الدورة التدريبية. يمكن أن يكون هذا المعرّف إما المعرّف الذي ضبطه في Classroom أو alias.

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

المَعلمات
announcementStates[]

enum (AnnouncementState)

هناك قيود مفروضة على state من الإشعارات المعروضة. إذا لم يتم تحديد هذه الوسيطة، تكون القيمة التلقائية PUBLISHED.
orderBy

string

ترتيب اختياري للنتائج قائمة حقول مفصولة بفواصل مع كلمة رئيسية اختيارية لتوجيه الترتيب. الحقل المتوافق هو updateTime. الكلمات الرئيسية المسموح بها للاتجاهات هما asc وdesc. إذا لم يتم تحديد ذلك، سيكون updateTime desc هو السلوك التلقائي. أمثلة: updateTime asc وupdateTime
pageSize

integer

الحدّ الأقصى لعدد السلع المطلوب إرجاعها تشير القيمة "صفر" أو "غير محدّد" إلى أنّ الخادم قد يعيّن حدًّا أقصى.

قد يعرض الخادم نتائج أقل من العدد المحدّد من النتائج.
pageToken

string

تم عرض قيمة nextPageToken من استدعاء list سابق، ما يعني أنّه يجب عرض صفحة النتائج اللاحقة.

ويجب أن يكون طلب list مطابقًا للطلب الذي نتج عنه هذا الرمز المميّز.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

الرد عند إدراج عمل الدورة التدريبية.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
الحقول
announcements[]

object (Announcement)

الإعلان عن العناصر التي تطابق الطلب.
nextPageToken

string

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

نطاقات التفويض

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

  • https://www.googleapis.com/auth/classroom.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

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