يقدّم هذا الدليل نظرة عامة على المكوّنات الأساسية التي تشكّل واجهة برمجة التطبيقات Google Classroom API. تتألف Google Classroom API من موارد وخدمات. تمثّل الموارد الكيانات في Google Classroom، مثل دورة تدريبية أو مهمة، وتسترجع الخدمات هذه الموارد وتديرها. تتضمّن بعض هذه الكيانات سمات إضافية خاصة بواجهة برمجة التطبيقات، بالإضافة إلى السمات المتوفّرة في Classroom. أنواع الكيانات الأساسية هي:
| الكيان | التمثيل في Classroom |
|---|---|
| الدورات التدريبية | فئة، مثل "M" رياضيات الصف الرابع مع المعلّم سميث". |
| الأسماء المستعارة | معرّف بديل لدورة تدريبية |
| الدعوات | وسيلة لإضافة مستخدمين إلى صف |
| الطلاب | طالب في صف |
| المعلّمون | معلّم في صف |
| الملفات الشخصية للمستخدمين | يشير إلى مستخدم بشكل عام، خارج سياق الطالب أو المعلّم. |
| CourseWork | مهمة في صف |
| StudentSubmissions | عمل الطالب في مهمة معيّنة، مثل الإجابات أو أوراق العمل |
| CourseWorkMaterials | مواد للطلاب في صف |
| الإشعارات | إشعار للطلاب في صف دراسي |
| AddOnAttachment | محتوى أو نشاط في مهمة أو مادة يتم عرضه عادةً كإطار iframe مضمّن |
| المواضيع | هي مجموعة مرئية من المهام والمواد في صف. |
| عمليات التسجيل | تعليمات لإرسال إشعارات إلى تطبيقك بشأن التغييرات في البيانات، مثل قائمة الصف |
تتضمّن معظم المراجع طرقًا للخدمة لإجراء العمليات العادية، مثل قراءة مثيلات المرجع وتعديلها وحذفها. تتضمّن بعض المراجع أيضًا طرقًا مخصّصة لإجراء عمليات أخرى، مثل تعديل قائمة الطلاب الذين تم تعيين مهمة معيّنة لهم.
للحصول على معلومات مفصّلة حول موارد واجهة برمجة التطبيقات وطرقها، يُرجى الرجوع إلى مرجع Classroom API.
نظرة عامة على علاقات الموارد
- الدورة التدريبية هي عنصر البيانات الأساسي في Google Classroom.
- تُستخدَم الأسماء المستعارة كمعرّفات بديلة لـ
Courses. - تُستخدَم الدعوات لدعوة الملفات الشخصية للمستخدمين ليصبحوا معلّمين
أو طلابًا في
Course، ولكن يمكن أيضًا إضافة المستخدمين مباشرةً من خلال مشرفي نطاق Google Workspace for Education. - ينشئ المعلّمون عناصر في ساحة المشاركات ويشاركونها مع الطلاب في دوراتهم التدريبية. أنواع عناصر ساحة المشاركة المحتملة هي المهام الدراسية ومواد المهام الدراسية والإشعارات. يمكن تنظيم
CourseWorkوCourseWorkMaterialsبشكل مرئي في مواضيع، ويمكن أن تحتوي على AddOnAttachments. يرسل الطلاب StudentSubmissions لـCourseWork. - يمكن للمطوّرين إنشاء عمليات تسجيل لتلقّي إشعارات عند حدوث تغيير في بعض هذه البيانات.
يتوفّر Google Classroom للنطاقات التي تشترك في Google Workspace for Education. يمثّل النطاق في سياق Classroom عادةً منطقة تعليمية. يمكنك إنشاء نطاق اختبار في Google Workspace for Education لأغراض التطوير، ما يتيح لك التحكّم في نسخة إنتاجية من Classroom بدون التأثير في المستخدمين الفعليين.
الدورات التدريبية والأسماء المستعارة
تمثّل Courses فئة، مثل "M. "رياضيات الفترة الرابعة مع المعلّم سميث"، والمعلّمون المحدّدون لها وقائمة الطلاب وبياناتها الوصفية. يتم تحديد كل دورة تدريبية من خلال معرّف فريد يخصّصه الخادم. يتضمّن المورد Course تحديدًا جميع البيانات الوصفية الخاصة بالدورة التدريبية، مثل الاسم والوصف والموقع الجغرافي والوقت. تتم إدارة قوائم الدورات التدريبية من خلال المراجع Student وTeacher وInvitation وطرقها.
Aliases هي معرّفات بديلة لأحد الصفوف يمكن ربطها بدورة تدريبية واستخدامها بدلاً من المعرّف الفريد. يتوفّر كل اسم مستعار في مساحة اسم تحدّد المستخدمين الذين يمكنهم إنشاؤه والاطّلاع عليه. يتوفّر مساحتا اسم:
- النطاق: مساحة اسم النطاق مفيدة لإنشاء أسماء مستعارة يحتاج جميع المستخدمين إلى الوصول إليها، ولكنها ليست خاصة بأي برنامج واحد. على سبيل المثال، يجب إنشاء بيانات بديلة لبيانات دورة تدريبية، مثل MATH 127 وCOMSCI 127، في مساحة اسم النطاق. لا يمكن إنشاء الأسماء المستعارة في مساحة اسم النطاق إلا من قِبل مشرفي النطاق، ولكن يمكن لجميع المستخدمين في النطاق رؤيتها.
- مشروع المطوّر: تكون مساحة اسم مشروع المطوّر مفيدة لإدارة الأسماء المستعارة الخاصة بتطبيق معيّن. على سبيل المثال، يمكن لتطبيق يستخدم معرّفات بديلة للدورات التدريبية إنشاء أسماء مستعارة لربط المعرّف الخاص به بالدورات التدريبية في Classroom. تكون الأسماء المستعارة التي تم إنشاؤها في مساحة الاسم هذه مرتبطة بوحدة تحكّم Google API معيّنة. يمكن لأي مستخدم لتطبيق إنشاء أسماء مستعارة وعرضها في مساحة الاسم الخاصة بمشروع المطوّر لهذا التطبيق.
لمزيد من المعلومات حول إدارة البيانات الوصفية وأسماء الدورات التدريبية المستعارة، يُرجى الاطّلاع على إدارة الدورات التدريبية.
قوائم الطلاب المسجّلين في الدورات التدريبية والمستخدمين
Students وTeachers هما عمليات ربط محدّدة بين الملف الشخصي للمستخدم ودورة تدريبية، وتمثّلان دور هذا المستخدم في الدورة التدريبية. لا تكون تصنيفات الطالب والمعلّم عامة، بل يمكن تصنيف المستخدم كمعلّم في دورة تدريبية وطالب في دورة أخرى. يشير التصنيف "طالب" أو "معلّم" إلى مجموعة من الأذونات لمستخدم معيّن في دورة تدريبية معيّنة. قد يكون للدورة التدريبية أكثر من معلّم واحد أو صفر طالب. يمكن إضافة المعلّمين والطلاب إلى دورة تدريبية أو إزالتهم منها في أي وقت.
- الطلاب
يمثّل مورد
Studentمستخدمًا مسجّلاً كطالب في دورة تدريبية معيّنة.يُسمح للطلاب بالاطّلاع على تفاصيل الدورة التدريبية وأسماء المعلّمين فيها.
- المعلمون
يمثّل المورد
Teacherمستخدمًا يدرّس دورة تدريبية معيّنة.يُسمح للمعلّمين بعرض تفاصيل الدورة التدريبية وتغييرها، وعرض المعلّمين والطلاب، وإدارة المعلّمين والطلاب الإضافيين.
توفّر السمة Invitations والطرق المرتبطة بها طريقة سهلة لإضافة الطلاب والمعلّمين إلى الدورات التدريبية. يتيح إنشاء الدعوات للمستخدمين اختيار ما إذا كانوا يريدون الانضمام إلى دورة تدريبية أم لا، بدلاً من إضافتهم مباشرةً من خلال موارد المعلّمين والطلاب.
تمثّل UserProfiles عملية ربط بملف شخصي للمستخدم على النطاق، كما هو محدّد برقم التعريف الفريد أو عنوان البريد الإلكتروني للمستخدم الذي تعرضه Directory API. يمكن للمستخدم الحالي أيضًا الإشارة إلى رقم التعريف الخاص به باستخدام الاختصار "me".
يمكن أيضًا استخدام خدمة UserProfiles لإدارة دعوات Guardians ودعوة Guardians،
وهي عملية ربط بين طالب ووصي. يمكن للأوصياء في Classroom الوصول إلى بعض معلومات الطلاب، مثل مهامهم الدراسية.
لمزيد من المعلومات حول إدارة قوائم الطلاب، يُرجى الاطّلاع على إدارة المعلّمين والطلاب.
عناصر ساحة المشاركات
عناصر ساحة المشاركة هي أجزاء من المحتوى المنشور الذي تتم مشاركته مع أعضاء إحدى الدورات التدريبية.
يمكن للمطوّرين والمعلّمين إنشاء ثلاثة أنواع من عناصر ساحة المشاركة: Announcement وCourseWork وCourseWorkMaterial.
ينشئ المعلّمون Announcements في أعلى صفحة "ساحة المشاركات" ضمن واجهة مستخدم Classroom. ينشئ المعلّمون CourseWork وCourseWorkMaterials من خلال النقر على الزر إنشاء في علامة التبويب "الواجب الدراسي".
يمكن للمطوّرين إنشاء جميع أنواع عناصر ساحة المشاركة آليًا من خلال Classroom API.
تنطبق الشروط التالية على عناصر ساحة المشاركة:
- يمكن أن تحتوي جميع عناصر ساحة المشاركات على مواد تكميلية، مثل ملفات Google Drive وفيديوهات YouTube و"نماذج Google" والروابط التشعبية الخاصة بعناوين URL والمرفقات الخاصة بإضافات Classroom.
- يمكن تعيين جميع عناصر ساحة المشاركات لمجموعة فرعية من الطلاب في الدورة التدريبية.
- يمكن أن يكون التقييم
CourseWorkمصحوبًا بدرجة أو بدون درجة. يمكن للمعلمين تغيير حالة التقييم لواجبCourseWorkفي أي وقت. - قد يتضمّن عنصر في ساحة المشاركات أكثر من مرفق واحد.
- قد يتضمّن عنصر في ساحة المشاركة مرفقات من أنواع مختلفة. على سبيل المثال، قد تتضمّن مهمة واحدة
CourseWorkملفات Google Drive وفيديوهات YouTube ومرفقات إضافات Classroom في الوقت نفسه. - قد يتضمّن عنصر في ساحة المشاركة مرفقات إضافية من أكثر من مطوّر واحد.
- يمكن للمطوّرين الحصول على تفاصيل حول أي مصدر لعنصر في "ساحة المشاركات" يتضمّن إحدى مرفقات الإضافات وتعديل هذه التفاصيل.
- يمكن للمطوّرين تسليم عمل الطالب أو استرداده أو إرجاعه في
CourseWorkمهمة تتضمّن أحد مرفقات الإضافة. - يمكن للمطوّرين وضع الدرجات النهائية للمهام التي أرسلها الطلاب بشكل فردي فقط في المهام التي أنشأوها.
تم نسخ عناصر البث
يمكن للمعلّمين نسخ عنصر من ساحة المشاركات من خلال نسخ دورة تدريبية أو إعادة استخدام مهمة أو نشر عنصر من ساحة المشاركات في دورات تدريبية متعددة. ستتضمّن أي نسخ جديدة معرّفات مميّزة، وقد يكون ذلك عاملاً مهمًا يجب أخذه في الاعتبار عند تطوير إضافة في Classroom. يمكنك الاطّلاع على دليلنا حول المحتوى المنسوخ لمعرفة كيف يمكن لإضافة التعامل مع هذه السيناريوهات.
CourseWork وStudentSubmissions
يمثّل العنصر CourseWork واجبًا لمجموعة من الطلاب في إحدى الدورات التدريبية. وهو نوع عنصر ساحة المشاركة الوحيد الذي يمكنه قبول تسليمات الطلاب. يحتوي المرجع CourseWork على تفاصيل مثل الوصف وتاريخ التسليم والحد الأقصى للدرجة والبيانات الوصفية، مثل وقت الإنشاء.
يصف كل مورد CourseWork أحد أنواع المهام التالية:
- مهمة يكملها الطلاب من خلال إرسال أوراق عمل أو مرفقات أخرى.
- سؤال ذو إجابة قصيرة أو سؤال ذو خيارات متعدّدة
يتم تمثيل عمل الطالب في عنصر CourseWork بالرمز StudentSubmission. وهي تتألف من رد وبيانات وصفية إضافية، مثل الحالة والدرجة المخصّصة.
تعتمد محتويات StudentSubmission على نوع العنصر CourseWork المقابل ويمكن أن تشمل ما يلي:
- أوراق العمل والمرفقات التي يتم إرسالها في مهمة، بما في ذلك العنوان والصورة المصغّرة وعنوان URL، بالإضافة إلى المعرّفات التي يمكن استخدامها مع واجهات برمجة التطبيقات المناسبة، مثل Drive أو YouTube
- الردّ على سؤال ذي إجابة قصيرة أو سؤال ذي خيارات متعدّدة
لمزيد من المعلومات حول إدارة الواجبات الدراسية والمهام التي يرسلها الطلاب، يُرجى الاطّلاع على إدارة الواجبات الدراسية.
CourseWorkMaterials and Announcements
على غرار CourseWork، يمثّل CourseWorkMaterials المحتوى الذي تم تعيينه لمجموعة من الطلاب في إحدى الدورات التدريبية. يتضمّن كل مرجع تفاصيل مثل العنوان والوصف بالإضافة إلى مواد تكميلية. ومع ذلك، على عكس CourseWork،CourseWorkMaterials لا تتطلّب من الطلاب إرسال أي أعمال. وبالتالي، ليس هناك تاريخ تسليم، ولا يتوفّر StudentSubmissions لـ CourseWorkMaterials. قد يستخدم المعلّمون CourseWorkMaterials لنشر
مواد قراءة مقترَحة أو منهج دراسي أو قواعد الصف.
تمثّل Announcements أيضًا المحتوى الذي تتم مشاركته مع مجموعة من الطلاب، ولكنها لا تتضمّن تفاصيل مثل العنوان، ولا يمكن تنظيمها حسب Topics مثل CourseWork أو CourseWorkMaterials. قد يستخدم المعلّمون هذه الإشعارات لإرسال تذكيرات أو إشعارات إلى الصف.
المواضيع
تُستخدَم Topics لتنظيم CourseWork وCourseWorkMaterials بشكل مرئي
داخل صف. ويمكن استخدامها لتجميع المهام في فئتَي "اختيارية" و"إلزامية"، أو "الوحدة 1" و "الوحدة 2"، على سبيل المثال.
إضافات Classroom
الإضافة هي واجهة مستخدم وخلفية يعرضهما المطوّر، ويتم عرضها عادةً في إطار iframe. تظهر الإضافات كمرفقات في عنصر بث. يمكن أن يكون عنصر البث
أي Announcements أو CourseWork أو CourseWorkMaterials. يتم تمثيل المرفقات الإضافية برمز AddOnAttachment.
يمكن أن تكون مرفقات الإضافات نشاطًا أو محتوى.
- تتطلّب المرفقات في الأنشطة من الطالب إكمال مهمة وتسليمها بشكل فردي. تشمل الأمثلة الاختبارات أو الرسومات أو الألعاب. يمكن بشكل اختياري تقييم عملية إرسال نشاط.
- لا تتطلّب المرفقات إرسال الطالب للواجب. لا يحتاج الطالب إلى تسليم المرفق ولا يتم وضع درجة له. وتشمل الأمثلة الصور والمقالات والفيديوهات.
اطّلِع على أدلة تطوير الإضافات لمزيد من المعلومات.
تسجيلات
يمكن للتطبيقات الاشتراك لتلقّي إشعارات عند حدوث تغييرات في بيانات معيّنة في Google Classroom. على سبيل المثال، عند تعديل قائمة الطلاب في إحدى الدورات التدريبية.
يمثّل Registrations تعليمات لإرسال هذه الإشعارات إلى تطبيقك.
يمكنك الاطّلاع على دليل الإشعارات الفورية لمعرفة المزيد.