نظرة عامة

توفّر لك Classroom API واجهة RESTful لإدارة الدورات التدريبية وقوائم الطلاب المسجّلين في Google Classroom. بالإضافة إلى ذلك، يتيح زر المشاركة في Classroom للمطوّرين ومالكي المحتوى تفعيل مشاركة المحتوى في Classroom.

من يمكنه استخدام واجهة برمجة التطبيقات؟

يمكن لمشرفي نطاقات Google Workspace for Education استخدام واجهة برمجة التطبيقات لتقديم الدورات التدريبية آليًا نيابةً عن المعلّمين ومزامنة أنظمة معلومات الطلاب مع Classroom والحصول على معلومات أساسية حول الصفوف التي يتم تدريسها في نطاقهم.

يمكن لمطوّري التطبيقات استخدام Classroom API لدمج تطبيقاتهم مع Classroom. تحتاج هذه التطبيقات إلى استخدام OAuth 2.0 لطلب إذن بعرض الصفوف وقوائم الطلاب المسجّلين من المعلّمين. يمكن للمشرفين تقييد ما إذا كان يمكن للمعلّمين والطلاب في نطاقهم منح التطبيقات الإذن بالوصول إلى بيانات Google Classroom.

يمكن لمالكي المواقع الإلكترونية ومطوّري المحتوى استخدام زر المشاركة في Classroom للسماح للطلاب والمعلّمين بمشاركة المحتوى مرة أخرى في Classroom.

يجب أن تتّبع جميع عمليات دمج أزرار المشاركة في Classroom وواجهة برمجة التطبيقات إرشادات العلامة التجارية في Classroom.

نظرة عامة على واجهة برمجة التطبيقات

تتألّف واجهة برمجة التطبيقات Classroom API من عدّة أنواع من العناصر تتوافق مع الصفوف والمعلّمين والطلاب في واجهة Classroom. تشتمل بعض هذه الكيانات على خصائص إضافية خاصة بواجهة برمجة التطبيقات إلى جانب الخصائص المتوفرة في Classroom. أنواع الكيانات الأساسية هي:

للحصول على معلومات تفصيلية حول موارد واجهة برمجة التطبيقات وطرقها، يُرجى الرجوع إلى مرجع Classroom API.

البيانات الوصفية والأسماء المستعارة للدورات التدريبية

تمثل الدورات التدريبية فئة، مثل "M. درس الرياضيات للفترة الرابعة لـ سميث"، والمعلمين المخصصين وقائمة الطلاب والبيانات الوصفية. يتم تحديد كل دورة تدريبية عن طريق معرف فريد يعينه الخادم. يتضمن مورد الدورة التدريبية على وجه التحديد جميع بيانات التعريف حول الدورة التدريبية، مثل الاسم والوصف والموقع والوقت. تتم إدارة قوائم الدورات التدريبية من خلال مراجع الطالب والمعلّم والدعوة وبطرقها.

الأسماء المستعارة هي معرّفات بديلة للفئة قد تكون مرتبطة بدورة تدريبية وتستخدم بدلاً من المعرّف الفريد. يوجد كل اسم مستعار في مساحة اسم تقيد من يمكنه إنشائه وعرضه. يتم دعم مساحتَي اسم وهما:

  • النطاق: تعد مساحة اسم النطاق مفيدة لإنشاء أسماء مستعارة يحتاج جميع المستخدمين إلى الوصول إليها، ولكنها ليست خاصة بأي برنامج. على سبيل المثال، يجب إنشاء بطاقات البيانات البديلة لدورة تدريبية، مثل MATH 127 وCOMSCI 127، في مساحة اسم النطاق. قد يتم إنشاء الأسماء المستعارة في مساحة اسم النطاق من خلال مشرفي النطاق فقط، ولكنها تكون مرئية لجميع المستخدمين في النطاق.
  • مشروع المطوِّر: مساحة اسم مشروع المطوِّر مفيدة لإدارة الأسماء المستعارة الخاصة بالتطبيق. على سبيل المثال، يمكن للتطبيق الذي يستخدم معرّفات بديلة للدورات التدريبية إنشاء أسماء مستعارة لربط معرّفه بدورات Classroom. ترتبط الأسماء المستعارة التي تم إنشاؤها في مساحة الاسم هذه بوحدة تحكّم Google API محددة. ويمكن لأي مستخدم لأي تطبيق إنشاء أسماء مستعارة وعرضها في مساحة الاسم لمشروع مطور هذا التطبيق.

لمزيد من المعلومات حول إدارة البيانات الوصفية والأسماء المستعارة للدورات التدريبية، يُرجى الاطّلاع على إدارة الدورات التدريبية.

قوائم المشاركين في الدورة التدريبية ومستخدميها

يمثل الطلاب والمعلّمون عمليات ربط محدَّدة بين الملف الشخصي للمستخدم والدورة التدريبية، ما يمثّل دور المستخدم في الدورة التدريبية. تصنيفات الطالب والمعلم ليست عالمية: يمكن تعيين مستخدم كمعلم لدورة تدريبية وطالب في أخرى. يمثل التصنيف "طالب" أو "معلّم" مجموعة من الأذونات لمستخدم معيّن في دورة تدريبية معيّنة.

الطلاب

يمثّل "مورد الطالب" مستخدمًا مسجَّلاً كطالب في.

