ניהול של כיתות, רשימות תלמידים והזמנות ב-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
מסמך Discovery הוא מפרט קריא למחשבים לתיאור ולשימוש של ממשקי API ל-REST. הוא משמש לבניית ספריות לקוח, יישומי פלאגין ל-IDE וכלים אחרים שמבצעים אינטראקציה עם ממשקי ה-API של Google. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך הגילוי הבא:
נקודת הקצה של השירות
נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. לשירות אחד עשויות להיות כמה נקודות קצה של השירות. לשירות הזה יש את נקודת הקצה הבאה של השירות, וכל מזהי ה-URI שבהמשך הם יחסיים לנקודת הקצה הזו של השירות:
https://classroom.googleapis.com
מקור מידע ב-REST: v1.courses
שיטות | |
---|---|
checkAddOnCreationEligibility |
GET /v1/courses/{courseId}:checkAddOnCreationEligibility מחזירה אם המשתמש יכול ליצור קבצים מצורפים של תוספים בקורס נתון. |
create |
POST /v1/courses יצירת קורס. |
delete |
DELETE /v1/courses/{id} מוחק קורס. |
get |
GET /v1/courses/{id} מחזיר קורס. |
list |
GET /v1/courses מחזירה רשימה של קורסים שהמשתמש ששלח את הבקשה רשאי לצפות בהם, ומוגבל לקורסים שתואמים לבקשה. |
patch |
PATCH /v1/courses/{id} עדכון של שדה אחד או יותר בקורס. |
update |
PUT /v1/courses/{id} מתבצע עדכון של הקורס. |
מקור מידע ב-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 מחזירה רשימה של אפוטרופוסים שהמשתמש ששלח את הבקשה מורשה להציג. הרשימה מוגבלת רק לאפוטרופוסים שתואמים לבקשה. |