Method: courses.topics.list

تعرض قائمة المواضيع التي يُسمح لمقدّم الطلب بالاطّلاع عليها.

تعرض هذه الطريقة رموز الخطأ التالية:

  • PERMISSION_DENIED إذا لم يكن مسموحًا للمستخدم الذي قدّم الطلب بالوصول إلى الدورة التدريبية المطلوبة أو بسبب أخطاء في الوصول.
  • INVALID_ARGUMENT إذا كان الطلب مكتوبًا بشكلٍ غير صحيح.
  • NOT_FOUND إذا لم تكن الدورة التدريبية المطلوبة متوفّرة.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
courseId

string

معرّف الدورة التدريبية. ويمكن أن يكون هذا المعرّف إمّا المعرّف الذي حدّده Classroom أو alias.

معلمات طلب البحث

المَعلمات
pageSize

integer

الحدّ الأقصى لعدد السلع المطلوب إرجاعها يشير الخيار "صفر" أو "غير محدّد" إلى أنّ الخادم قد يعيّن حدًّا أقصى.

قد يعرض الخادم عددًا أقل من عدد النتائج المحدّد.
pageToken

string

تم عرض قيمة nextPageToken من استدعاء list سابق، للإشارة إلى أنه يجب عرض صفحة النتائج اللاحقة.

ويجب أن يكون طلب list مطابقًا للطلب الذي أدى إلى إنشاء هذا الرمز المميّز.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

الرد عند إدراج المواضيع.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "topic": [
    {
      object (Topic)
    }
  ],
  "nextPageToken": string
}
الحقول
topic[]

object (Topic)

عناصر الموضوع التي تطابق الطلب
nextPageToken

string

رمز مميز يحدد الصفحة التالية من النتائج المطلوب عرضها إذا كان هذا الحقل فارغًا، لن يتم توفير أي نتائج أخرى.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، راجِع دليل التفويض.