Method: courses.studentGroups.list

فهرستی از گروه های یک دوره را برمی گرداند.

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

  • NOT_FOUND اگر دوره وجود نداشته باشد.

درخواست HTTP

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

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

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

پارامترها
courseId

string

مورد نیاز. شناسه دوره.

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

پارامترها
pageSize

integer

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

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

pageToken

string

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

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

previewVersion

enum ( PreviewVersion )

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

درخواست بدن

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

بدن پاسخگو

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

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

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

object ( StudentGroup )

گروه های دانشجویی

nextPageToken

string

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

محدوده مجوز

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

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

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