Method: courses.topics.list

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

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

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

درخواست HTTP

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

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

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

پارامترها
course Id

string

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

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

پارامترها
page Size

integer

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

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

page Token

string

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

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

درخواست بدن

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

بدن پاسخگو

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

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

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

object ( Topic )

مواردی که با درخواست مطابقت دارند.

next Page Token

string

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

محدوده مجوز

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

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

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