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

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