Wymagania dotyczące dodatków

Wersja 1.0 z 30 kwietnia 2024 r.

Kryteria na tej stronie dotyczą wszystkich dodatków do Classroom. Dodatek musi spełniać wszystkie wymagania, aby można było go zatwierdzić do wyświetlania w Google Workspace Marketplace. Dodatek musi też „działać z Classroom”.

Słowa kluczowe „MUST” (musi), „MUST NOT” (nie musi), „REQUIRED” (wymagane), „SHALL” (musi), „SHALL NOT” (nie musi), „SHOULD” (zalecane), „MAY” (można) i „OPTIONAL” (opcjonalnie) w tym dokumencie należy interpretować zgodnie z opisem w specyfikacji RFC 2119.

Wymagania

Identyfikator Typ
1.0 Licencja użytkownika (jeśli dotyczy)
  1.1 Gdy użytkownik nie ma licencji, musi mu zostać wyświetlony przyjazny komunikat. Komunikat MUSI zawierać wyraźną przyczynę, dla której nie można użyć dodatku, i sugerować podjęcie działań przez użytkownika w celu rozwiązania tej sytuacji. WYMAGANE
  1.3 Na stronie dodatku w Google Workspace Marketplace MUSI być podany opis wymagań dotyczących licencjonowania, które mogą być wymagane do korzystania z dodatku. Jeśli dodatek jest w wersji płatnej, informacje o nim w Marketplace MUSZĄ zawierać link do strony internetowej z dodatkowymi informacjami o cenie lub o tym, jak można skontaktować się ze sprzedawcą. WYMAGANE
2.0 Logowanie użytkowników
  2.1 Użytkownicy nauczycieli MUSZĄ zalogować się w dodatku za pomocą logowania jednokrotnego Google.
Jeśli użytkownicy zostaną poproszeni o zalogowanie się w dodatku, MUSZĄ zalogować się za pomocą logowania jednokrotnego Google.		 WYMAGANE
  2.2 W przypadku kolejnych wizyt użytkownik MUSI logować się automatycznie za pomocą logowania jednokrotnego Google bez wyświetlania prośby o logowanie.
Jeśli podpowiedź logowania nie znajdzie dopasowania do aktualnie zalogowanego użytkownika, wtyczka MUSI wyświetlić użytkownikowi przycisk logowania i przekazać parametr login_hint do biblioteki uwierzytelniania, aby odfiltrować nieprawidłowe konta.		 WYMAGANE
  2.7 Jeśli użytkownik Classroom nie jest jeszcze zalogowany w dodatku (co można sprawdzić, patrząc na podpowiedź logowania), dodatek MUSI wyświetlać przycisk „Zaloguj się przez Google”, aby użytkownik mógł zalogować się w sposób jawny.
Uwaga: jest to konieczne, aby zachować zgodność z wytycznymi dotyczącymi marki Google. Pomaga to też uniknąć blokowania wyskakujących okienek.		 WYMAGANE
  2.8 W dodatku POWINIEN być wyświetlany aktualnie zalogowany użytkownik. POLECANE
