Method: courses.announcements.list

فهرستی از اعلان‌هایی را برمی‌گرداند که درخواست‌کننده مجاز به مشاهده آن‌ها هستند.

دانشجویان دوره فقط می توانند اطلاعیه های PUBLISHED را مشاهده کنند. معلمان دوره و مدیران دامنه می توانند همه اعلامیه ها را مشاهده کنند.

این روش کدهای خطای زیر را برمی گرداند:

  • اگر کاربر درخواست کننده اجازه دسترسی به دوره درخواستی یا خطاهای دسترسی را نداشته باشد، PERMISSION_DENIED .
  • اگر درخواست نادرست باشد INVALID_ARGUMENT .
  • اگر دوره درخواستی وجود نداشته باشد، NOT_FOUND .

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.