توفّر واجهة برمجة تطبيقات Classroom واجهة RESTful التي تتيح لك إدارة الدورات التدريبية وقوائم الطلاب المسجّلين في Google Classroom. بالإضافة إلى ذلك، يسمح زر المشاركة في Classroom لمطوّري البرامج ومالكي المحتوى بتفعيل مشاركة المحتوى مع Classroom.
من يمكنه استخدام واجهة برمجة التطبيقات؟
يمكن لمشرفي نطاق Google Workspace for Education استخدام واجهة برمجة التطبيقات لتوفير الدورات التدريبية برمجيًا نيابة عن المعلمين ومزامنة أنظمة معلومات الطلاب مع Classroom والحصول على مستوى رؤية أساسي للصفوف التي يتم تدريسها في نطاقهم.
يمكن لمطوّري التطبيقات استخدام Classroom API لدمج تطبيقاتهم مع Classroom. تحتاج هذه التطبيقات إلى استخدام OAuth 2.0 لطلب إذن لعرض الفصول الدراسية والقوائم من المعلمين. يمكن للمشرفين فرض قيود على إمكانية منح المعلّمين والطلاب في نطاقهم الإذن للتطبيقات بالوصول إلى بيانات Google Classroom.
يمكن لمالكي المواقع الإلكترونية ومطوّري المحتوى استخدام زر المشاركة في Classroom للسماح للطلاب والمعلّمين بمشاركة المحتوى مرة أخرى مع Classroom.
يجب أن تتبع جميع عمليات دمج أزرار المشاركة في واجهة برمجة التطبيقات وClassroom إرشادات العلامة التجارية في Classroom.
نظرة عامة على واجهة برمجة التطبيقات
تتألف واجهة برمجة تطبيقات Classroom من العديد من أنواع الكيانات التي تتوافق مع الفصول والمعلّمين والطلاب في واجهة Classroom. وتحتوي بعض هذه الكيانات على سمات إضافية خاصة بواجهة برمجة التطبيقات بالإضافة إلى الخصائص المتاحة في Classroom. أنواع الكيانات الأساسية هي:
- الدورات التدريبية
- الأسماء المستعارة
- الدعوات
- الطلاب
- المعلّمون
- الملفات الشخصية للمستخدمين
- الواجب الدراسي
- المواضيع
- إرسالات الطلاب
للحصول على معلومات تفصيلية عن موارد API وأساليبها، يُرجى الرجوع إلى مرجع واجهة برمجة تطبيقات Classroom.
البيانات الوصفية للدورة التدريبية وأسماءها المستعارة
تمثّل الدورات التدريبية صفًا، مثل "M. مادة الرياضيات للمرحلة الرابعة"، والمدرسين المعينين وقائمة الطلاب والبيانات الوصفية التابعة لهم. ويتم تحديد كل دورة تدريبية من خلال رقم تعريف فريد يعيّنه الخادم. ويخصّص مورد الدورة التدريبية كل البيانات الوصفية حول الدورة التدريبية، مثل الاسم والوصف والموقع الجغرافي والوقت. تتم إدارة قوائم الدورات التدريبية من خلال مصادر الطالب والمعلّم والدعوة وطرقهم.
الأسماء المستعارة هي معرّفات بديلة لصف يمكن ربطه بالدورة التدريبية واستخدامه بدلاً من المعرّف الفريد. يوجد كل اسم مستعار في مساحة الاسم التي تقيد من يمكنه إنشاؤه ومشاهدته. يتم دعم مساحتي اسم:
- النطاق: تكون مساحة اسم النطاق مفيدة في إنشاء أسماء مستعارة يجب على جميع المستخدمين الوصول إليها، ولكنها ليست خاصة بأي برنامج. على سبيل المثال، يجب إنشاء بطاقات بيانات بديلة لدورة تدريبية، مثل MATH 127 وCOMSCI 127، في مساحة اسم النطاق. لا يمكن إنشاء أسماء مستعارة في مساحة اسم النطاق إلا بواسطة مشرفي النطاق، ولكنها تكون مرئية لجميع المستخدمين في النطاق.
- مشروع مطوّر البرامج: تكون مساحة اسم مشروع مطوّر البرامج مفيدة لإدارة الأسماء المستعارة الخاصة بالتطبيق. على سبيل المثال، يمكن لأي تطبيق يستخدم معرّفات بديلة للدورات التدريبية إنشاء أسماء مستعارة لربط معرّفه بدورات Classroom. يتم ربط الأسماء المستعارة التي تم إنشاؤها في مساحة الاسم هذه بوحدة تحكم واجهة برمجة تطبيقات Google. يمكن لأي مستخدم للتطبيق إنشاء أسماء مستعارة وعرضها في مساحة الاسم لمشروع مطور التطبيق.
للحصول على مزيد من المعلومات حول إدارة البيانات الوصفية للدورة التدريبية والأسماء المستعارة، يمكنك الاطّلاع على إدارة الدورات التدريبية.
قوائم المستخدمين والدورات التدريبية
الطلاب والمعلّمون هم عمليات ربط محدّدة بين ملف شخصي لمستخدم ودورة تدريبية، ما يمثل دور المستخدم في الدورة التدريبية. إن تعيينات الطلاب والمعلمين ليست عامة: حيث يمكن تعيين المستخدم كمدرس لدورة تدريبية والطالب في دورة تدريبية أخرى. يمثل التصنيف "طالب" أو "مُعلّم" مجموعة من الأذونات لمستخدم معيّن في دورة تدريبية معيّنة.
- الطلاب
- يمثل مورد الطالب المستخدم الذي تم تسجيله كطالب في دورة تدريبية محدّدة. يُسمح للطلاب بالاطّلاع على تفاصيل الدورة التدريبية ومعلّمي هذه الدورة التدريبية.
- المعلمون
- يمثل مورد المعلّم مستخدمًا يدرّس دورة تدريبية معيّنة. يُسمح للمعلمين بعرض تفاصيل الدورة التدريبية وتغييرها، وعرض المعلمين والطلاب، وإدارة المزيد من المعلمين والطلاب.
توفر الدعوات والطرق المقترنة بها طريقة ملائمة لإضافة الطلاب والمعلمين إلى الدورات التدريبية. يتيح إنشاء الدعوات للمستخدمين اختيار الانضمام إلى الدورة التدريبية أو عدم الانضمام إليها، بدلاً من إضافتهم مباشرةً عبر موارد المعلم والطالب.
تمثل UserProfiles عملية ربط بملف شخصي لنطاق المستخدم على النحو المحدّد من خلال رقم التعريف الفريد أو عنوان البريد الإلكتروني للمستخدم الذي يتم عرضه من خلال واجهة برمجة تطبيقات الدليل.
يمكن للمستخدم الحالي أيضًا الإشارة إلى رقم تعريفه باستخدام اختصار "me".
لمزيد من المعلومات حول إدارة قوائم الطلاب المسجّلين، يُرجى الاطّلاع على إدارة المعلّمين والطلاب.
المهام الدراسية ومهام الطلاب
يمثل عنصر CourseWork مهمة واحدة تم تعيينها إلى مجموعة من الطلاب في إحدى الدورات التدريبية. إنه يحتوي على تفاصيل مثل الوصف وتاريخ التسليم والمواد بالإضافة إلى البيانات الوصفية مثل وقت الإنشاء. وتشمل المواد عنوانًا وصورة مصغّرة وعنوان URL، بالإضافة إلى معرّف يمكن استخدامه مع واجهات برمجة التطبيقات المناسبة (مثل Drive وYouTube).
تصف عناصر CourseWork أحد أنواع المهام التالية:
- مهمة يُكملها الطلاب من خلال إرسال أوراق العمل أو المرفقات الأخرى.
- سؤال ذي إجابة قصيرة أو سؤال خيارات متعدّدة.
يتم تمثيل عمل الطالب لعنصر CourseWork من خلال StudentSubmission. ويتألف من استجابة وبيانات وصفية إضافية، مثل الولاية والدرجة المعيّنة.
تعتمد محتويات عنصر StudentSubmission على نوع عنصر CourseWork المقابل:
- أوراق العمل والمرفقات المُرسَلة للمهمة الدراسية، بما في ذلك العنوان والصورة المصغّرة وعنوان URL، بالإضافة إلى المعرّفات التي يمكن استخدامها مع واجهات برمجة التطبيقات المناسبة مثل Drive أو YouTube.
- تمثل هذه الخاصية الإجابة عن سؤال ذي إجابة قصيرة أو سؤال خيارات متعدّدة.
لمزيد من المعلومات حول إدارة الواجبات الدراسية وإرسالات الطلاب، راجع إدارة الواجب الدراسي.
أدلة البدء السريع
لإعداد بيئتك والبدء فورًا باستخدام واجهة برمجة التطبيقات، جرِّب إحدى الخطوات السريعة التالية:
تجربة مستكشف Classroom API
لتجربة طرق استدعاء للبيانات المباشرة، حاول استخدام مستكشف واجهة برمجة تطبيقات Classroom. لا يتعين عليك كتابة أي شفرة للبدء، ولكن يُرجى العلم بأن الإجراءات التي تنفذها باستخدام مستكشف واجهة برمجة التطبيقات يمكنها تعديل البيانات الحالية.
وتتمثل إحدى طرق بدء الاتصال بالطُرق في إجراء استدعاء للطريقة courses.list(). لا تتطلب هذه الطريقة أي معلمات طلب ويمكنك استرداد id من قائمة الدورات التدريبية المعروضة لاستخدامها كمعلمة طلب لاستدعاءات واجهة برمجة التطبيقات الأخرى. إذا لم يكن لديك أي دورات تدريبية، يمكنك إنشاء دورة تدريبية باستخدام طريقة courses.create().
يمكنك أيضًا استكشاف مرجع واجهة برمجة التطبيقات.