3.0 Ogólne
  3.1 Dodatek MUSI być zgodny z ogólnymi wytycznymi dotyczącymi zatwierdzania w Google Workspace Marketplace. WYMAGANE
  3.2 Jeśli zadanie jest uruchamiane w nowej karcie lub nowym oknie z dowolnej ścieżki iframe, MUSI zawierać przyjazną dla użytkownika wiadomość, aby umożliwić powrót do Classroom. WYMAGANE
  3.3 Użytkownik MUSI przejść całą ścieżkę, korzystając z procesu roboczego dodatku, a nie przełączać się na proces roboczy kursu ani używać przycisku udostępniania w Classroom. WYMAGANE
  3.4 Wybór lokalizacji: język powinien być ustawiony na podstawie preferencji lokalnych określonych przez przeglądarkę (jeśli są dostępne). POLECANE
  3,5 Jeśli dodatek definiuje maxPoints, MUSI on również ustawiać pointsEarned, gdy uczeń prześle pracę, używając zapisanych danych logowania nauczyciela (zalecane) LUB gdy nauczyciel otworzy pracę w ramce recenzji pracy ucznia. WYMAGANE
  3,9 Dodatki MUSZĄ być zgodne z wytycznymi WCAG 2.1, poziom AA w zakresie ułatwień dostępu. W momencie przesyłania deweloperzy dodatków sami zgłaszają, że spełniają ten wymóg, a dodatek będzie nadal zgodny z jego przyszłymi zmianami. POLECANE
  3,10 Wszelkie błędy napotkane przez użytkownika MUSZĄ być czytelne dla człowieka. WYMAGANE
  3.11 Jeśli studentViewUri, teacherViewUri lub studentWorkViewUri jest uruchamiane z skopiowanego projektu lub skopiowanego kursu, dodatek NIE MOŻE wyświetlać strony z błędem w iFrame. WYMAGANE
  3.12 Jeśli dodatek studentViewUri, teacherViewUri lub studentWorkViewUri jest uruchamiany z skopiowanego projektu lub skopiowanego kursu, w ramce iframe powinien wyświetlić nowy załącznik do wykonania przez ucznia, a nie odpowiedzi ucznia z poprzednich projektów lub kursów. POLECANE
4,0 Odkrywanie załączników
  4,1 Jeśli załącznik wymaga przesłania przez ucznia, MUSI zawierać element studentWorkReviewUri, aby został potraktowany jako typ zadania, a nie typ treści. WYMAGANE
  4.2 Element iframe wykrywania załączników MUSI zawierać interfejs użytkownika oferujący co najmniej jeden z następujących elementów:
  • Utwórz nową treść do załączenia
  • Przeglądanie, wybieranie i dołączanie plików z biblioteki treści
  • instrukcje załączania treści z witryny lub innych produktów;
 WYMAGANE
  4.3 Nauczyciel powinien mieć możliwość znalezienia wszystkich treści i aktywności dostępnych dla niego. POLECANE
  4.4 Nauczyciel MUSI mieć możliwość wyświetlenia podglądu treści lub aktywności, zanim zdecyduje się na ich dołączenie do projektu. WYMAGANE
  4,5 Jeśli nauczyciel musi wykonać pracę, aby utworzyć treści lub aktywność, zanim będzie można je dołączyć, powinien to zrobić w ramach elementu osadzonego. POLECANE
5.0 Widok ucznia
  5.1 Po uruchomieniu dodatku studentViewUri dodatek NIE POWINNY wychodzić użytkownika z elementu iframe w celu wykonania zadania.
Jeśli dodatek wychodzi użytkownika z elementu iframe, MUSI pojawić się komunikat lub informacja, aby umożliwić uczniom powrót do Classroom.		 POLECANE
  5.2 Jeśli aktywność dodatku wyskakuje z elementu iframe, w elemencie iframe MUSI być widoczny podgląd zadania. WYMAGANE
  5.3 Jeśli zadanie wymaga od ucznia podjęcia działania, aby oznaczyć pracę jako ukończoną, przycisk NIE MOŻE mieć etykiety „Oddaj”, aby uniknąć pomylenia z przyciskiem „Oddaj” w Classroom. WYMAGANE
6.0 Widok nauczyciela
  6.1 Nauczyciel powinien widzieć to, co zobaczy uczeń podczas wykonywania projektu. POLECANE
7,0 Sprawdzanie prac uczniów
  7.1 Jeśli zostanie uruchomiony element studentWorkReviewUri, dodatek MUSI wyświetlić pracę ucznia do sprawdzenia przez nauczyciela w ramach ramki. Materiały dodatkowe mogą zawierać linki do stron spoza elementu iframe. WYMAGANE
  7.2 Wtyczka NIE MOŻE umożliwiać nawigacji między uczniami w widoku studentWorkReviewUri. Nawigacja między uczniami MUSI odbywać się tylko w interfejsie Classroom. WYMAGANE
