דרישות לגבי תוספים

גרסה 1.0, 30 באפריל 2024.

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

יש לפרש את מילות המפתח 'חובה', 'אסור', 'נדרש', 'חייב', 'אסור', 'צריך', 'אסור', 'מומלץ', 'יכול להיות' ו'אופציונלי' במסמך הזה כפי שמתואר ב-RFC 2119.

דרישות

מזהה סוג
1.0 רישיון למשתמש קצה (אם רלוונטי)
  1.1 אם אין למשתמש רישיון, חובה להציג הודעה ידידותית למשתמש. ההודעה חייבת לציין בבירור את הסיבה לכך שלא ניתן להשתמש בתוסף, ולהציע למשתמש דרך לפתור את הבעיה. חובה
  1.3 חובה לציין בדף המוצר של התוסף ב-Google Workspace Marketplace פרטים על דרישות הרישוי שעשויות להיות נדרשות לשימוש בתוסף. אם לתוסף יש רמה בתשלום, דף האפליקציה ב-Marketplace חייב לכלול קישור לדף אינטרנט שמספק מידע נוסף על תמחור או הוראות ליצירת קשר עם איש מכירות. חובה
2.0 כניסה של משתמשי קצה
  2.1 משתמשים בעלי תפקיד מורה חייבים להיכנס לתוסף באמצעות Google SSO.
אם תופיע בקשה למשתמשים בעלי תפקיד תלמיד להיכנס לתוסף, הם חייבים להיכנס באמצעות Google SSO.
חובה
  2.2 התוסף חייב להשתמש ב-Google SSO כדי להכניס משתמשים באופן אוטומטי בביקור הבא, בלי להציג הנחיה להתחברות.
אם ההנחיה להתחברות לא תוביל להתאמה למשתמש שנכנס כרגע, התוסף חייב להציג למשתמש לחצן התחברות ולהעביר את login_hint לספריית האימות כדי לסנן חשבונות לא חוקיים.
חובה
  2.7 כשהמשתמש ב-Classroom עדיין לא מחובר לתוסף (כפי שנקבע ברמז ההתחברות), התוסף חייב להציג לחצן 'כניסה באמצעות חשבון Google' כדי לבצע פעולה מפורשת של המשתמש כדי להפעיל את תהליך הכניסה.
הערה: האפשרות הזו נדרשת כדי לעמוד בהנחיות המיתוג של Google, וגם עוזרת להימנע מחסימת חלונות קופצים.
חובה
  2.8 התוסף אמור להציג מי המשתמש שמחובר כרגע. מומלצת
3.0 כללי
  3.1 התוסף חייב לעמוד בהנחיות הכלליות לאישור ב-Google Workspace Marketplace. חובה
  3.2 אם משימה מופעלת בכרטיסייה או בחלון חדשים מכל אחד מהמסלולים ב-iframe, חייבת להופיע בהודעה ידידותית למשתמש כדי לחזור אל Classroom. חובה
  3.3 המשתמש חייב להשלים את התהליך רק באמצעות תהליך עבודה של תוסף, ולא לעבור לתהליך עבודה של עבודות או להשתמש בלחצן השיתוף ב-Classroom. חובה
  3.4 בחירה של לוקליזציה: השפה אמורה להתבסס על ההעדפה המקומית שהוגדרה בדפדפן, אם היא זמינה. מומלצת
  3.5 אם בתוסף מוגדר הערך maxPoints, חובה להגדיר גם את הערך pointsEarned כשתלמידים מסיימים מטלה באמצעות פרטי הכניסה השמורים של המורה (מומלץ) או כשהמורה פותחת את המטלה ב-iframe של הביקורת על עבודות התלמידים. חובה
  3.9 התוספים צריכים לעמוד בהנחיות של WCAG 2.1 ברמה AA בנושא נגישות. מפתחי התוספים יצטרכו לדווח בעצמם שהם עומדים בדרישות האלה בזמן שליחת התוסף, ושהתוסף ימשיך לעמוד בדרישות גם אחרי שיבוצעו בו שינויים. מומלצת
  3.10 כל השגיאות שהמשתמשים נתקלים בהן חייבות להיות קריאות לבני אדם. חובה
  3.11 אם ה-studentViewUri, ה-teacherViewUri או ה-studentWorkViewUri מופעלים ממטלה או מקורס שהועתק, אסור שהתוסף יציג דף שגיאה ב-iframe. חובה
  3.12 אם ה-studentViewUri, ה-teacherViewUri או ה-studentWorkViewUri מופעלים ממטלה או מקורסים שהועברו, התוסף אמור להציג קובץ מצורף חדש שהתלמיד צריך להשלים, ולא להציג בתיבה המוטמעת תשובות של תלמידים ממטלות או מקורסים קודמים. מומלצת
