Wymagania dotyczące dodatków

Wersja 1.0, 30 kwietnia 2024 r.

Kryteria podane na tej stronie dotyczą wszystkich dodatków do Classroom. Twój dodatek musi spełniać wszystkie wymagane elementy, aby mógł zostać zatwierdzony do udostępnienia w Google Workspace Marketplace, oraz dodatek „Działa z Classroom”.

Słowa kluczowe w tym dokumencie „MUSZ”, „NIE MOGĄ”, „WYMAGANE”, „SHALL”, „NIE POWINNY”, „POWINNY”, „POWINNY”, „RECOMMENDED”, „MAY” i „OPCJONALNE” w tym dokumencie należy interpretować w sposób opisany w dokumencie RFC 2119.

Wymagania

Identyfikator Typ
1.0 Licencja użytkownika (jeśli dotyczy)
  1.1 Jeśli użytkownik nie ma licencji, MUSI wyświetlić się przystępny komunikat. Komunikat MUSI zawierać jasny powód, dla którego nie można użyć dodatku, oraz zasugerować użytkownikowi sposób rozwiązania tej sytuacji. WYMAGANE
  1.3 Lista dodatku w Google Workspace Marketplace MUSI zawierać szczegółowe informacje o wymaganiach dotyczących licencji, które mogą być wymagane do korzystania z tego dodatku. Jeśli dodatek jest płatny, lista w Marketplace MUSI zawierać link do strony internetowej z dodatkowymi informacjami o cenach lub o tym, jak skontaktować się ze sprzedawcą. WYMAGANE
2.0 Logowanie użytkownika
  2.1 Nauczyciel MUSI logować się w dodatku przy użyciu logowania jednokrotnego Google.
Jeśli uczniowie są proszeni o zalogowanie się w dodatku, MUSZĄ logować się przy użyciu logowania jednokrotnego Google.		 WYMAGANE
  2.2 Dodatek MUSI używać logowania jednokrotnego przez Google do automatycznego logowania użytkownika przy kolejnych wizytach bez wyświetlania prośby o zalogowanie.
Jeśli wskazówka dotycząca logowania nie jest zgodna z informacjami o obecnie zalogowanym użytkowniku, dodatek MUSI wyświetlać użytkownikowi przycisk logowania i przekazywać 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 (zgodnie z informacją o logowaniu), dodatek MUSI wyświetlać przycisk „Zaloguj się przez Google” w celu uruchomienia procesu logowania.
Uwaga: jest to konieczne, aby zachować zgodność ze wskazówkami dotyczącymi promowania marki Google i uniknąć blokowania wyskakujących okienek.		 WYMAGANE
  2.8 Dodatek POWINIEN wyświetlać informacje o tym, kto jest aktualnie zalogowany. 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 poziomu dowolnej ścieżki elementu iframe, MUSI zawierać przystępną dla użytkownika wiadomość umożliwiającą powrót do Classroom. WYMAGANE
  3.3 Użytkownik MUSI ukończyć całą ścieżkę użytkownika tylko przy użyciu dodatkowego przepływu pracy. Nie może przełączać się na proces kursu ani za pomocą przycisku udostępniania w Classroom. WYMAGANE
  3.4 Wybór lokalizacji: język POWINNY BYĆ oparty na preferencjach lokalnych ustawionych przez przeglądarkę (jeśli są dostępne). POLECANE
  3,5 Jeśli dodatek definiuje maxPoints, MUSI też ustawiać pointsEarned, gdy uczeń ukończy zadanie z użyciem zapisanych danych logowania nauczyciela (zalecane) LUB gdy nauczyciel otworzy przesłane zadanie w elemencie iframe z oceną zadań uczniów. WYMAGANE
  3,9 Dodatki POWINNY być zgodne z wytycznymi WCAG 2.1 poziomu AA dotyczącymi ułatwień dostępu. Deweloperzy dodatków samodzielnie zgłaszają, że ten wymóg został spełniony w momencie przesyłania oraz że dodatek nadal zachowuje zgodność z przyszłymi zmianami. POLECANE
  3,10 Wszelkie błędy napotykane przez użytkownika MUSZĄ być zrozumiałe dla człowieka. WYMAGANE
  3,11 Jeśli aplikacja studentViewUri, teacherViewUri lub studentWorkViewUri jest uruchamiana z skopiowanego projektu lub skopiowanego kursu, dodatek NIE MOŻE wyświetlać strony błędu w elemencie iframe. WYMAGANE
  3,12 Jeśli narzędzie studentViewUri, teacherViewUri lub studentWorkViewUri zostało uruchomione z skopiowanego projektu lub skopiowanego kursu, dodatek POWINIEN wyświetlać nowy załącznik, który uczeń może wykonać. NIE POWINNY wyświetlać odpowiedzi ucznia z poprzednich projektów ani zajęć w elemencie iframe. POLECANE
