ה-API של Classroom מספק ממשק RESTful לניהול קורסים ורשימות התלמידים ב-Google Classroom. בנוסף, לחצן השיתוף ב-Classroom מאפשר למפתחים ולבעלי תוכן להפעיל את שיתוף התוכן שלהם ב-Classroom.
מי יכול להשתמש בממשק ה-API?
מנהלי דומיינים ב-Google Workspace for Education יכולים להשתמש ב-API כדי להקצות קורסים באופן פרוגרמטי מטעם מורים, לסנכרן מערכות מידע של תלמידים עם Classroom ולקבל מידע בסיסי על הכיתות שנלמדות בדומיין.
מפתחי אפליקציות יכולים להשתמש ב-Classroom API כדי לשלב את האפליקציות שלהם ב-Classroom. האפליקציות האלה צריכות להשתמש ב-OAuth 2.0 כדי לבקש ממורים הרשאה להציג כיתות ורשימות תלמידים. אדמינים יכולים להגביל את האפשרות של מורים ותלמידים בדומיין שלהם להרשות לאפליקציות לגשת לנתונים שלהם ב-Google Classroom.
בעלי אתרים ומפתחי תוכן יכולים להשתמש בלחצן השיתוף ב-Classroom כדי לאפשר לתלמידים ולמורים לשתף תוכן חזרה ב-Classroom.
כל השילובים של לחצני השיתוף ב-API וב-Classroom צריכים לעמוד בהנחיות המיתוג של Classroom.
סקירה כללית על ממשקי API
ה-Classroom API כולל כמה סוגי ישויות שתואמות לכיתות, למורים ולתלמידים בממשק של Classroom. לחלק מהישויות האלה יש מאפיינים נוספים שהם ספציפיים ל-API, בנוסף למה שקיים ב-Classroom. סוגי הישויות הראשיות הם:
מידע מפורט על המשאבים והשיטות של ה-API זמין ב חומרי העזר של Classroom API.
מטא-נתונים וכינויים של קורס
קורסים מייצגים כיתה, למשל "מ'. המתמטיקה של סמית' בחלק הרביעי," והמורים שהוקצו לו, רשימת התלמידים והמטא-נתונים. כל קורס מזוהה באמצעות מזהה ייחודי שהוקצה על ידי השרת. המשאב של הקורס כולל באופן ספציפי את כל המטא-נתונים של הקורס, כמו השם, התיאור, המיקום והשעה. רשימות התלמידים לקורסים מנוהלות באמצעות המשאבים תלמידים, מורים והזמנות וגם השיטות שלהם.
כינויים הם מזהים חלופיים לכיתה שעשויים להיות משויכים לקורס ומשמשים במקום המזהה הייחודי. כל כתובת אימייל חלופית קיימת במרחב שמות שמגביל את המשתמשים שיכולים ליצור ולהציג אותו. יש תמיכה בשני מרחבי שמות:
- דומיין: מרחב השמות של הדומיינים שימושי ליצירת כינויים שכל המשתמשים צריכים גישה אליהם, אבל לא ספציפיים לתוכנה מסוימת. לדוגמה, צריך ליצור במרחב השמות של הדומיינים דפים עסקיים חלופיים לקורס, כמו MATH 127 ו-COMSCI 127. רק מנהלי דומיינים יכולים ליצור כינויים במרחב השמות של הדומיין, אבל הם גלויים לכל המשתמשים בדומיין.
- פרויקט מפתח: מרחב השמות של פרויקט הפיתוח שימושי לניהול כינויים ספציפיים לאפליקציה. לדוגמה, אפליקציה שמשתמשת במזהים חלופיים לקורסים יכולה ליצור כתובות חלופיות כדי למפות את המזהה שלה לקורסים ב-Classroom. הכינויים שנוצרים במרחב השמות הזה קשורים למסוף Google API ספציפי. כל משתמש באפליקציה יכול ליצור ולהציג כינויים במרחב השמות של פרויקט הפיתוח של האפליקציה הזו.
למידע נוסף על ניהול מטא-נתונים וכינויים של קורסים, ראו ניהול קורסים.
רשימות משתמשים לקורסים
תלמידים ומורים הם מיפויים ספציפיים בין פרופיל משתמש לקורס, שמייצגים את התפקיד של המשתמש בקורס. ההקצאות של תלמידים ומורים אינן גלובליות: אפשר להקצות משתמש כמורה בקורס אחד וכתלמיד/ה בקורס אחר. הסיווג 'תלמיד' או 'מורה' מייצג קבוצה של הרשאות למשתמש מסוים בקורס מסוים.
- סטודנטים
משאב לתלמידים מייצג משתמש שנרשם כתלמיד ב:
קורס ספציפי. התלמידים יכולים להציג את פרטי הקורס ואת המורים של הקורס.
- מורים
משאב למורה מייצג משתמש שמלמד קורס ספציפי.
מורים יכולים להציג ולשנות את פרטי הקורס, להציג מורים ותלמידים ולנהל מורים ותלמידים נוספים.
הזמנות והשיטות שמשויכות אליהן מאפשרות להוסיף בקלות תלמידים ומורים לקורסים. יצירת הזמנות מאפשרת למשתמשים לבחור אם להצטרף לקורס או לא, במקום להוסיף אותם ישירות דרך המשאבים למורים ולתלמידים.
UserProfiles מייצגים מיפוי לפרופיל דומיין של משתמש, שמזוהה לפי המזהה הייחודי או כתובת האימייל של המשתמש שהוחזר על ידי Directory API. המשתמש הנוכחי יכול גם להפנות למזהה שלו באמצעות הקיצור "me".
מידע נוסף על ניהול רשימות תלמידים זמין במאמר ניהול מורים ותלמידים.
עבודת הקורס והגשות של תלמידים
פריט CourseWork מייצג משימה יחידה שהוקצתה לקבוצת תלמידים בקורס. הדוח כולל פרטים כמו תיאור, תאריך יעד וחומרים, וגם מטא-נתונים כמו שעת היצירה. החומרים כוללים שם, תמונה ממוזערת וכתובת URL, וגם מזהה שאפשר להשתמש בו עם ממשקי ה-API המתאימים (כמו Drive ו-YouTube).
הפריטים ב-CourseWork מתארים אחד מסוגי המשימות הבאים:
- מטלה שהתלמידים ממלאים על ידי הגשת גיליונות עבודה או קבצים מצורפים אחרים.
- שאלה שיש להשיב עליה בתשובה קצרה או שאלה אמריקאית.
עבודות של תלמידים בפריט ב-CourseWork מיוצגות על ידי StudentSubmission. הוא כולל תשובה ומטא-נתונים נוספים, כמו מצב והציון שהוקצה.
התוכן של הודעת תלמיד הגשה תלוי בסוג הפריט המתאים ב-CourseWork:
- גיליונות העבודה והקבצים המצורפים למטלה, כולל השם, התמונה הממוזערת וכתובת ה-URL שלהם, וכן מזהים שניתן להשתמש בהם עם ממשקי ה-API המתאימים כמו Drive או YouTube.
- תשובה לשאלה שיש להשיב עליה בתשובה קצרה או לשאלה אמריקאית.
מידע נוסף על ניהול עבודות לכיתה והגשות של תלמידים זמין במאמר ניהול עבודות.
תוספים ל-Classroom
תוסף הוא ממשק משתמש וקצה עורפי שמוצגים על ידי שותף בדרך כלל ב-iframe. תוספים מופיעים כקבצים מצורפים בפוסט, שיכול להיות
Announcements, CourseWork, או CourseWorkMaterials.
קבצים מצורפים של תוספים יכולים להיות פעילות או תוכן.
- כדי לצרף את הפעילויות, התלמיד או התלמידה צריכים למלא ולהגיש מטלות שהם הגישו. לדוגמה: חידונים, שרטוטים או משחקים. אפשר גם לתת ציון על פעילות.
- אין צורך לשלוח את התלמיד כדי לצפות בקבצים מצורפים של תוכן. התלמיד/ה לא צריך/ה להגיש את הקובץ המצורף ולא נותנים לו ציון. לדוגמה: תמונות, מאמרים וסרטונים.
מידע נוסף זמין במדריכים לפיתוח תוספים.
מדריכים למתחילים
אם אתם רוצים להגדיר את הסביבה ולהתחיל מיד להשתמש ב-API, תוכלו להיעזר באחד מהמדריכים הבאים:
ניסוי עם Google APIs Explorer
כדי להתנסות בשיטות קריאה על נתונים בזמן אמת, אפשר להשתמש ב-Google APIs Explorer. לא צריך לכתוב קוד כדי להתחיל, אבל חשוב לזכור שפעולות שמבצעים באמצעות APIs Explorer יכולות לשנות נתונים קיימים.
אחת מהדרכים להתחיל להפעיל את השיטות היא לבצע קריאה ל-method courses.list(). לשיטה הזו לא נדרשים פרמטרים של בקשה, ואפשר לאחזר
ערך id מהרשימה של הקורסים שהוחזרו כדי להשתמש בו כפרמטר הבקשה
לקריאות אחרות ל-API. אם אין לכם קורסים, אפשר ליצור קורסים באמצעות השיטה courses.create().
אפשר גם לעיין בחומרי העזר של ה-API.