Method: courses.studentGroups.list

لیستی از گروه‌های موجود در یک دوره را برمی‌گرداند.

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

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

درخواست HTTP

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

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

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

پارامترها
courseId

string

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

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

پارامترها
pageSize

integer

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

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

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

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