Method: courses.courseWorkMaterials.list

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

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

این متد کدهای خطای زیر را برمی‌گرداند:

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

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
courseId

string

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

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

پارامترها
courseWorkMaterialStates[]

enum ( CourseWorkMaterialState )

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

orderBy

string

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

pageSize

integer

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

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

pageToken

string

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

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

materialDriveId

string

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

previewVersion

enum ( PreviewVersion )

اختیاری. نسخه پیش‌نمایش API. این گزینه باید تنظیم شود تا بتوان به قابلیت‌های جدید API که در برنامه پیش‌نمایش در اختیار توسعه‌دهندگان قرار گرفته است، دسترسی پیدا کرد.

درخواست بدنه

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

بدنه پاسخ

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

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

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

object ( CourseWorkMaterial )

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

nextPageToken

string

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

دامنه‌های مجوز

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

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

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