الزامات افزودنی

نسخه 1.0، 30 آوریل 2024.

معیارهای این صفحه برای همه افزونه های Classroom اعمال می شود. برافزای شما باید همه موارد مورد نیاز قابل اجرا را داشته باشد تا برای فهرست شدن در Google Workspace Marketplace و افزونه‌ای که «با Classroom کار می‌کند» تأیید شود.

کلمات کلیدی "باید"، "نباید"، "الزامی"، "باید"، "نباید"، "باید"، "نباید"، "توصیه شده"، "ممکن است" و "اختیاری" در این سند هستند. همانطور که در RFC 2119 شرح داده شده است تفسیر شود.

الزامات

شناسه تایپ کنید
1.0 مجوز کاربر نهایی (در صورت وجود)
1.1 هنگامی که کاربر مجوز ندارد، یک پیام کاربرپسند باید به کاربر نشان داده شود. پیام SHOULD باید به وضوح دلیل عدم استفاده از افزونه را بیان کند و راه کاری را برای اصلاح وضعیت به کاربر پیشنهاد دهد. توصیه می شود
1.3 فهرست Google Workspace Marketplace برای برافزا باید جزئیات مجوز و الزامات اشتراکی را که ممکن است برای استفاده از برافزا مورد نیاز باشد مشخص کند. اگر افزونه دارای یک ردیف پولی است، فهرست بازار باید پیوندی به یک صفحه وب ارائه دهد که اطلاعات بیشتری در مورد قیمت یا نحوه تماس با فروشنده ارائه می دهد. توصیه می شود
2.0 ورود کاربر نهایی
2.1 کاربران معلم باید با استفاده از Google SSO وارد افزونه شوند.
اگر از کاربران دانش‌آموز خواسته می‌شود که به افزونه وارد شوند، باید با استفاده از Google SSO وارد سیستم شوند.
مورد نیاز
2.2 این افزونه باید از Google SSO برای ورود خودکار کاربر در بازدیدهای بعدی بدون نمایش درخواست ورود استفاده کند.
هنگامی که راهنمایی ورود به سیستم با کاربر وارد شده فعلی مطابقت ندارد، افزونه باید از کاربر یک دکمه ورود به سیستم را بخواهد و login_hint را به کتابخانه auth ارسال کند تا حساب‌های نامعتبر را فیلتر کند.
مورد نیاز
2.7 هنگامی که کاربر Classroom از قبل وارد برافزا نشده است (همانطور که با نگاه کردن به راهنمایی ورود مشخص می‌شود)، برافزا باید دکمه «ورود به سیستم با Google» را برای اقدام صریح کاربر برای شروع فرآیند ورود ارائه کند.
توجه : این برای رعایت دستورالعمل‌های برندینگ گوگل ضروری است و همچنین به جلوگیری از مسدودکننده‌های بازشو کمک می‌کند.
مورد نیاز
2.8 افزونه باید نشان دهد که کاربر وارد شده فعلی چه کسی است. توصیه می شود
3.0 ژنرال
3.1 این افزونه باید از دستورالعمل‌های عمومی تأیید Google Workspace Marketplace پیروی کند. مورد نیاز
3.2 اگر یک کار در یک برگه یا پنجره جدید از هر یک از سفرهای iframe راه اندازی شود، باید یک پیام کاربرپسند برای بازگشت به Classroom ارائه دهد. توصیه می شود
3.3 کاربر باید سفر را فقط با استفاده از یک گردش کار افزودنی تکمیل کند و به جریان کار درسی تغییر ندهد یا از دکمه اشتراک‌گذاری کلاس درس استفاده نکند. مورد نیاز
3.4 انتخاب محلی سازی: زبان باید بر اساس اولویت محلی تنظیم شده توسط مرورگر در صورت موجود بودن باشد. توصیه می شود
3.5 اگر یک افزونه maxPoints را تعریف می‌کند، باید pointsEarned نیز تعیین کند که دانش‌آموز یک ارسال را با استفاده از اعتبارنامه‌های ذخیره شده معلم (توصیه می‌شود) تکمیل می‌کند یا زمانی که معلم ارسال را در iframe Student Work Review باز می‌کند. مورد نیاز
3.9 افزونه‌ها باید با دستورالعمل‌های AA سطح 2.1 WCAG در مورد دسترسی مطابقت داشته باشند. توسعه دهندگان افزونه خود گزارش می دهند که این الزام در زمان ارسال برآورده شده است و این افزونه همچنان مطابق با تغییرات آتی افزونه است. توصیه می شود
3.10 هر گونه خطایی که کاربر تجربه می کند باید برای انسان قابل خواندن باشد. توصیه می شود
3.11 اگر studentViewUri ، teacherViewUri ، یا studentWorkViewUri از یک تکلیف کپی شده یا دوره کپی شده راه اندازی شده باشد، افزونه نباید صفحه خطا را در iframe نمایش دهد. مورد نیاز
4.0 کشف پیوست
4.1 اگر پیوستی نیاز به ارسال دانشجو دارد، پیوست باید شامل studentWorkReviewUri باشد تا به عنوان یک نوع فعالیت و نه پیوست نوع محتوا در نظر گرفته شود. مورد نیاز
4.2 ضمیمه Discovery iframe باید یک رابط کاربری ارائه دهد که حداقل یکی از موارد زیر را ارائه دهد:
  • محتوای جدید برای پیوست ایجاد کنید
  • از یک کتابخانه محتوا مرور، انتخاب و پیوست کنید
  • دستورالعمل پیوست کردن محتوای وب سایت یا سایر محصولات
