Method: courses.list

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

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

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

درخواست HTTP

GET https://classroom.googleapis.com/v1/courses

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

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

پارامترها
studentId

string

دوره های برگشتی را به کسانی که دانش آموزی با شناسه مشخص شده دارند محدود می کند. شناسه می تواند یکی از موارد زیر باشد:

  • شناسه عددی برای کاربر
  • آدرس ایمیل کاربر
  • رشته تحت اللفظی "me" که کاربر درخواست کننده را نشان می دهد
teacherId

string

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

  • شناسه عددی برای کاربر
  • آدرس ایمیل کاربر
  • رشته تحت اللفظی "me" که کاربر درخواست کننده را نشان می دهد
courseStates[]

enum ( CourseState )

دوره های برگشتی را به دوره های در یکی از حالت های مشخص شده محدود می کند. مقدار پیش فرض ACTIVE، ARCHIVED، PROVISIONED، DECLINED است.

pageSize

integer

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

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

pageToken

string

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

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

درخواست بدن

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

بدن پاسخگو

پاسخ هنگام فهرست کردن دوره ها.

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

نمایندگی JSON 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
فیلدها
courses[]

object ( Course )

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

nextPageToken

string

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

محدوده مجوز

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

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

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