4,0 Wykrywanie załączników
  4,1 Jeśli załącznik wymaga przesłania przez ucznia, MUSI zawierać studentWorkReviewUri, aby był traktowany jako typ działania, a nie jako załącznik typu treści. WYMAGANE
  4.2 Element iframe wykrywania załączników MUSI udostępniać interfejs użytkownika, który udostępnia co najmniej jeden z tych elementów:
  • Utwórz nową treść do załączenia
  • Przeglądanie, wybieranie i załączanie treści z biblioteki
  • Instrukcje dołączania treści z witryny lub innych usług
 WYMAGANE
  4.3 Nauczyciel musi mieć możliwość znalezienia wszystkich materiałów i działań dostępnych dla nauczyciela oraz dostępu do nich. POLECANE
  4.4 Nauczyciel MUSI zobaczyć podgląd treści i zadania, zanim zdecyduje się dołączyć je do projektu. WYMAGANE
  4.5 Jeśli przed załączeniem treści lub czynności nauczyciel wymaga pracy, MUSI zostać wykonana w elemencie iframe. POLECANE
5,0 Widok ucznia
  5.1 Po uruchomieniu dodatku studentViewUri dodatek NIE POWINNO wyskakiwać użytkownika z elementu iframe w celu wykonania zadania.
Jeśli dodatek wysunie użytkownika z elementu iframe, MUSI pojawić się komunikat lub inna informacja o tym, że uczniowie mogą wrócić do Classroom.		 POLECANE
  5.2 Jeśli aktywność dodatku wyskoczy z elementu iframe, MUSI być w nim widoczny podgląd zadania. WYMAGANE
  5.3 Jeśli zadanie wymaga od ucznia podjęcia działania w celu oznaczenia zadania jako ukończonego, przycisk NIE MOŻE mieć etykiety „Oddaj”, aby uniknąć pomyłek z przyciskiem Oddaj w Classroom. WYMAGANE
6,0 Widok nauczyciela
  6.1 Nauczyciel POWINNY zobaczyć, co widzi uczeń, gdy wykona zadanie. POLECANE
7,0 Sprawdzanie zadań uczniów
  7.1 Jeśli studentWorkReviewUri jest uruchomiony, dodatek MUSI renderować zadanie ucznia do sprawdzenia przez nauczyciela w elemencie iframe. Materiały dodatkowe mogą zawierać linki poza elementem iframe. WYMAGANE
  7.2 Dodatek NIE MOŻE umożliwiać nawigowania między uczniami w widoku studentWorkReviewUri. Nawigacja między uczniami MUSI odbywać się tylko w interfejsie Classroom. WYMAGANE