مورد نیاز
4.3 معلم باید بتواند تمام محتوا/فعالیت های در دسترس معلم را پیدا کند و به آنها دسترسی داشته باشد. توصیه می شود
4.4 معلم باید بتواند پیش‌نمایش محتوا/فعالیت را قبل از تعهد به پیوست کردن آن به تکلیف، مشاهده کند. توصیه می شود
4.5 اگر کاری توسط معلم برای ایجاد محتوا/فعالیت قبل از پیوستن لازم باشد، آن کار باید در iframe تکمیل شود. توصیه می شود
5.0 نمای دانشجویی
5.1 وقتی studentViewUri راه‌اندازی می‌شود، افزونه نباید کاربر را از iframe برای تکمیل یک کار بیرون بکشد.
اگر افزونه کاربر را از iframe خارج کند، باید پیام یا نشانه دیگری برای بازگشت دانش آموزان به Classroom وجود داشته باشد.
توصیه می شود
5.2 اگر یک فعالیت افزودنی از iframe خارج شود، باید یک پیش نمایش در مورد کار در iframe وجود داشته باشد. توصیه می شود
5.3 در صورت وجود، دکمه یا پیوندی در فعالیت با عنوان Turn in MUST باید باعث شود که یک درخواست API برای ارسال کار دانش‌آموز برای بررسی معلم ایجاد شود. مورد نیاز
6.0 نمای معلم
6.1 معلم باید بتواند ببیند دانش آموز هنگام انجام تکلیف چه خواهد دید. توصیه می شود
7.0 بررسی کار دانشجویی
7.1 اگر studentWorkReviewUri راه‌اندازی شود، افزونه باید کار آن دانش‌آموز را برای بازبینی معلم در iframe ارائه کند. مطالب تکمیلی ممکن است خارج از iframe پیوند داشته باشند. مورد نیاز
7.2 افزونه نباید پیمایش بین دانش آموزان را در نمای studentWorkReviewUri فعال کند. پیمایش بین دانش‌آموزان باید فقط در Classroom UI انجام شود. مورد نیاز
8.0 پشتیبانی سیار کلاس درس
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 از 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 هنگام ایجاد تکالیف 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 REQUIRED به RECOMMENDED تغییر کرد.
5.3 "اگر افزونه ها از iframe خارج شوند، باید یک پیش نمایش در مورد کار در iframe وجود داشته باشد."
5.4 اضافه شد: «اگر افزونه از iframe خارج شود، باید برای دانش‌آموزان درخواستی برای بازگشت به Classroom وجود داشته باشد».
8.1 اضافه شده "اگر دستگاه پشتیبانی نمی شود، یک پیام باید به کاربر نمایش داده شود تا بداند دستگاه پشتیبانی نشده است و در حالت ایده آل، چه دستگاه هایی پشتیبانی می شوند."
8.2 کار دانشجویی سیار از REQUIRED به RECOMMENDED تغییر کرد.
نسخه 0.1 به روز شده در 22 سپتامبر 2021
انتشار اولیه