מבנה API

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

ישות	ייצוג ב-Classroom
קורסים	כיתה, כמו 'מ'. מתמטיקה, שיעור 4, מורה: סמית".
כינויים	מזהה חלופי לקורס.
Invitations	דרך להוסיף משתמשים לכיתה.
תלמידים	תלמיד בכיתה.
מורים	מורה בכיתה.
פרופילי משתמשים	משתמש באופן כללי, מחוץ להקשר של תלמיד או מורה.
CourseWork	מטלה בכיתה.
StudentSubmissions	העבודה של התלמידים במטלה מסוימת, כמו תשובות או גיליונות עבודה.
CourseWorkMaterials	חומרי לימוד לתלמידים בכיתה.
הודעות	הודעה לתלמידים בכיתה.
AddOnAttachment	תוכן או פעילות במטלה או בחומר, שמוצגים בדרך כלל כ-iframe מוטמע.
נושאים	קיבוץ חזותי של מטלות וחומרים בכיתה.
רישומים	הוראה לשלוח התראות לאפליקציה על שינויים בנתונים, כמו רשימת תלמידים.

לרוב המשאבים יש methods של שירות לפעולות רגילות כמו קריאה, עדכון ומחיקה של מכונות של המשאב. לחלק מהמשאבים יש גם שיטות מותאמות אישית לפעולות אחרות, כמו שינוי רשימת התלמידים שהוקצו להם מטלה מסוימת.

למידע מפורט על המשאבים והשיטות של ה-API, עיינו בהפניה של Classroom API.

סקירה כללית של קשרי המשאבים

• הקורס הוא אובייקט הנתונים הבסיסי ב-Google Classroom.
• כינויים משמשים כמזהים חלופיים של Courses.
• הזמנות משמשות כדי להזמין את פרופילים של משתמשים להפוך למורים או תלמידים ב-Course, אבל מנהלי דומיין ב-Google Workspace for Education יכולים גם להוסיף משתמשים ישירות.
• המורים יוצרים פריטים בעדכונים ומשתפים אותם עם התלמידים בקורסים שלהם. סוגי הפריטים האפשריים בסטרימינג הם עבודות, חומרים לעבודות והודעות. אפשר לארגן באופן חזותי את CourseWork ו-CourseWorkMaterials בנושאים, והם יכולים להכיל קבצים מצורפים של תוספים. התלמידים שולחים StudentSubmissions עבור CourseWork שלהם.
• מפתחים יכולים ליצור רישומים כדי לקבל התראות כשחלק מהנתונים האלה משתנים.

Google Classroom זמין בדומיינים שיש להם מינוי ל-Google Workspace for Education. דומיין בהקשר של Classroom מייצג בדרך כלל מחוז של בית ספר. אתם יכולים ליצור דומיין בדיקה ב-Google Workspace for Education למטרות פיתוח. כך תוכלו לשלוט במכונה ייעודית ל-Classroom ללא השפעה על משתמשים אמיתיים.

קורסים וכינויים

Courses מייצגים מחלקה, כמו "M. מתמטיקה, שעה 4, מורה: בן-דוד", ואת המורים, רשימת התלמידים והמטא-נתונים שהוקצו לה. לכל קורס יש מזהה ייחודי שהוקצה על ידי השרת. המשאב Course מכיל במיוחד את כל המטא-נתונים של הקורס, כמו השם, התיאור, המיקום והשעה. רשימות התלמידים של הקורסים מנוהלות באמצעות המשאבים תלמידים, מורים ו-הזמנות והשיטות שלהם.

Aliases הם מזהים חלופיים לכיתה שאפשר לשייך לקורס במקום המזהה הייחודי. כל כינוי נמצא במרחב שמות שמגביל את האנשים שיכולים ליצור אותו ולראות אותו. יש תמיכה בשני מרחבי שמות:

