Google Classroom API

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

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

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

مستند Discovery

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

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

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

  • https://classroom.googleapis.com

مرجع REST: v1.courses

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

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

الطُرق
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.annuncments.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.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.post

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

مورد REST: v1.courses.post.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.المشاركات.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.guardianInvites

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