גרסה 1.1, 5 בדצמבר 2024.
הקריטריונים שבדף הזה חלים על כל תוספי Classroom. כדי שהתוסף שלכם יאושר לפרסום ב-Google Workspace Marketplace ויופיע כתוסף ש "פועל עם Classroom", הוא חייב לעמוד בכל הדרישות הרלוונטיות.
מילות המפתח MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY ו-OPTIONAL במסמך הזה יפורשו כמו שמתואר ב-RFC 2119.
דרישות
| מזהה | סוג | ||
|---|---|---|---|
| 1.0 | רישיון למשתמשי קצה (אם רלוונטי) | ||
| 1.1 | אם למשתמש אין רישיון, צריך להציג לו הודעה ידידותית. בהודעה צריך לציין באופן ברור את הסיבה לכך שאי אפשר להשתמש בתוסף, ולהציע למשתמש דרך פעולה לתיקון המצב. | מומלצת | |
| 1.3 | בדף של התוסף ב-Google Workspace Marketplace צריכים להיות פרטים על דרישות הרישיון והמינוי שעשויות להידרש לשימוש בתוסף. אם לתוסף יש רמת מינוי בתשלום, בדף המוצר ב-Marketplace צריך להיות קישור לדף אינטרנט עם מידע נוסף על התמחור או על הדרך ליצור קשר עם נציג מכירות. | מומלצת | |
| 2.0 | כניסה של משתמשי קצה | ||
| 2.1 | משתמשים עם תפקיד מורה חייבים להיכנס לתוסף באמצעות SSO של Google. אם משתמשים עם תפקיד תלמיד מתבקשים להיכנס לתוסף, הם חייבים להיכנס באמצעות SSO של Google. |
חובה | |
| 2.2 | התוסף חייב להשתמש ב-SSO של Google כדי לחבר משתמש באופן אוטומטי בביקורים הבאים בלי להציג בקשת כניסה. אם רמז הכניסה לא תואם למשתמש שמחובר כרגע, התוסף חייב להציג למשתמש כפתור כניסה ולהעביר את 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 | Attachment Discovery | ||
| 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 | אם יש לחצן או קישור בפעילות עם התווית הגשה, הם חייבים לגרום לשליחת בקשת API להגשת העבודה של התלמיד לבדיקה של המורה. | חובה | |
| 6.0 | Teacher View | ||
| 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 | אם אתם משתמשים בשילוב של כלי מטלות כדי ליצור מטלות מחוץ ל-Classroom, מומלץ ליצור קבצים מצורפים של תוספים כברירת מחדל לכל הקישורים שתואמים לתוסף שלכם. | מומלצת | |
יומן שינויים
| גרסה 1.1 | תאריך העדכון: 5 בדצמבר 2024 |
| 1.1, 1.3, 3.2, 3.10, 4.4, 5.2 | השתנה מ-REQUIRED ל-RECOMMENDED. |
| 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. השתנה גם מ-REQUIRED ל-RECOMMENDED. |
| 4.4 | המספר שונה, היה 4.3. |
| 4.5 | המספר שונה, היה 4.4. |
| 5.2 | המספר שונה, היה 5.3. |
| 5.3 | מספר חדש, היה 5.2. |
| 9.1 | הוספנו המלצה לשדרג קישורים שהודבקו לקבצים מצורפים. |
| 9.2 | הוספנו המלצה ליצור קבצים מצורפים של תוספים כברירת מחדל כשיוצרים מטלות בכלי המטלות באופן פרוגרמטי. |
| 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 | השתנה מ-REQUIRED (חובה) ל-RECOMMENDED (מומלץ). |
| 5.3 | נוסף המשפט 'אם התוספים קופצים מתוך ה-iframe, חובה להציג תצוגה מקדימה של המשימה ב-iframe'. |
| 5.4 | הוספנו את המשפט 'אם התוסף קופץ מתוך ה-iframe, אמורה להופיע הנחיה לתלמידים לחזור ל-Classroom'. |
| 8.1 | הוספנו את הטקסט הבא: "אם המכשיר לא נתמך, חובה להציג למשתמש הודעה שמציינת שהמכשיר לא נתמך, ורצוי גם לציין אילו מכשירים נתמכים". |
| 8.2 | העבודה של התלמיד/ה בנייד השתנתה מ'חובה' ל'מומלצת'. |
| גרסה 0.1 | עודכן ב-22 בספטמבר 2021 |
| זו הגרסה הראשונה. |