4.0 גילוי קבצים מצורפים
  4.1 אם התלמידים צריכים לשלוח קבצים מצורפים, הקבצים האלה חייבים לכלול את התג studentWorkReviewUri כדי שהמערכת תתייחס אליהם כקבצים מצורפים מסוג 'פעילות' ולא כקבצים מצורפים מסוג 'תוכן'. חובה
  4.2 ה-iframe של גילוי קבצים מצורפים חייב לספק ממשק משתמש שמציע לפחות אחד מהפריטים הבאים:
  • יצירת תוכן חדש לצרף
  • איך בודקים, בוחרים ומצרפים תוכן מספריית תוכן
  • הוראות לצירוף תוכן מהאתר או ממוצרים אחרים
חובה
  4.3 המורים אמורים להיות מסוגלים למצוא את כל התוכן/הפעילויות שזמינים למורה ולגשת אליהם. מומלצת
  4.4 המורים חייבים להיות מסוגלים לצפות בתצוגה מקדימה של התוכן או הפעילות לפני שהם מתחייבים לצרף אותם למטלה. חובה
  4.5 אם המורה צריך ליצור תוכן או פעילות לפני שהוא יכול לצרף אותם, הוא צריך להשלים את העבודה הזו ב-iframe. מומלצת
5.0 תצוגה לתלמידים
  5.1 כשה-studentViewUri מופעל, התוסף לא אמור להוציא את המשתמש מתוך ה-iframe כדי להשלים משימה.
אם התוסף כן מוציא את המשתמש מתוך ה-iframe, חייבת להופיע הודעה או סימן אחר כדי שהתלמידים יחזרו ל-Classroom.
מומלצת
  5.2 אם פעילות של תוסף קופצת מתוך ה-iframe, חייבת להיות תצוגה מקדימה של המשימה ב-iframe. חובה
  5.3 אם פעילות מסוימת מחייבת את התלמידים לבצע פעולה כדי לסמן שהיא הושלמה, אסור לקרוא ללחצן 'הגשה' כדי למנוע בלבול עם הלחצן 'הגשה' ב-Classroom. חובה
6.0 תצוגת המורה
  6.1 המורה אמור לראות את מה שהתלמיד או התלמידה יראו כשהם יבצעו את המטלה. מומלצת
7.0 ביקורת על עבודות התלמידים
  7.1 אם ה-studentWorkReviewUri יופעל, התוסף חייב להציג את העבודה של התלמיד/ה בתוך ה-iframe כדי שהמורה יוכל לבדוק אותה. תוכן משלים יכול לקשר מחוץ ל-iframe. חובה
  7.2 אסור שהתוסף יאפשר ניווט בין תלמידים בתצוגה studentWorkReviewUri. אסור לנווט בין תלמידים אלא רק בממשק המשתמש של Classroom. חובה
8.0 תמיכה בנייד ב-Classroom
  ‫8.1 כשאפליקציית Classroom לנייד מפעילה teacherViewUri, studentViewUri או studentWorkReviewUri, כתובת ה-URL חייבת לפתוח את אפליקציית הנייטיב לנייד של השותף או את אפליקציית האינטרנט לנייד של השותף, ובכל מקרה ליצור קישור עומק לתצוגה הנכונה. אם המכשיר לא נתמך, חובה להציג למשתמש הודעה על כך שהמכשיר לא נתמך, ובאופן אידיאלי גם על המכשירים הנתמכים. חובה
  ‫8.2 צריך להשלים את העבודה של התלמידים במכשיר נייד. מומלצת
