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

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