8.0 Obsługa urządzeń mobilnych Classroom
  8.1 Gdy aplikacja mobilna Classroom uruchamia teacherViewUri, studentViewUri lub studentWorkReviewUri, adres URL MUSI otwierać natywną aplikację mobilną lub mobilną wersję internetową aplikacji partnera. W obu przypadkach musi zawierać precyzyjny link do odpowiedniej strony. Jeśli urządzenie nie jest obsługiwane, użytkownikowi MUSI zostać wyświetlony komunikat informujący o tym, że urządzenie nie jest obsługiwane. W idealnej sytuacji należy też poinformować użytkownika, które urządzenia są obsługiwane. WYMAGANE
  8.2 Uczeń powinien mieć możliwość wykonania zadania na urządzeniu mobilnym. POLECANE
9,0 Funkcje dodatkowe
  9.1 Jeśli nauczyciele mogą wklejać linki do Twoich treści jako załączniki linków, uaktualnij linki do załączników dodatków. POLECANE
  9.2 Jeśli do tworzenia projektów poza Classroom używasz integracji z CourseWork, utwórz domyślnie załączniki dodatków dla wszystkich linków zgodnych z Twoim dodatkiem. POLECANE

Historia zmian

Wersja 1.0 Aktualizacja z 30 kwietnia 2024 r.
1.1 Połączenie 1.1 i 1.2 w jednym wymaganiu.
2.1 Połączyliśmy punkty 2.1 i 2.5 w jeden wymóg.
2.2 Połączyliśmy punkty 2.2, 2.3 i 2.4 w jeden wymóg.
3,5 Połączyliśmy wersje 3.5, 3.6 i 3.7 w jeden wymóg.
3.10 Dodano wymóg, aby dodatek nigdy nie wchodził w stan nieczytelny lub nie do odzyskania.
3,11, 3,12 Połączenie wersji 5.5, 5.6, 6.3, 6.4, 7.5 i 7.6 w 2 nowe wymagania.
4.2 Rozwinęliśmy opis dozwolonych doświadczeń z Discovery w przypadku załączników.
4.3 Zmieniono numerację (wcześniej 4.2). Zmieniono też wartość z WYMAGANE naZALECANE.
4.4 Zmieniono numerację. Wcześniej punkt 4.3.
4,5 Przenumerowane, poprzednio 4.4.
5.2 Zmieniono numerację. Wcześniej 5.3.
5.3 Zmieniono numer, wcześniej 5.2.
9.1 Dodano rekomendację dotyczącą uaktualnienia wklejonych linków do załączników.
9.2 Dodano rekomendację, aby domyślnie tworzyć załączniki dodatków podczas tworzenia projektów zajęć w sposób programowy.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Usunięto.
Wersja 0.3 Zaktualizowano 22 listopada 2022 r.
2.3 Korekta wskazówek dotyczących logowania.
2.4 Opisuje scenariusz, w którym wymagane jest wdrożenie hd.
3.2 Zmieniono treść sekcji „Podaj ścieżkę”.
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Dodano wymagane i zalecane wskazówki dotyczące treści kursu dla tych elementów: studentViewUri, teacherViewUri i studentWorkReviewUri.
Wersja 0.2 Zaktualizowano 29 października 2021 r.
1.3 Poprawiono tekst, aby był bardziej zrozumiały.
3.1 Dodano „Dodatek MUSI być zgodny z ogólnymi wytycznymi dotyczącymi zatwierdzania Google Workspace, które można znaleźć na stronie internetowej Google Workspace”.
3,9 WCAG zmieniony z WYMAGANE na ZALECANE.
5.1 Zmieniono REQUIRED na: RECOMMENDED (WYMAGANE).
5.3 Dodano „Jeśli dodatki wystają poza iframe, w iframe MUSI być widoczny podgląd zadania”.
5.4 Dodano „Jeśli dodatek wyskakuje z elementu iframe, POWINIEN wyświetlić się prośba o powrót do Classroom”.
8.1 Dodano „Jeśli urządzenie nie jest obsługiwane, użytkownikowi MUSI zostać wyświetlony komunikat informujący o tym, że urządzenie nie jest obsługiwane. W idealnej sytuacji należy również poinformować użytkownika, które urządzenia są obsługiwane”.
8.2 Zmieniono wymagania dotyczące zadań uczniów na urządzeniach mobilnych z „Wymagane” na „Zalecane”.
Wersja 0.1 Aktualizacja: 22 września 2021 r.
  Pierwsza wersja.