• דומיין: מרחב השמות של הדומיין שימושי ליצירת כתובות חלופיות שכל המשתמשים צריכים גישה אליהן, אבל הן לא ספציפיות לתוכנית אחת. לדוגמה, רשימות חלופיות של קורס, כמו MATH 127 ו-COMSCI 127, צריכות להיווצר במרחב השמות של הדומיין. רק מנהלי דומיינים יכולים ליצור כינויים במרחב השמות של הדומיין, אבל הם גלויים לכל המשתמשים בדומיין.
• פרויקט למפתחים: מרחב השמות של פרויקט למפתחים שימושי לניהול כתובות אימייל חלופיות ספציפיות לאפליקציה. לדוגמה, אפליקציה שמשתמשת במזהים חלופיים לקורסים יכולה ליצור כינויים כדי למפות את המזהה שלה לקורסים ב-Classroom. כינויים שנוצרים במרחב השמות הזה קשורים ל-Google API Console ספציפי. כל משתמש באפליקציה יכול ליצור ולראות כתובות אימייל חלופיות במרחב השמות של פרויקט הפיתוח של האפליקציה.

במאמר ניהול הקורסים תוכלו לקרוא מידע נוסף על ניהול המטא-נתונים והכינויים של הקורסים.

משתמשים ורשימות תלמידים בקורסים

Students ו-Teachers הם מיפויים ספציפיים בין פרופיל משתמש לבין קורס, שמייצגים את התפקיד של המשתמש בקורס. ההגדרות 'תלמיד' ו'מורה' לא גלובאליות: אפשר להקצות משתמש בתור מורה בקורס אחד ובתור תלמיד בקורס אחר. ההגדרה 'תלמיד/ה' או 'מורה' מייצגת קבוצת הרשאות של משתמש מסוים בקורס מסוים.

סטודנטים

משאב Student מייצג משתמש שמשויך כתלמיד לקורס ספציפי.

התלמידים יכולים לראות את פרטי הקורס ואת המורים שלו.

מורים

משאב Teacher מייצג משתמש שמלמד קורס ספציפי.

למורים מותר לראות ולשנות את פרטי הקורס, לראות את המורים והתלמידים ולנהל מורים ותלמידים נוספים.

Invitations והשיטות המשויכות אליו מספקים דרך נוחה להוספת תלמידים ומורים לקורסים. כשיוצרים הזמנות, המשתמשים יכולים לבחור אם להצטרף לקורס או לא, במקום להוסיף אותם ישירות דרך המשאבים למורים ולתלמידים.

UserProfiles מייצג מיפוי לפרופיל הדומיין של המשתמש, כפי שזוהה לפי המזהה הייחודי או כתובת האימייל של המשתמש שהוחזר על ידי Directory API. המשתמש הנוכחי יכול גם להפנות למזהה שלו באמצעות הקיצור "me".

אפשר גם להשתמש בשירות UserProfiles כדי לנהל ולשלוח הזמנות לGuardians, שהוא מיפוי בין תלמיד/ה לבין הורה/ת או אפוטרופוס/ית. להורים ולאפוטרופסים ב-Classroom יש גישה לחלק מהמידע על התלמידים, כמו המטלות שלהם.

מידע נוסף על ניהול כרטיסיות הכיתות זמין במאמר ניהול מורים ותלמידים.

עבודות אקדמיות והגשות של תלמידים

פריט מסוג CourseWork מייצג מטלה אחת שהוקצה לקבוצת תלמידים בקורס. הוא מכיל פרטים כמו תיאור, מועד הגשה וחומרי לימוד, וגם מטא-נתונים כמו זמן היצירה. החומרים כוללים כותרת, תמונה ממוזערת וכתובת URL, וגם מזהה שאפשר להשתמש בו עם ממשקי ה-API המתאימים (למשל, Drive, ‏ YouTube).

הפריטים מסוג CourseWork מתארים אחד מסוגי המשימות הבאים:

