משאבי API

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

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

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

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

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

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

פריטי שידור הם קטעי התוכן שפורסמו וששותפו עם חברי הקורס. מפתחים ומורים יכולים ליצור שלושה סוגים של פריטים בסטרימינג: 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 ו-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 מייצגות הוראה לשלוח את ההתראות האלה לאפליקציה.

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