Google Classroom API

ניהול הכיתות, מצבי התלמידים וההזמנות ב-Google Classroom.

שירות: classroom.googleapis.com

כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי לקרוא לשירות הזה, צריך להשתמש במידע הבא כששולחים את בקשות ה-API.

מסמך Discovery

מסמך Discovery הוא מפרט שקריא למכונות, שמתאר ממשקי API ל-REST ומאפשר להשתמש בהם. הוא משמש ליצירת ספריות לקוח, יישומי פלאגין ל-IDE וכלים אחרים שמקיימים אינטראקציה עם Google APIs. שירות אחד יכול לספק כמה מסמכי Discovery. השירות הזה מספק את מסמך הגילוי הבא:

נקודת קצה של שירות

נקודת קצה של שירות היא כתובת URL בסיסית שצוינה בה כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה של שירות. לשירות הזה יש את נקודת הקצה הבאה, וכל מזהי ה-URI הבאים הם יחסיים לנקודת הקצה הזו:

  • https://classroom.googleapis.com

משאב REST: v1.courses

Methods
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
הפונקציה מחזירה את הערך 'true' אם המשתמש זכאי ליצור קבצים מצורפים של תוספים בקורס נתון.
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

Methods
create POST /v1/courses/{courseId}/aliases
יצירת כינוי לקובץ קורס.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
מחיקה של כתובת אימייל חלופית של קורס.
list GET /v1/courses/{courseId}/aliases
הפונקציה מחזירה רשימה של כינויים של קורס.

משאב REST: v1.courses.announcements

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
אחזור מטא-נתונים של תוספים ל-Classroom בהקשר של פוסט ספציפי.

משאב REST: v1.courses.posts.addOnAttachments

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
create POST /v1/registrations
יוצרת Registration, וכתוצאה מכך מערכת Classroom מתחילה לשלוח התראות מה-feed שצוין ליעד שצוין ב-cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
מחיקת Registration, וכתוצאה מכך Classroom יפסיק לשלוח התראות לגבי Registration הזה.

משאב REST: v1.userProfiles

Methods
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
הפונקציה מחזירה אם משתמש יכול להשתמש ביכולת שצוינה ב-Classroom.
get GET /v1/userProfiles/{userId}
הפונקציה מחזירה פרופיל משתמש.

משאב REST: v1.userProfiles.guardianInvitations

Methods
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

Methods
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
מחיקה של אפוטרופוס.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
הפונקציה מחזירה אפוטרופוס ספציפי.
list GET /v1/userProfiles/{studentId}/guardians
הפונקציה מחזירה רשימה של הורים או אפוטרופוסים שהמשתמש המבקש מורשה לראות, ומוגבלת לאלה שתואמים לבקשה.