Google Classroom API

کلاس‌ها، فهرست‌های ثبت‌نام‌شدگان، و دعوت‌ها را در Google Classroom مدیریت می‌کند.

سرویس: classroom.googleapis.com

برای فراخوانی این سرویس، توصیه می‌کنیم از کتابخانه‌های کارخواه ارائه‌شده توسط Google استفاده کنید. اگر برنامه شما برای فراخوانی این سرویس باید از کتابخانه‌های خودتان استفاده کند، هنگام درخواست‌های API از اطلاعات زیر استفاده کنید.

سند اکتشاف

سند اکتشاف مشخصاتی ماشین‌خوانا برای توصیف و مصرف میاناهای برنامه‌سازی کاربردی REST است. از آن برای ساختن کتابخانه‌های کارخواه، افزایه‌های IDE، و ابزارهای دیگری که با Google API تعامل دارند استفاده می‌شود. یک سرویس ممکن است چندین سند اکتشاف ارائه دهد. این سرویس سند اکتشاف زیر را ارائه می‌دهد:

نقطه پایان سرویس

نقطه پایان سرویس نشانی وب پایه‌ای است که نشانی شبکه سرویس میانای برنامه‌سازی کاربردی را مشخص می‌کند. یک سرویس ممکن است چندین نقطه پایانی سرویس داشته باشد. این سرویس دارای نقطه پایانی سرویس زیر است و همه شناسه منابع یکسان زیر مربوط به این نقطه پایانی سرویس هستند:

  • 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
فهرستی از سرپرستان را که کاربر درخواست‌کننده مجاز به مشاهده آن‌ها است برمی‌گرداند، محدود به مواردی که با درخواست مطابقت دارند.