• מטלה שהתלמידים משלימים על ידי שליחת גיליונות עבודה או קבצים מצורפים אחרים.
• שאלה שיש להשיב עליה בתשובה קצרה או שאלה אמריקאית.

עבודות של תלמידים לגבי פריט CourseWork מיוצגות על ידי StudentSubmission. הוא מורכב מתשובה וממטא-נתונים נוספים, כמו מצב וציון שהוקצה.

התוכן של StudentSubmission תלוי בסוג הפריט התואם CourseWork:

• גיליונות העבודה והקבצים המצורפים שנשלחו למטלה, כולל השם, התמונה הממוזערת וכתובת ה-URL שלהם, וגם מזהים שאפשר להשתמש בהם בממשקי ה-API המתאימים כמו Drive או YouTube.
• התשובה לשאלה שיש להשיב עליה בתשובה קצרה או לשאלה אמריקאית.

למידע נוסף על ניהול עבודות ותוצרים שהתלמידים הגישו, ראו ניהול עבודות.

חומרים והודעות לגבי עבודות

בדומה ל-CourseWork, השדה CourseWorkMaterials מייצג תוכן שהוקצה לקבוצה של תלמידים בקורס, עם פרטים כמו שם ותיאור, וכן חומרי לימוד. עם זאת, בניגוד ל-CourseWork, ב-CourseWorkMaterials התלמידים לא נדרשים לשלוח פריטים. לכן, אין מועד הגשה ו-StudentSubmissions לא קיים עבור CourseWorkMaterials. למשל, מורים יכולים להשתמש ב-CourseWorkMaterials כדי לפרסם הצעות לחומרי קריאה, תוכנית לימודים או כללי הכיתה.

Announcements מייצגים גם תוכן ששותף עם קבוצת תלמידים, אבל הם לא כוללים פרטים כמו שם, ואי אפשר לארגן אותם לפי Topics כמו CourseWork או CourseWorkMaterials. המורים יכולים להשתמש בהן כדי לפרסם תזכורות או הודעות לכיתה.

נושאים

Topics משמשים לארגון חזותי של CourseWork ו-CourseWorkMaterials בתוך הכיתה. אפשר להשתמש בהם כדי לקבץ מטלות ל'אופציונליות' ו'חובה', או ל'יחידה 1' ו'יחידה 2', לדוגמה.

תוספים ל-Classroom

תוסף הוא ממשק משתמש וצד לקוח שמוצגים בדרך כלל ב-iframe, ומנוהלים על ידי מפתחים. התוספים מופיעים כקבצים מצורפים לפריט בסטרימינג. הפריט במקור הנתונים יכול להיות כל אחד מהסוגים הבאים: Announcements, CourseWork או CourseWorkMaterials. קבצים מצורפים של תוספים מסומנים ב-AddOnAttachment.

קבצים שצורפו לתוספים יכולים להיות פעילות או תוכן.

• כשאתם מצרפים פעילות, התלמידים צריכים להשלים אותה ולהגיש אותה בנפרד. דוגמאות: חידונים, ציורים או משחקים. אפשר גם לתת ציונים על הגשת פעילות.
• כדי לצרף תוכן, אין צורך להגיש את התוכן על ידי התלמיד/ה. התלמידים לא צריכים להגיש את הקובץ המצורף, והוא לא ייבדק. דוגמאות לתכנים כאלה הן תמונות, מאמרים וסרטונים.

מידע נוסף זמין במדריכים לפיתוח תוספים.

רישומים

אפליקציות יכולות להירשם לקבלת התראות כשנתונים מסוימים משתנים ב-Google Classroom. לדוגמה, כשמתעדכנת רשימת התלמידים בכיתה. Registrations מייצג הוראה לשלוח את ההתראות האלה לאפליקציה שלכם.

מידע נוסף זמין במדריך בנושא התראות דחיפה.