Google Classroom API

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

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

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

المستند الخاص بالاكتشاف

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

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

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