- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- آن را امتحان کنید!
فهرست موضوعاتی را که درخواست کننده مجاز به مشاهده آنهاست برمی گرداند.
این روش کدهای خطای زیر را برمی گرداند:
- اگر کاربر درخواست کننده اجازه دسترسی به دوره درخواستی یا خطاهای دسترسی را نداشته باشد،
PERMISSION_DENIED
. - اگر درخواست نادرست باشد
INVALID_ARGUMENT
. - اگر دوره درخواستی وجود نداشته باشد،
NOT_FOUND
.
درخواست HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/topics
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها | |
---|---|
course Id | شناسه دوره این شناسه می تواند شناسه اختصاص داده شده توسط Classroom یا |
پارامترهای پرس و جو
پارامترها | |
---|---|
page Size | حداکثر تعداد اقلام برای بازگشت. صفر یا نامشخص نشان می دهد که سرور ممکن است حداکثر را اختصاص دهد. سرور ممکن است کمتر از تعداد مشخص شده نتایج را برگرداند. |
page Token | مقدار در غیر این صورت، درخواست |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
هنگام فهرست کردن موضوعات، پاسخ دهید.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"topic": [
{
object ( |
فیلدها | |
---|---|
topic[] | مواردی که با درخواست مطابقت دارند. |
next Page Token | نشانه شناسایی صفحه بعدی نتایج برای بازگشت. اگر خالی باشد، هیچ نتیجه دیگری در دسترس نیست. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/classroom.topics.readonly
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.