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

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