Google Classroom API

يدير الصفوف وقوائم الطلاب المسجّلين والدعوات في Google Classroom.

الخدمة: Classroom.googleapis.com

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

مستند Discovery

مستند الاستكشاف هو مواصفة يمكن للآلة قراءتها، لوصف واجهات برمجة تطبيقات REST واستخدامها. يُستخدم لإنشاء مكتبات للعملاء، ومكونات IDE الإضافية، وأدوات أخرى تتفاعل مع Google APIs. قد توفّر خدمة واحدة مستندات استكشاف متعددة. توفّر هذه الخدمة مستند Discovery التالي:

نقطة نهاية الخدمة

نقطة نهاية الخدمة هي عنوان URL أساسي يحدّد عنوان الشبكة لخدمة واجهة برمجة التطبيقات. قد تحتوي خدمة واحدة على عدة نقاط نهاية للخدمة. تشتمل هذه الخدمة على نقطة نهاية الخدمة التالية، وترتبط جميع معرّفات الموارد المنتظمة (URI) أدناه بنقطة نهاية الخدمة هذه:

  • https://classroom.googleapis.com

مورد REST: v1.courses

الطُرق
checkAddOnCreationEligibility GET /v1/courses/{courseId}:checkAddOnCreationEligibility
تعرض ما إذا كان المستخدم مؤهَّلاً لإنشاء مرفقات الإضافات في دورة تدريبية معيّنة.
checkGradingPeriodsSetupEligibility GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
تعرِض هذه السمة ما إذا كان المستخدِم مؤهَّلاً لتعديل GradingPeriodSettings في دورة تدريبية معيّنة.
create POST /v1/courses
ينشئ دورة تدريبية.
delete DELETE /v1/courses/{id}
يؤدي هذا الإجراء إلى حذف دورة تدريبية.
get GET /v1/courses/{id}
لعرض دورة تدريبية.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
تعرض هذه السياسة إعدادات فترة وضع الدرجات في دورة تدريبية.
list GET /v1/courses
تعرض قائمة بالدورات التدريبية التي يُسمح للمستخدم الذي قدّم الطلب بالاطّلاع عليها، وتقتصر على تلك التي تتطابق مع الطلب.
patch PATCH /v1/courses/{id}
لتعديل حقل واحد أو أكثر في دورة تدريبية.
update PUT /v1/courses/{id}
تُستخدَم لتعديل دورة تدريبية.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
لتعديل إعدادات فترة وضع الدرجات لدورة تدريبية

مورد REST: v1.courses.aliases

الطُرق
create POST /v1/courses/{courseId}/aliases
يتم إنشاء عنوان بديل للدورة التدريبية.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
يؤدي هذا الإجراء إلى حذف اسم مستعار للدورة التدريبية.
list GET /v1/courses/{courseId}/aliases
تعرض قائمة بالأسماء المستعارة للدورة التدريبية.

مورد REST: v1.courses.announcements

الطُرق
create POST /v1/courses/{courseId}/announcements
إنشاء إشعار
delete DELETE /v1/courses/{courseId}/announcements/{id}
يؤدي هذا الإجراء إلى حذف إعلان.
get GET /v1/courses/{courseId}/announcements/{id}
لعرض إشعار.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
توفر هذه الطريقة البيانات الوصفية لإضافات Classroom في سياق مشاركة محدّدة.
list GET /v1/courses/{courseId}/announcements
تعرض قائمة بالإشعارات المسموح لمقدّم الطلب بالاطّلاع عليها.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
يتم تعديل وضع المُسنَد إليه وخيارات الإشعار.
patch PATCH /v1/courses/{courseId}/announcements/{id}
لتعديل حقل واحد أو أكثر من الإشعارات.

مورد REST: v1.courses.announcements.addOnAttachments

الطُرق
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
تنشئ مرفق إضافة أسفل مشاركة.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
يؤدي هذا الإجراء إلى حذف مرفق إضافة.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
تعرض مرفق إضافة.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
تعرض جميع المرفقات التي تم إنشاؤها بواسطة إضافة ضمن المشاركة.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
تعدّل مرفق إضافة.

مورد REST: v1.courses.courseWork

