Method: courses.aliases.list

لعرض قائمة بالأسماء البديلة لدورة تدريبية.

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

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

طلب HTTP

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

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

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

المعلمات
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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.