Google Classroom API

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

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

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

المستند المرتبط بميزة "اقتراحات"

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

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

نقطة نهاية الخدمة هي عنوان 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}
تعرِض هذه السمة عملًا أرسله طالب لإضافة مرفق.
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

الطُرق
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
تعرِض هذه السمة قائمة بالأوصياء المسموح للمستخدم المُقدّم للطلب بالاطّلاع عليها، مع الحصر في أولئك الذين يتطابقون مع الطلب.