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

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