الطُرق
create POST /v1/courses/{courseId}/courseWork
إنشاء مهام الدورة التدريبية
delete DELETE /v1/courses/{courseId}/courseWork/{id}
يؤدي هذا الإجراء إلى حذف مهمة الدورة التدريبية.
get GET /v1/courses/{courseId}/courseWork/{id}
تعرض مهام الدورة التدريبية.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
توفر هذه الطريقة البيانات الوصفية لإضافات Classroom في سياق مشاركة محدّدة.
list GET /v1/courses/{courseId}/courseWork
تعرض قائمة بالمهام الدراسية المسموح لمقدّم الطلب بالاطّلاع عليها.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
يتم تعديل وضع المعيَّن له وخيارات مهام الدورة التدريبية.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
تُستخدَم لتعديل حقل واحد أو أكثر من مهام الدورة التدريبية.

مورد REST: v1.courses.courseWork.addOnAttachments

الطُرق
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
تنشئ مرفق إضافة أسفل مشاركة.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
يؤدي هذا الإجراء إلى حذف مرفق إضافة.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
تعرض مرفق إضافة.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
تعرض جميع المرفقات التي تم إنشاؤها بواسطة إضافة ضمن المشاركة.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
تعدّل مرفق إضافة.

مورد REST: v1.courses.courseWork.addOnAttachments.studentSubmissions

الطُرق
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
تعرض الرسالة التي أرسلها الطالب لمرفق إضافة.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
تعدّل البيانات المرتبطة بإرسال مرفق إضافة.

مورد REST: v1.courses.courseWork.rubrics

الطُرق
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
تنشئ قاعدة تقييم.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
يؤدي هذا الإجراء إلى حذف قواعد التقييم.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
تعرض هذه الدالة قواعد تقييم.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
عرض قائمة بقواعد التقييم التي يُسمح لمقدِّم الطلب بالاطّلاع عليها
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
تعديل قواعد تقييم

مورد REST: v1.courses.courseWork.studentSubmissions

الطُرق
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
تعرض المهمة التي أرسلها الطالب.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
تعرض قائمة بعمليات إرسال الطلاب المسموح لمقدِّم الطلب بالاطّلاع عليها، مع مراعاة نطاقات OAuth للطلب.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
يتم تعديل المرفقات التي يرسلها الطالب.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
يتم تعديل حقل واحد أو أكثر من المهام التي أرسلها الطالب.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
استرداد طلب أرسله طالب نيابةً عن الطالب الذي يملكه.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
تعرض المهمة التي أرسلها الطالب.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
يتم إرسال مهمة الطالب.

مورد REST: v1.courses.courseWorkMaterials

الطُرق
create POST /v1/courses/{courseId}/courseWorkMaterials
تنشئ مواد للعمل الدراسي.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
يؤدي هذا الإجراء إلى حذف مواد عمل الدورة التدريبية.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
تعرض مواد عمل الدورة التدريبية.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
توفر هذه الطريقة البيانات الوصفية لإضافات Classroom في سياق مشاركة محدّدة.
list GET /v1/courses/{courseId}/courseWorkMaterials
تعرض قائمة بمواد الدورات التدريبية المسموح لمقدّم الطلب بالاطّلاع عليها.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
يتم تعديل حقل واحد أو أكثر من مواد عمل الدورة التدريبية.

مورد REST: v1.courses.courseWorkMaterials.addOnAttachments

الطُرق
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
تنشئ مرفق إضافة أسفل مشاركة.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
يؤدي هذا الإجراء إلى حذف مرفق إضافة.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
تعرض مرفق إضافة.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
تعرض جميع المرفقات التي تم إنشاؤها بواسطة إضافة ضمن المشاركة.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
تعدّل مرفق إضافة.

مورد REST: v1.courses.posts

الطُرق
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
توفر هذه الطريقة البيانات الوصفية لإضافات Classroom في سياق مشاركة محدّدة.

مورد REST: v1.courses.posts.addOnAttachments

الطُرق
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
تنشئ مرفق إضافة أسفل مشاركة.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
يؤدي هذا الإجراء إلى حذف مرفق إضافة.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
تعرض مرفق إضافة.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
تعرض جميع المرفقات التي تم إنشاؤها بواسطة إضافة ضمن المشاركة.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
تعدّل مرفق إضافة.

مورد REST: v1.courses.posts.addOnAttachments.studentSubmissions

