کلاسها، فهرستها و دعوتنامهها را در Google Classroom مدیریت میکند.
- منبع REST: v1.courses
- منبع REST: v1.courses.aliases
- منبع REST: v1.courses.announcements
- منبع REST: v1.courses.announcements.addOnAttachments
- منبع REST: v1.courses.courseWork
- منبع REST: v1.courses.courseWork.addOnAttachments
- منبع REST: v1.courses.courseWork.addOnAttachments.studentSubmissions
- منبع REST: v1.courses.courseWork.rubrics
- منبع REST: v1.courses.courseWork.studentSubmissions
- منبع REST: v1.courses.courseWorkMaterials
- منبع REST: v1.courses.courseWorkMaterials.addOnAttachments
- منبع REST: v1.courses.posts
- منبع REST: v1.courses.posts.addOnAttachments
- منبع REST: v1.courses.posts.addOnAttachments.studentSubmissions
- منبع REST: v1.courses.students
- منبع REST: v1.courses.teachers
- منبع REST: v1.courses.topics
- منبع REST: v1.invitations
- منبع REST: v1.registrations
- منبع REST: v1.userProfiles
- منبع REST: v1.userProfiles.guardianInvitations
- منبع REST: v1.userProfiles.guardians
خدمات: classroom.googleapis.com
برای تماس با این سرویس، توصیه می کنیم از کتابخانه های سرویس گیرنده ارائه شده توسط Google استفاده کنید. اگر برنامه شما نیاز به استفاده از کتابخانه های خود برای فراخوانی این سرویس دارد، هنگام درخواست API از اطلاعات زیر استفاده کنید.
سند کشف
Discovery Document یک ویژگی قابل خواندن توسط ماشین برای توصیف و مصرف API های REST است. از آن برای ساخت کتابخانه های سرویس گیرنده، پلاگین های IDE و سایر ابزارهایی که با Google API در تعامل هستند استفاده می شود. یک سرویس ممکن است چندین سند کشف را ارائه دهد. این سرویس سند کشف زیر را ارائه می دهد:
نقطه پایان خدمات
نقطه پایانی سرویس یک URL پایه است که آدرس شبکه یک سرویس API را مشخص می کند. یک سرویس ممکن است چندین نقطه پایانی سرویس داشته باشد. این سرویس دارای نقطه پایانی سرویس زیر است و همه 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 فهرستی از نگهبانانی را برمیگرداند که کاربر درخواستکننده مجاز به مشاهده آنها است، محدود به مواردی که با درخواست مطابقت دارند. |