Method: courses.courseWorkMaterials.list

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

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

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

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

درخواست HTTP

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

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

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

پارامترها
course Id

string

شناسه دوره این شناسه می تواند شناسه اختصاص داده شده توسط Classroom یا alias باشد.

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

پارامترها
course Work Material States[]

enum ( CourseWorkMaterialState )

محدودیت در وضعیت کار برای بازگشت. فقط مطالب کار دوره ای که مطابقت داشته باشد برگردانده می شود. اگر مشخص نشده باشد، مواردی با وضعیت کاری PUBLISHED برگردانده می شوند.

order By

string

مرتب سازی اختیاری برای نتایج. فهرستی از فیلدهای جدا شده با کاما با کلمه کلیدی جهت مرتب سازی اختیاری. فیلد پشتیبانی شده updateTime است. کلمات کلیدی جهت پشتیبانی شده asc و desc هستند. اگر مشخص نشده باشد، updateTime desc رفتار پیش‌فرض است. مثال‌ها: updateTime asc ، updateTime

page Size

integer

حداکثر تعداد اقلام برای بازگشت. صفر یا نامشخص نشان می دهد که سرور ممکن است حداکثر را اختصاص دهد.

سرور ممکن است کمتر از تعداد مشخص شده نتایج را برگرداند.

page Token

string

مقدار nextPageToken برگردانده شده از فراخوانی list قبلی، نشان می دهد که صفحه بعدی نتایج باید برگردانده شود.

در غیر این صورت، درخواست list باید با درخواستی که منجر به این نشانه شده است، یکسان باشد.

material Drive Id

string

فیلتر اختیاری برای مطالب کار دوره با حداقل یک ماده Drive که شناسه آن با رشته ارائه شده مطابقت دارد. اگر materialLink نیز مشخص شده باشد، مواد کار دوره باید دارای موادی باشد که با هر دو فیلتر مطابقت دارند.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

هنگام فهرست کردن مطالب کار دوره، پاسخ دهید.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "courseWorkMaterial": [
    {
      object (CourseWorkMaterial)
    }
  ],
  "nextPageToken": string
}
فیلدها
course Work Material[]

object ( CourseWorkMaterial )

اقلام مواد کار دوره که با درخواست مطابقت دارد.

next Page Token

string

نشانه شناسایی صفحه بعدی نتایج برای بازگشت. اگر خالی باشد، هیچ نتیجه دیگری در دسترس نیست.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

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