الطُرق
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
تعرض الرسالة التي أرسلها الطالب لمرفق إضافة.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
تعدّل البيانات المرتبطة بإرسال مرفق إضافة.

مورد REST: v1.courses.students

الطُرق
create POST /v1/courses/{courseId}/students
تتم إضافة مستخدم كطالب في دورة تدريبية.
delete DELETE /v1/courses/{courseId}/students/{userId}
يؤدي هذا الإجراء إلى حذف طالب في دورة تدريبية.
get GET /v1/courses/{courseId}/students/{userId}
تعرض هذه الدالة طالبًا في دورة تدريبية.
list GET /v1/courses/{courseId}/students
تعرض قائمة طلاب هذه الدورة التدريبية المسموح لمقدّم الطلب بالاطّلاع عليها.

مورد REST: v1.courses.teachers

الطُرق
create POST /v1/courses/{courseId}/teachers
تنشئ مُعلّمًا لدورة تدريبية.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
إزالة المعلّم المحدّد من الدورة التدريبية المحدّدة
get GET /v1/courses/{courseId}/teachers/{userId}
تعرض مدرس دورة تدريبية.
list GET /v1/courses/{courseId}/teachers
تعرض قائمة بالمعلّمين في هذه الدورة التدريبية المسموح لمقدّم الطلب بالاطّلاع عليها.

مورد REST: v1.courses.topics

الطُرق
create POST /v1/courses/{courseId}/topics
ينشئ موضوعًا.
delete DELETE /v1/courses/{courseId}/topics/{id}
لحذف موضوع.
get GET /v1/courses/{courseId}/topics/{id}
تعرض موضوعًا.
list GET /v1/courses/{courseId}/topics
تعرض قائمة المواضيع التي يُسمح لمقدّم الطلب بالاطّلاع عليها.
patch PATCH /v1/courses/{courseId}/topics/{id}
لتعديل حقل واحد أو أكثر من الموضوع.

مورد REST: v1.invitations

الطُرق
accept POST /v1/invitations/{id}:accept
يتم قبول الدعوة وإزالتها وإضافة المستخدم الذي تمت دعوته إلى المعلّمين أو الطلاب (حسب الحاجة) في الدورة التدريبية المحدّدة.
create POST /v1/invitations
إنشاء دعوة.
delete DELETE /v1/invitations/{id}
يؤدي هذا الإجراء إلى حذف دعوة.
get GET /v1/invitations/{id}
تعرض دعوة.
list GET /v1/invitations
تعرض قائمة بالدعوات التي يُسمح للمستخدم صاحب الطلب بالاطّلاع عليها، وتقتصر على الدعوات التي تتطابق مع طلب القائمة.

مورد REST: v1.registrations

الطُرق
create POST /v1/registrations
تنشئ السمة Registration، ما يؤدي إلى بدء Classroom في إرسال الإشعارات من feed المتوفّر إلى الوجهة المحدّدة في cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
يؤدي هذا الإجراء إلى حذف Registration، ما يؤدي إلى توقف Classroom عن إرسال إشعارات بشأن Registration.

مورد REST: v1.userProfiles

الطُرق
get GET /v1/userProfiles/{userId}
تعرض الملف الشخصي للمستخدم.

مورد REST: v1.userProfiles.guardianInvitations

الطُرق
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
يتم إنشاء دعوة للوصي وإرسال رسالة إلكترونية إلى الوصي لمطالبته بتأكيد أنّه الوصي على الطالب.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
تعرض دعوة وصي محدد.
list GET /v1/userProfiles/{studentId}/guardianInvitations
تعرض قائمة بدعوات الأوصياء التي يُسمح للمستخدم مقدِّم الطلب بالاطّلاع عليها، وتتم فلترتها حسب المَعلمات المقدَّمة.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
يعدِّل هذا الإعداد دعوة الوصي.

مورد REST: v1.userProfiles.guardians

الطُرق
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
يؤدي هذا الإجراء إلى حذف وصي.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
تعرض وصيًا محددًا.
list GET /v1/userProfiles/{studentId}/guardians
تعرض قائمة الأوصياء الذين يُسمح للمستخدم الذي أرسل الطلب بالاطّلاع عليه، وتقتصر على أولئك الذين يطابقون الطلب.