Версия 1.1, 5 декабря 2024 г.
Критерии на этой странице применимы ко всем надстройкам для Класса. Ваше дополнение должно соответствовать всем применимым требованиям для публикации в Google Workspace Marketplace и быть совместимым с Классом.
Ключевые слова «ДОЛЖЕН», «НЕ ДОЛЖЕН», «ТРЕБУЕТСЯ», «ДОЛЖЕН», «НЕ ДОЛЖЕН», «СЛЕДУЕТ», «НЕ СЛЕДУЕТ», «РЕКОМЕНДУЕТСЯ», «МОЖЕТ» и «ДОПОЛНИТЕЛЬНО» в настоящем документе следует толковать так, как описано в 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 | Пользователь ДОЛЖЕН завершить путешествие только с помощью дополнительного рабочего процесса и не переключаться на поток courseWork или использовать кнопку «Поделиться в классе». | НЕОБХОДИМЫЙ | |
| 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 обнаружения вложений ДОЛЖЕН предоставлять пользовательский интерфейс, который предлагает как минимум одно из следующего:
| НЕОБХОДИМЫЙ | |
| 4.3 | Учитель ДОЛЖЕН иметь возможность находить и получать доступ ко всему контенту/занятиям, доступным учителю. | РЕКОМЕНДОВАНО | |
| 4.4 | Преподаватель ДОЛЖЕН иметь возможность предварительно просмотреть контент/задание, прежде чем приложить его к заданию. | РЕКОМЕНДОВАНО | |
| 4.5 | Если преподавателю необходимо создать контент/занятие перед тем, как его можно будет прикрепить, эта работа ДОЛЖНА быть выполнена в iframe. | РЕКОМЕНДОВАНО | |
| 5.0 | Студенческий взгляд | ||
| 5.1 | При запуске studentViewUri дополнение НЕ ДОЛЖНО выводить пользователя из iframe для выполнения задачи.Если дополнение выводит пользователя из iframe, ДОЛЖНО быть сообщение или другой сигнал для студентов о необходимости вернуться в класс. | РЕКОМЕНДОВАНО | |
| 5.2 | Если дополнительная активность выводится из iframe, в iframe ДОЛЖЕН быть предварительный просмотр задачи. | РЕКОМЕНДОВАНО | |
| 5.3 | Если присутствует кнопка или ссылка в действии с надписью «Сдать», ДОЛЖНА вызвать запрос API для отправки работы учащегося на проверку учителем. | НЕОБХОДИМЫЙ | |
| 6.0 | Взгляд учителя | ||
| 6.1 | Учитель ДОЛЖЕН видеть то, что увидит ученик, когда выполнит задание. | РЕКОМЕНДОВАНО | |
| 7.0 | Обзор студенческих работ | ||
| 7.1 | Если запущен studentWorkReviewUri , дополнение ДОЛЖНО отображать работу студента для проверки преподавателем в iframe. Дополнительные материалы могут ссылаться на материалы за пределами iframe. | НЕОБХОДИМЫЙ | |
| 7.2 | Надстройка НЕ ДОЛЖНА обеспечивать навигацию между студентами в представлении studentWorkReviewUri . Навигация между студентами ДОЛЖНА осуществляться только в интерфейсе Classroom. | НЕОБХОДИМЫЙ | |
| 8.0 | Поддержка мобильных устройств в классе | ||
| 8.1 | Когда мобильное приложение «Класс» запускает 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 | Изменено с ОБЯЗАТЕЛЬНО на РЕКОМЕНДУЕТСЯ. |
| 5.3 | Добавлено: «Если надстройки выводятся из iframe, в iframe ОБЯЗАТЕЛЬНО должен быть предварительный просмотр задачи». |
| 5.4 | Добавлено: «Если надстройка выскакивает из iframe, учащимся ДОЛЖНО быть предложено вернуться в Classroom». |
| 8.1 | Добавлено: «Если устройство не поддерживается, пользователю ДОЛЖНО быть отображено сообщение, информирующее его об этом, а в идеале — о том, какие устройства поддерживаются». |
| 8.2 | Мобильная студенческая работа изменена с ОБЯЗАТЕЛЬНОЙ на РЕКОМЕНДУЕМУЮ. |
| Версия 0.1 | Обновлено 22 сентября 2021 г. |
| Первоначальный выпуск. |