نظرة عامة

توفر لك Classroom API واجهة مريحة من أجل إدارة الدورات التدريبية والقوائم في 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

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

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

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