8,0 Pomoc dotycząca Classroom na urządzeniach mobilnych
  8.1 Gdy aplikacja mobilna Classroom uruchamia teacherViewUri, studentViewUri lub studentWorkReviewUri, adres URL MUSI otwierać aplikację mobilną partnera lub aplikację mobilną partnera. W obu przypadkach MUSI zawierać precyzyjny link do właściwego widoku. Jeśli urządzenie nie jest obsługiwane, MUSI zostać wyświetlona wiadomość z informacją, że urządzenie jest nieobsługiwane, i najlepiej, jakie urządzenia są obsługiwane. WYMAGANE
  8.2 Zadania uczniów POWINNY być odrabiane na urządzeniu mobilnym. POLECANE
9,0 Funkcje dodatkowe
  9.1 Jeśli nauczyciele mogą wklejać linki do Twoich treści jako załączniki z linkami, musisz uaktualnić linki do załączników dodatków. POLECANE
  9.2 Jeśli używasz integracji z CourseWork do tworzenia projektów poza Classroom, NALEŻY domyślnie utworzyć załączniki dodatków dla wszystkich linków zgodnych z Twoim dodatkiem. POLECANE

Historia zmian

Wersja 1.0 Zaktualizowano 30 kwietnia 2024 r.
1.1 Łączymy wymagania 1.1 i 1.2 w jeden wymóg.
2.1 Łączymy wymagania 2.1 i 2.5 w jeden wymóg.
2.2 Połączone wymagania dotyczące wersji 2.2, 2.3 i 2.4.
3,5 Połączono 3,5, 3,6 i 3,7 w jeden wymóg.
3,10 Dodano wymaganie, aby dodatek nigdy nie przechodził w niezrozumiały lub niemożliwy do odzyskania.
3,11; 3,12 Połączono 2.5, 5.6, 6.3, 6.4, 7.5 i 7.6 w 2 nowe wymagania.
4.2 Rozszerzyliśmy opis dopuszczalnych sposobów wykrywania załączników.
4.3 Zmieniono numer, dawniej 4.2. Zmieniono też z REQUIRED na RECOMMENDED.
4.4 Zmieniono numer, dawniej 4.3.
4.5 Zmieniono numer, dawniej 4.4.
5.2 Zmieniono numer, dawniej 5.3.
5.3 Zmieniono numer, dawniej 5.2.
9.1 Dodaliśmy rekomendację dotyczącą uaktualnienia wklejonych linków do załączników.
9.2 Dodaliśmy wymaganie dotyczące domyślnego tworzenia załączników dodatków podczas automatycznego tworzenia projektów CourseWork.
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ówek dotyczących logowania.
2.4 Uwzględniono scenariusz, w którym wymagane jest wdrożenie właściwości hd.
3.2 Przeformułowano „podaj ścieżkę”.
5,5; 5,6; 6,3; 6,4; 7,5; 7,6 Dodaliśmy wymagany tekst szkolenia oraz zalecane wskazówki dotyczące studentViewUri, teacherViewUri i studentWorkReviewUri.
Wersja 0.2 Aktualizacja: 29 października 2021 r.
1.3 Przeredagowaliśmy tekst, aby był bardziej przejrzysty.
3.1 Dodano: „Dodatek MUSI być zgodny z ogólnymi wytycznymi dotyczącymi zatwierdzania GWM, które znajdują się w witrynie”.
3,9 WCAG zmieniono REQUIRED na RECOMMENDED.
5.1 Zmieniono REQUIRED na RECOMMENDED.
5.3 Dodano „Jeśli dodatki wyskakują poza element iframe, MUSI być dostępny podgląd zadania w tym elemencie”.
5.4 Dodane „Jeśli dodatek wyskoczy z elementu iframe, MUSI pojawić się prośba o powrót do Classroom”.
8.1 Dodano „Jeśli urządzenie nie jest obsługiwane, MUSI pojawić się komunikat z informacją, że urządzenie jest nieobsługiwane, i najlepiej, jakie urządzenia są obsługiwane”.
8.2 Zadania uczniów mobilnych zostały zmienione z REQUIRED na RECOMMENDED.
Wersja 0.1 Aktualizacja: 22 września 2021 r.
  Pierwsza wersja.