Wymagania dotyczące dodatków

Wersja 1.1 z 5 grudnia 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 Użytkownikowi, który nie ma licencji, NALEŻY wyświetlić przyjazny komunikat. W wiadomości NALEŻY wyraźnie podać powód, dla którego nie można używać dodatku, oraz zasugerować użytkownikowi sposób rozwiązania problemu. POLECANE
  1.3 Na stronie dodatku w Google Workspace Marketplace NALEŻY podać informacje o wymaganiach dotyczących licencji i subskrypcji, które mogą być wymagane do korzystania z dodatku. Jeśli dodatek ma płatny poziom, w opisie na stronie Marketplace POWINIEN znajdować się link do strony internetowej zawierającej więcej informacji o cenach lub sposobach kontaktu ze sprzedawcą. POLECANE
2.0 Logowanie użytkownika
  2.1 Użytkownicy nauczyciele MUSZĄ logować się w dodatku za pomocą logowania jednokrotnego Google.
Jeśli uczniowie zostaną poproszeni o zalogowanie się w dodatku, MUSZĄ użyć 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 pasuje do aktualnie zalogowanego użytkownika, dodatek 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ć spójność z wytycznymi dotyczącymi marki Google, a także aby 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 oknie z dowolnej ścieżki z ramką iframe, POWINNA wyświetlać przyjazną dla użytkownika wiadomość z instrukcją powrotu do Classroom. POLECANE
  3.3 Użytkownik MUSI przejść przez proces tylko za pomocą procesu obsługi dodatku, a nie przełączać się na proces obsługi zajęć ani używać przycisku udostępniania w Classroom. WYMAGANE
  3.4 Wybór lokalizacji: język powinien być ustawiony zgodnie z preferencjami użytkownika (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 POWINNY być zgodne z wytycznymi WCAG 2.1 dotyczącymi ułatwień dostępu na poziomie AA. W momencie przesyłania deweloperzy dodatków muszą samodzielnie potwierdzić, że spełniają ten wymóg, a dodatek będzie nadal zgodny z przyszłościowymi zmianami. POLECANE
  3.10 Wszelkie błędy wyświetlane użytkownikowi POWINNA być zrozumiałe dla człowieka. POLECANE
  3.11 Jeśli studentViewUri, teacherViewUri lub studentWorkViewUri jest uruchamiane z skopiowanego projektu lub skopiowanego kursu, dodatek NIE MOŻE wyświetlać strony błędu w iFrame. WYMAGANE
4,0 Odkrywanie załączników
  4,1 Jeśli załącznik wymaga przesłania przez ucznia, musi zawierać studentWorkReviewUri, aby był traktowany jako załącznik typu aktywność, a nie typu treść. WYMAGANE
  4.2 IFrame Discovery z załącznikami MUSI zawierać interfejs użytkownika, który oferuje co najmniej jedną z tych opcji:
  • Tworzenie nowych treści do załączenia
  • Przeglądanie, wybieranie i dołączanie plików z biblioteki treści
  • Instrukcje dotyczące dołączania treści z witryny lub innych usług
WYMAGANE
  4.3 Nauczyciel powinien mieć możliwość znalezienia wszystkich treści i aktywności dostępnych dla niego. POLECANE
  4.4 Nauczyciel powinien mieć możliwość wyświetlenia podglądu treści lub aktywności, zanim zdecyduje się na ich dołączenie do projektu. POLECANE
  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 iframe. POLECANE
5.0 Widok ucznia
  5.1 Gdy użytkownik uruchomi studentViewUri, dodatek NIE POWINIEN wymuszać opuszczenia przez niego ramki iframe w celu wykonania zadania.
Jeśli dodatek wymusza opuszczenie przez użytkownika ramki iframe, MUSI wyświetlić komunikat lub inny komunikat wskazujący, że musi on wrócić do Classroom.
POLECANE
  5.2 Jeśli aktywność dodatku pojawia się w ramce iframe, w ramce powinna być widoczna podglądowa wersja zadania. POLECANE
  5.3 Jeśli jest dostępny, przycisk lub link w zadaniu o nazwie Prześlij MUSI wywołać żądanie interfejsu API, aby przesłać pracę ucznia do sprawdzenia przez nauczyciela. 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. Przechodzenie między uczniami musi odbywać się tylko w interfejsie Classroom. WYMAGANE
8.0 Pomoc dotycząca aplikacji mobilnej Classroom
  8.1 Gdy aplikacja mobilna Classroom uruchamia teacherViewUri, studentViewUri lub studentWorkReviewUri, adres URL MUSI otwierać natywną aplikację mobilną lub mobilną aplikację internetową partnera. W obu przypadkach musi zawierać precyzyjny link do odpowiedniej strony. Jeśli urządzenie nie jest obsługiwane, użytkownik MUSI zobaczyć komunikat informujący o tym, że urządzenie nie jest obsługiwane, oraz (w miarę możliwości) o tym, 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.1 Aktualizacja z 5 grudnia 2024 r.
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 Zmieniono z WYMAGANE na ZALECANE.
3.12 Usunięto.
5.3 Zmieniono treść. Niedawna zmiana pozwala deweloperom dodatków na niezawodne przesyłanie prac uczniów za pomocą interfejsu API.
Wersja 1.0 Ostatnia aktualizacja: 30 kwietnia 2024 r.
1.1 Połączyliśmy punkty 1.1 i 1.2 w jeden wymóg.
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łączyliśmy sekcje 5.5, 5.6, 6.3, 6.4, 7.5 i 7.6 w 2 nowe wymagania.
4.2 Rozwinęliśmy opis dozwolonych sposobów wyświetlania załączników w Discovery.
4.3 Zmieniono numer, wcześniej 4.2. Zmieniono też z WYMAGANE naZALECANE.
4.4 Zmieniono numerację. Wcześniej punkt 4.3.
4,5 Przenumerowane, poprzednio 4.4.
5.2 Zmieniono numerację. Wcześniejsza wersja to 5.3.
5.3 Zmieniono numer wersji, wcześniej 5.2.
9.1 Dodaliśmy rekomendację dotyczącą uaktualniania wklejonych linków do załączników.
9.2 Dodano rekomendację, aby domyślnie tworzyć załączniki dodatków podczas tworzenia projektów CourseWork za pomocą programowania.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Usunięto.
Wersja 0.3 Zaktualizowano 22 listopada 2022 r.
2.3 Poprawka wskazówki dotyczącej 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 użytkownikó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 zmienił wymagane na zalecane.
5.1 Zmieniono wartość z WYMAGANE na POLECANE.
5.3 Dodano „Jeśli dodatki wychodzą poza iframe, w iframe MUSI być widoczny podgląd zadania”.
5.4 Dodano „Jeśli wtyczka wypadnie z ramki iframe, POWINNA 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 Zaktualizowano 22 września 2021 r.
  Pierwsza wersja.