Method: courses.students.list

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

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

درخواست HTTP

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

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

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

پارامترها
courseId

string

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

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

پارامترها
pageSize

integer

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

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

pageToken

string

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

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

درخواست بدن

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

بدن پاسخگو

پاسخ هنگام ثبت نام دانش آموزان

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

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

object ( Student )

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

nextPageToken

string

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

محدوده مجوز

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

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

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