دورة معينة. يُسمح للطلاب بالاطّلاع على تفاصيل الدورة التدريبية والمعلّمين لتلك الدورة التدريبية.

المعلمون

يمثّل مرجع المعلّم مستخدمًا يدرّس دورة تدريبية محدّدة.

يُسمح للمعلّمين بالاطّلاع على تفاصيل الدورة التدريبية وتغييرها وعرض المعلّمين والطلاب وإدارة المزيد من المعلّمين والطلاب.

توفّر الدعوات والأساليب المرتبطة بها طريقة ملائمة لإضافة الطلاب والمعلّمين إلى الدورات التدريبية. يتيح إنشاء الدعوات للمستخدمين اختيار ما إذا كانوا يريدون الانضمام إلى دورة تدريبية أم لا، بدلاً من إضافتها مباشرةً من خلال موارد المعلم والطلاب.

تمثّل ملفات UserProfiles عملية ربط للملف الشخصي لنطاق المستخدم على النحو الذي يتم تحديده من خلال رقم التعريف الفريد أو عنوان البريد الإلكتروني للمستخدم الذي عرضته Directory API. قد يشير المستخدم الحالي أيضًا إلى رقم تعريفه باستخدام اختصار "me".

لمزيد من المعلومات حول إدارة قوائم الطلاب المسجّلين، راجِع إدارة المعلّمين والطلاب.

الواجبات الدراسية وعمليات التقديم من قِبل الطلاب

يمثل عنصر CourseWork مهمة واحدة تم تعيينها لمجموعة من الطلاب في دورة تدريبية. ويحتوي على تفاصيل مثل الوصف وتاريخ الاستحقاق والمواد بالإضافة إلى بيانات التعريف مثل وقت الإنشاء. وتتضمن المواد العنوان والصورة المصغّرة وعنوان URL، بالإضافة إلى المُعرّف الذي يمكن استخدامه مع واجهات برمجة التطبيقات المناسبة (مثل Drive وYouTube).

تصف عناصر CourseWork أحد أنواع المهام التالية:

  • مهمة يكملها الطلاب عن طريق إرسال أوراق العمل أو المرفقات الأخرى.
  • سؤال ذو إجابة قصيرة أو سؤال خيارات متعدّدة.

يتم تمثيل عمل الطالب لعنصر CourseWork بعنصر StudentSubmission. وهي تتألف من رد وبيانات وصفية إضافية مثل الولاية والدرجة المعينة.

يعتمد محتوى عنصر StudentSubmission على نوع عنصر CourseWork المقابل:

  • أوراق العمل والمرفقات التي يتم إرسالها إلى المَهمّة الدراسية، بما في ذلك العنوان والصورة المصغّرة وعنوان URL، بالإضافة إلى المعرّفات التي يمكن استخدامها مع واجهات برمجة التطبيقات المناسبة، مثل Drive أو YouTube.
  • الإجابة عن سؤال ذي إجابة قصيرة أو سؤال خيارات متعدّدة.

لمزيد من المعلومات حول إدارة واجبات الدورة الدراسية وعمليات إرسال الطلاب، يمكنك الاطّلاع على إدارة الواجب الدراسي.

إضافات Classroom

الإضافة هي واجهة مستخدم يعرضها الشركاء وخلفية تُعرض عادةً في إطار iframe. تظهر الإضافات كمرفقات في مشاركة، والتي يمكن أن تكون Announcements أو CourseWork أو CourseWorkMaterials.

يمكن أن تكون مرفقات الإضافات نشاطًا أو محتوى.

  • تتطلب مرفقات الأنشطة من الطالب إكمال عملية إرسال فردية وتسليمها. وتشمل الأمثلة الاختبارات أو الرسومات أو الألعاب. يمكن تقييم إرسال النشاط بشكل اختياري.
  • لا تتطلّب مرفقات المحتوى أن يرسلها الطالب. لا يحتاج الطالب إلى تسليم المرفق ولم يتم وضع درجات له. تشمل الأمثلة الصور والمقالات والفيديوهات.

يمكنك الاطّلاع على أدلة تطوير الإضافات للحصول على مزيد من المعلومات.

التشغيل السريع

لإعداد بيئتك والبدء فورًا باستخدام واجهة برمجة التطبيقات، يمكنك تجربة إحدى الخطوات السريعة التالية:

تجربة مع مستكشف واجهات برمجة التطبيقات من Google

لتجربة طرق الاستدعاء على البيانات المباشرة، يمكنك محاولة استخدام مستكشف Google APIs. ليس عليك كتابة أي رمز للبدء، ولكن يجب الانتباه إلى أنّ الإجراءات التي تنفّذها باستخدام "مستكشف واجهات برمجة التطبيقات" يمكنها تعديل البيانات الحالية.

من بين طرق بدء استدعاء الطرق، إجراء استدعاء لطريقة courses.list(). لا تتطلب هذه الطريقة أي معلَمات طلب، ويمكنك استرداد id من قائمة الدورات التدريبية المعروضة لاستخدامها كمَعلمة طلب لطلبات البيانات من واجهة برمجة التطبيقات الأخرى. إذا لم يكن لديك أي دورات تدريبية، يمكنك إنشاء دورة تدريبية باستخدام طريقة courses.create().

يمكنك أيضًا استكشاف مرجع واجهة برمجة التطبيقات.