Method: courses.list

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

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

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

درخواست HTTP

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

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

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

پارامترها
studentId

string

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

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

در صورت مشخص شدن، teacherId باید خالی باشد.

teacherId

string

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

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

در صورت مشخص شدن، studentId باید خالی باشد.

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

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