Google Classroom API

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

שירות: classroom.googleapis.com

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

מסמך Discovery

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

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

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

  • https://classroom.googleapis.com

משאב REST: v1.courses

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

Methods
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

Methods
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

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
הפונקציה מחזירה את הערך True אם המשתמש יכול להשתמש ביכולת שצוינה ב-Classroom, ואת הערך False אם הוא לא יכול.
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
מחזירה רשימה של אפוטרופסים שהמשתמש ששולח את הבקשה מורשה לראות, רק אם הם תואמים לבקשה.