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

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

الكيان التمثيل في Classroom
الدورات التدريبية فئة، مثل "م. "الصف الرابع في مادة الرياضيات لسميرة".
الأسماء البديلة معرّف بديل لدورة دراسية
دعوات وسيلة لإضافة مستخدمين إلى صف
الطلاب طالب في صف دراسي
المعلّمون معلّم في صف دراسي
الملفات الشخصية للمستخدمين مستخدم بشكل عام، خارج سياق الطالب أو المعلّم
CourseWork مهمة في صف
StudentSubmissions عمل الطلاب في مهمة معيّنة، مثل الإجابات أو جداول البيانات
CourseWorkMaterials مواد للطلاب في صف دراسي
الإشعارات إشعار موجَّه إلى الطلاب في صف دراسي
AddOnAttachment محتوى أو نشاط متعلق بمهمة أو مادة يتم عرضها عادةً على شكل إطار iframe مضمَّن
المواضيع تجميع مرئي للمهام والمواد في صف
عمليات التسجيل تعليمات لإرسال إشعارات إلى تطبيقك بشأن التغييرات في البيانات، مثل قائمة صف

تحتوي معظم الموارد على طُرق خدمة للعمليات العادية، مثل قراءة مثيلات المورد وتعديلها وحذفها. تتضمّن بعض الموارد أيضًا methods مخصّصة لعمليات أخرى، مثل تعديل قائمة الطلاب الذين تم تعيين مهمة معيّنة لهم.

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

نظرة عامة على علاقات الموارد

  • الدورة التدريبية هي عنصر البيانات الأساسي في Google Classroom.
  • تُستخدَم الأسماء البديلة كمعرّفات بديلة لـ Courses.
  • تُستخدَم الدعوات لدعوة الملفات الشخصية للمستخدمين لتصبح مدرّسين أو طلابًا في Course، ولكن يمكن أيضًا إضافة المستخدمين مباشرةً من قِبل مشرفي نطاق Google Workspace for Education.
  • ينشئ المعلّمون عناصر بث ويشاركونها مع الطلاب في دوراتهم الدراسية. وأنواع عناصر البث المحتمَلة هي Coursework وCourseWorkMaterials وAnnouncements. يمكن تنظيم CourseWork وCourseWorkMaterials بشكل مرئي في المواضيع، ويمكن أن تحتوي على AddOnAttachments. يرسل الطلاب StudentSubmissions لملفهم الشخصي CourseWork.
  • يمكن للمطوّرين إنشاء عمليات تسجيل لتلقّي إشعارات عند تغيُّر بعض هذه البيانات.

يتوفّر Google Classroom للنطاقات التي تشترك في Google Workspace for Education. يمثّل النطاق في سياق Classroom عادةً منطقة دراسية. يمكنك إنشاء نطاق اختبار في Google Workspace for Education لأغراض تطوير التطبيقات، ما يتيح لك التحكّم في مثيل علني من Classroom بدون التأثير في المستخدمين الفعليين.

الدورات التدريبية والأسماء البديلة

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

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

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

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

قوائم الطلاب المسجّلين في الدورات والمستخدمون

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

الطلاب

يمثّل مورد Student مستخدمًا مسجّلاً كطالب في دورة تدريبية معيّنة.

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

المعلمون

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

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

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

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

يمكن أيضًا استخدام خدمة UserProfiles لإدارة Guardians ودعوته، وهو ربط بين الطالب والوصي. يمكن للأوصياء في Classroom الوصول إلى بعض معلومات الطلاب، مثل المهام الدراسية.

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

المهام الدراسية والمهام التي يرسلها الطلاب

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

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

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

يتم تمثيل عمل الطالب في عنصر CourseWork برمز StudentSubmission. ويتألف من استجابة وبيانات وصفية إضافية، مثل الحالة والدرجة المخصّصة.

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

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

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

مواد الدورات الدراسية والإشعارات

على غرار CourseWork، يمثّل CourseWorkMaterials المحتوى الذي تمّ تعيينه لمجموعة من الطلاب في دورة تدريبية، مع تفاصيل مثل العنوان والوصف، بالإضافة إلى المواد. ومع ذلك، على عكس CourseWork، لا يتطلب CourseWorkMaterials من الطلاب إرسال أيّ عناصر. وبالتالي، ما مِن تاريخ تسليم، ولا يتوفّر StudentSubmissions لـ CourseWorkMaterials. على سبيل المثال، يمكن للمعلّمين استخدام CourseWorkMaterials لنشر مواد مقروءة مقترَحة أو منهج دراسي أو قواعد الصف الدراسي.

تمثّل Announcements أيضًا المحتوى الذي تمت مشاركته مع مجموعة من الطلاب، ولكن لا تتضمّن تفاصيل مثل العنوان، ولا يمكن تنظيمها حسب Topics مثل CourseWork أو CourseWorkMaterials. وقد يستخدم المعلّمون هذه الميزة لإرسال تذكيرات أو إشعارات إلى الصف.

المواضيع

تُستخدَم Topics لتنظيم CourseWork وCourseWorkMaterials visually ضمن صف. ويمكن استخدامها لتجميع المهام في "اختيارية" و "مطلوب"، أو "الوحدة 1" و "الوحدة 2"، على سبيل المثال.

إضافات Classroom

الإضافات هي واجهة مستخدِم وخلفية يقدّمها المطوّرون ويتم عرضهما عادةً في ملف vimeframe. تظهر الإضافات كمرفقات في عنصر البث. يمكن أن يكون عنصر البث Announcements أو CourseWork أو CourseWorkMaterials. يتم تمثيل المرفقات الإضافية برمز AddOnAttachment.

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

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

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

تسجيلات

يمكن للتطبيقات الاشتراك في الإشعارات عند تغيُّر بيانات معيّنة في Google Classroom. على سبيل المثال، عند تعديل قائمة الطلاب في دورة تدريبية. يمثّل Registrations تعليمات لإرسال هذه الإشعارات إلى تطبيقك.

اطّلِع على دليل الإشعارات الفورية لمعرفة المزيد.