9.0 תכונות נוספות
  9.1 אם המורים יכולים להדביק קישורים לתוכן שלכם כקבצים מצורפים מסוג קישור, עליכם לשדרג את הקישורים לקבצים מצורפים של תוספים. מומלצת
  9.2 אם אתם משתמשים בשילוב עם CourseWork כדי ליצור מטלות מחוץ ל-Classroom, עליכם ליצור קבצים מצורפים של תוספים כברירת מחדל לכל הקישורים שתואמים לתוסף. מומלצת

יומן שינויים

גירסה 1.0 תאריך העדכון האחרון: 30 באפריל 2024
1.1 שילוב של 1.1 ו-1.2 לדרישה אחת.
2.1 שילוב של 2.1 ו-2.5 לדרישה אחת.
2.2 שילוב של 2.2,‏ 2.3 ו-2.4 לדרישה אחת.
3.5 שילבנו את הדרישות 3.5, 3.6 ו-3.7 לדרישות אחת.
3.10 נוספה דרישה שהתוסף אף פעם לא יעבור למצב לא מובן או בלתי ניתן לשחזור.
3.11, 3.12 שילבנו את הדרישות 5.5, 5.6, 6.3, 6.4, 7.5 ו-7.6 לשתי דרישות חדשות.
4.2 הרחבנו את התיאור של חוויות השימוש הקבילות ב'גילוי קבצים מצורפים'.
4.3 מספור מחדש, בעבר 4.2. בנוסף, השינויים מ-REQUIRED ל-RECOMMENDED.
4.4 מספור מחדש, בעבר 4.3.
4.5 מספור מחדש, בעבר 4.4.
5.2 המספר השתנה. בעבר היה זה המספר 5.3.
5.3 מספור מחדש, בעבר 5.2.
9.1 הוספנו המלצה לשדרג קישורים מצורפים לקבצים מצורפים.
9.2 נוספה המלצה ליצור קבצים מצורפים לתוספים כברירת מחדל, כשיוצרים מטלות ב-CourseWork באופן פרוגרמטי.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 הנושא הוסר.
גרסה 0.3 תאריך העדכון האחרון: 22 בנובמבר 2022
2.3 תיקון להנחיות לגבי רמזים להתחברות.
2.4 שילבנו תרחיש שבו יש צורך בהטמעה של hd.
3.2 שינוי הניסוח של 'מתן נתיב'.
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 הוספנו הנחיות מומלצות ודרישות לתוכן של קורס ב-studentViewUri, ב-teacherViewUri וב-studentWorkReviewUri.
גרסה 0.2 עדכון אחרון: 29 באוקטובר 2021
1.3 שינינו את הטקסט כדי להבהיר את הכוונה.
3.1 נוספה ההנחיה "התוסף חייב לעמוד בהנחיות הכלליות לאישור של GWM שמופיעות באתר שלהם".
3.9 ב-WCAG, הסטטוס נדרש השתנה לסטטוס מומלץ.
5.1 שינוי הערך של REQUIRED ל-RECOMMENDED.
5.3 נוספה השאלה 'אם התוספים יוצאים מה-iframe, חייבת להיות תצוגה מקדימה של המשימה ב-iframe.'
5.4 נוספה ההודעה "אם התוסף יוצא מתוך ה-iframe, אמורה להופיע בקשה לתלמידים לחזור ל-Classroom".
‫8.1 נוספה ההודעה "אם המכשיר לא נתמך, חובה להציג למשתמש הודעה על כך שמדובר במכשיר לא נתמך, ובאופן אידיאלי גם לציין אילו מכשירים נתמכים".
‫8.2 האפשרות 'עבודות של תלמידים בנייד' השתנתה מ'חובה' ל'מומלץ'.
גרסה 0.1 עודכן ב-22 בספטמבר 2021
  הגרסה הראשונית.