משאבי API

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

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

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

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

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

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

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

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

‫Courses מייצגות כיתה, כמו M. Smith's 4th period math", וגם את המורים שהוקצו לה, את רשימת התלמידים והמטא-נתונים שלה. כל קורס מזוהה באמצעות מזהה ייחודי שהוקצה על ידי השרת. המשאב Course מכיל את כל המטא-נתונים של הקורס, כמו השם, התיאור, המיקום והזמן. רשימות התלמידים בקורס מנוהלות באמצעות המשאבים Student,‏ Teacher ו-Invitation והשיטות שלהם.

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

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

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

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

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

סטודנטים

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

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

מורים

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

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

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

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

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

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

פריטים בסטרימינג

פריטים בפיד הם חלקי תוכן שפורסמו וששותפו עם חברי הקורס. מפתחים ומורים יכולים ליצור שלושה סוגים של פריטים בפיד: Announcement,‏ CourseWork ו-CourseWorkMaterial.

אנשי ההוראה יוצרים Announcements בחלק העליון של הדף 'עדכונים' בממשק המשתמש של Classroom. מורים יוצרים CourseWork וCourseWorkMaterials בלחיצה על הלחצן יצירה בכרטיסייה 'סביבת למידה'. מפתחים יכולים ליצור את כל סוגי הפריטים בפיד באופן פרוגרמטי באמצעות Classroom API.

המאפיינים הבאים נכונים לגבי פריטים בפיד:

• כל הפריטים בפיד יכולים לכלול חומרי עזר, כמו קבצים מ-Google Drive, סרטונים מ-YouTube, טפסים מ-Google Forms, היפר-קישורים לכתובות URL וקבצים מצורפים של תוספים ל-Classroom.
• אפשר להקצות את כל הפריטים בעדכונים לכיתה לקבוצת משנה של התלמידים בקורס.
• אפשר להגדיר CourseWork עם ציון או ללא ציון. מורים יכולים לשנות את סטטוס הציון של מטלה CourseWork בכל שלב.
• יכול להיות לפריט בפיד יותר מקובץ מצורף אחד.
• פריט בפיד יכול לכלול קבצים מצורפים מסוגים שונים. לדוגמה, יכול להיות שבמטלה אחתCourseWork יהיו קבצים מ-Google Drive, סרטונים מ-YouTube וקבצים מצורפים של תוסף ל-Classroom בו-זמנית.
• יכול להיות שפריט בפיד יכלול קבצים מצורפים של תוספים מכמה מפתחים.
• מפתחים יכולים לקבל ולשנות את הפרטים של כל משאב של פריט בעדכונים לכיתה שיש לו קובץ מצורף של תוסף.
• מפתחים יכולים להגיש מטלה של תלמיד, לבטל את ההגשה שלה או להחזיר אותה לתלמיד אם CourseWorkהמטלה כוללת קובץ מצורף של אחד מהתוספים שלהם.
• מפתחים יכולים לתת ציון סופי רק לעבודות של תלמידים ספציפיים במטלות שהם יצרו.

העתקת פריטים בשידור

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

CourseWork and StudentSubmissions

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

כל משאב 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 מייצגות הוראה לשלוח את ההתראות האלה לאפליקציה שלכם.

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