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

גרסה 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 הופעלו ממטלה שהועתקה או מקורס שהועתק, התוסף אמור להציג קובץ מצורף חדש שהתלמיד צריך להשלים, ולא להציג ב-iframe את התשובות של התלמידים ממטלות או קורסים קודמים.	מומלצת
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 ל- מומלץ.
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 השתנה מ-REQUIRED ל-Recommended.
5.1	השדה 'חובה' השתנה ל'מומלץ'.
5.3	נוספה השאלה 'אם התוספים יוצאים מה-iframe, חייבת להיות תצוגה מקדימה שלהם. על המשימה ב-iframe."
5.4	נוספה השאלה 'אם התוסף יקפוץ מחוץ ל-iframe, אמורה להופיע הנחיה לתלמידים לחזור ל-Classroom."
8.1	נוספה ההודעה 'אם המכשיר לא נתמך, חייבת להופיע הודעה משתמש כדי להודיע לו שהמכשיר לא נתמך, ורצוי. ."
8.2	העבודה של תלמידים בנייד השתנתה מ'חובה' ל'מומלץ'.
גרסה 0.1	תאריך העדכון: 22 בספטמבר 2021
	גרסה ראשונית.