Дополнительные требования

Версия 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 Если пользователь Класса еще не вошел в надстройку (что определяется путем просмотра подсказки для входа), в надстройке ДОЛЖНА присутствовать кнопка «Войти через Google» для явного действия пользователя, запускающего процесс входа.
Примечание . Это необходимо для соблюдения рекомендаций Google по брендингу, а также помогает избежать блокировки всплывающих окон.
НЕОБХОДИМЫЙ
2,8 Надстройка ДОЛЖНА отображать имя текущего пользователя, вошедшего в систему. РЕКОМЕНДУЕТСЯ
3.0 Общий
3.1 Надстройка ДОЛЖНА соответствовать общим правилам одобрения Google Workspace Marketplace . НЕОБХОДИМЫЙ
3.2 Если задача запускается на новой вкладке или в новом окне из любого пути iframe, она ДОЛЖНА предоставить удобное сообщение для возврата в Класс. РЕКОМЕНДУЕТСЯ
3.3 Пользователь ДОЛЖЕН завершить путешествие только с помощью дополнительного рабочего процесса и не переключаться на рабочий процесс курса или использовать кнопку «Поделиться в классе». НЕОБХОДИМЫЙ
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 . Навигация между учащимися ДОЛЖНА осуществляться только в пользовательском интерфейсе Класса. НЕОБХОДИМЫЙ
8.0 Поддержка мобильных устройств в классе
8.1 Когда мобильное приложение Classroom запускает teacherViewUri , studentViewUri или studentWorkReviewUri , URL-адрес ДОЛЖЕН либо открыть собственное мобильное приложение партнера, либо мобильное веб-приложение партнера, и в любом случае создать глубокую ссылку на правильное представление. Если устройство не поддерживается, пользователю ДОЛЖНО быть отображено сообщение, информирующее его о том, что это неподдерживаемое устройство и, в идеале, о том, какие устройства поддерживаются. НЕОБХОДИМЫЙ
8.2 Студенческие работы ДОЛЖНЫ быть выполнены на мобильном устройстве. РЕКОМЕНДУЕТСЯ
9,0 Дополнительные возможности
9.1 Если учителя могут вставлять ссылки на ваш контент в виде вложений ссылок, вам СЛЕДУЕТ обновить ссылки до дополнительных вложений . РЕКОМЕНДУЕТСЯ
9.2 Если вы используете интеграцию CourseWork для создания заданий за пределами Класса, вам СЛЕДУЕТ создавать дополнительные вложения по умолчанию для всех ссылок, совместимых с вашим дополнением. РЕКОМЕНДУЕТСЯ

Журнал изменений

Версия 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, учащимся ДОЛЖНО быть предложено вернуться в Класс».
8.1 Добавлено: «Если устройство не поддерживается, пользователю ДОЛЖНО быть отображено сообщение, сообщающее ему, что это неподдерживаемое устройство и, в идеале, какие устройства поддерживаются».
8.2 Мобильная студенческая работа изменена с ОБЯЗАТЕЛЬНО на РЕКОМЕНДУЕТСЯ.
Версия 0.1 Обновлено 22 сентября 2021 г.
Первоначальный выпуск.