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

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