Method: courses.aliases.list

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

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

  • PERMISSION_DENIED اگر کاربر درخواست کننده اجازه دسترسی به دوره یا خطاهای دسترسی را نداشته باشد.
  • NOT_FOUND اگر دوره وجود نداشته باشد.

درخواست HTTP

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

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

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

پارامترها
courseId

string

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

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

پارامترها
pageSize

integer

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

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

pageToken

string

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

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

درخواست بدن

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

بدن پاسخگو

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

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

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

object ( CourseAlias )

نام مستعار دوره

nextPageToken

string

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

محدوده مجوز

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

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

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