Google Classroom API

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

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

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

مستند الاستكشاف

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

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

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

  • https://classroom.googleapis.com

مورد REST: ‏ v1.courses

الطُرق
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
تُرجع هذه الطريقة ما إذا كان المستخدم مؤهلاً لإنشاء مرفقات الإضافات في دورة تدريبية معيّنة.
checkGradingPeriodsSetupEligibility
(deprecated)		 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}
تُرجع هذه الطريقة المرفق الذي أرسله الطالب في الإضافة.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions
تعرض هذه السمة قائمة بأعمال الطلاب التي يُسمح لمقدّم الطلب بالاطّلاع عليها.
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.studentGroups

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

مورد REST: ‏ v1.courses.studentGroups.studentGroupMembers

الطُرق
create POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
تنشئ هذه الطريقة عضوًا في مجموعة طلاب.
delete DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
تحذف هذه الطريقة عضوًا من مجموعة طلاب.
list GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
تعرض هذه الطريقة قائمة بالطلاب في مجموعة.

مورد 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

الطُرق
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
تعرض هذه السياسة ما إذا كان بإمكان المستخدم استخدام ميزة Classroom المحدّدة.
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
تعرض هذه الطريقة قائمة بالأوصياء المسموح للمستخدم الطالب بالاطّلاع عليها، وتقتصر على الأوصياء الذين يتطابقون مع الطلب.