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

גרסה 1.1, 5 בדצמבר 2024.

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

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

דרישות

מזהה			סוג
1.0	רישיון למשתמש קצה (אם רלוונטי)
	1.1	כשלמשתמש אין רישיון, צריכה להופיע לו הודעה ידידותית למשתמש. בהודעה צריך לציין בבירור את הסיבה לכך שאי אפשר להשתמש בתוסף, ולהציע למשתמש דרך לפתור את הבעיה.	מומלצת
	1.3	בדף התוסף ב-Google Workspace Marketplace, צריך לציין פרטים על דרישות הרישיון והמינוי שעשויות להיות נדרשות לשימוש בתוסף. אם למוצר ההרחבה יש שכבה בתשלום, ברשימה בזירת המסחר צריך להופיע קישור לדף אינטרנט עם מידע נוסף על התמחור או על אופן הפנייה למנהל מכירות.	מומלצת
2.0	כניסה של משתמשי קצה
	2.1	משתמשים בתפקיד מורה חייבים להיכנס לתוסף באמצעות SSO של Google. אם משתמשים בסטטוס 'תלמיד/ה' מתבקשים להיכנס לתוסף, הם חייבים להיכנס באמצעות SSO של Google.	חובה
	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.	חובה
4.0	גילוי קבצים מצורפים
	4.1	אם התלמידים צריכים לשלוח קבצים מצורפים, הקבצים האלה חייבים לכלול את התג studentWorkReviewUri כדי שייחשב כקבצים מצורפים מסוג 'פעילות' ולא כקבצים מצורפים מסוג 'תוכן'.	חובה
	4.2	ה-iframe של Attachment Discovery חייב לספק ממשק משתמש שמציע לפחות אחת מהאפשרויות הבאות: יצירת תוכן חדש לצרף איך בודקים, בוחרים ומצרפים תוכן מספריית תוכן הוראות לצרף תוכן מהאתר או ממוצרים אחרים	חובה
	4.3	המורה אמור להיות מסוגל למצוא את כל התוכן או הפעילויות שזמינים לו ולגשת אליהם.	מומלצת
	4.4	המורה אמור להיות מסוגל לראות תצוגה מקדימה של התוכן או הפעילות לפני שהוא מתחייב לצרף אותם למטלה.	מומלצת
	4.5	אם המורה צריך ליצור תוכן או פעילות לפני שהוא יכול לצרף אותם, הוא צריך להשלים את העבודה הזו ב-iframe.	מומלצת
5.0	תצוגת התלמיד/ה
	5.1	כשה-studentViewUri מופעל, התוסף לא אמור להוציא את המשתמש מתוך ה-iframe כדי להשלים משימה. אם התוסף כן מוציא את המשתמש מתוך ה-iframe, חייבת להופיע הודעה או סימן אחר כדי שהתלמידים יחזרו ל-Classroom.	מומלצת
	5.2	אם פעילות של תוסף קופצת מתוך ה-iframe, אמורה להופיע תצוגה מקדימה של המשימה ב-iframe.	מומלצת
	5.3	אם קיים, לחצן או קישור בפעילות עם הכיתוב הגשה חייבים לגרום לבקשת API להגשת העבודה של התלמיד/ה לבדיקה של המורה.	חובה
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.1	תאריך העדכון האחרון: 5 בדצמבר 2024
1.1, ‏ 1.3, ‏ 3.2, ‏ 3.10, ‏ 4.4, ‏ 5.2	השינויים: מ-נדרש ל-מומלץ.
3.12	הנושא הוסר.
5.3	ניסוח מחדש. שינוי שנעשה לאחרונה מאפשר למפתחי תוספים להגיש בצורה מהימנה את המטלות של התלמידים באמצעות ה-API.
גירסה 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. בנוסף, השינויים מ-נדרש ל-מומלץ.
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
	הגרסה הראשונית.