Wymagania dotyczące dodatków

Wersja 1.1, 5 grudnia 2024 r.

Kryteria na tej stronie dotyczą wszystkich dodatków do Classroom. Twój dodatek musi spełniać wszystkie obowiązujące wymagania, aby został zatwierdzony do umieszczenia w Google Workspace Marketplace jako dodatek, który „działa z Classroom”.

Słowa kluczowe „MUST”, „MUST NOT”, „REQUIRED”, „SHALL”, „SHALL NOT”, „SHOULD”, „SHOULD NOT”, „RECOMMENDED”, „MAY” i „OPTIONAL” w tym dokumencie należy interpretować zgodnie z opisem w RFC 2119.

Wymagania

Identyfikator Typ
1.0 Licencja użytkownika (w odpowiednich przypadkach)
  1.1 Gdy użytkownik nie ma licencji, POWINIEN mu się wyświetlić przyjazny komunikat. Komunikat POWINIEN jasno określać powód, dla którego nie można użyć dodatku, i sugerować użytkownikowi sposób rozwiązania problemu. POLECANE
  1.3 Informacje o licencji i wymaganiach dotyczących subskrypcji, które mogą być potrzebne do korzystania z dodatku, POWINNY być podane w informacjach o dodatku w Google Workspace Marketplace. Jeśli dodatek ma płatną wersję, w informacjach o nim w Marketplace POWINIEN znajdować się link do strony internetowej, na której można znaleźć więcej informacji o cenach lub o tym, jak skontaktować się ze sprzedawcą. POLECANE
2.0 Logowanie użytkownika
  2.1 Użytkownicy z rolą nauczyciel MUSZĄ logować się w dodatku za pomocą logowania jednokrotnego Google.
Jeśli uczniowie są proszeni o zalogowanie się w dodatku, MUSZĄ logować się za pomocą logowania jednokrotnego Google.		 WYMAGANE
  2.2 Dodatek MUSI używać logowania jednokrotnego Google, aby automatycznie logować użytkownika podczas kolejnych wizyt bez wyświetlania prośby o zalogowanie się.
Jeśli wskazówka logowania nie pasuje do aktualnie zalogowanego użytkownika, dodatek MUSI wyświetlić 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 stwierdzić na podstawie wskazówki logowania), dodatek MUSI wyświetlać przycisk „Zaloguj się przez Google”, aby wyraźne działanie użytkownika wywołało proces logowania.
Uwaga: jest to konieczne, aby spełnić wytyczne dotyczące marki Google, a także pomaga uniknąć blokowania wyskakujących okienek.		 WYMAGANE
  2.8 Dodatek POWINIEN wyświetlać informacje o obecnie zalogowanym użytkowniku. 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 zostanie otwarte w nowej karcie lub nowym oknie z dowolnej ścieżki iframe, POWINNO wyświetlić przyjazny dla użytkownika komunikat, który umożliwi powrót do Classroom. POLECANE
  3.3 Użytkownik MUSI przejść cały proces tylko za pomocą przepływu pracy dodatku. Nie może przełączyć się na przepływ pracy związany z zadaniami ani użyć przycisku udostępniania w Classroom. WYMAGANE
  3.4 Wybór lokalizacji: język POWINIEN być oparty na lokalnych preferencjach ustawionych w przeglądarce, jeśli są dostępne. POLECANE
  3,5 Jeśli dodatek definiuje maxPoints, MUSI też ustawić pointsEarned, gdy uczeń prześle projekt przy użyciu zapisanych danych logowania nauczyciela (zalecane) LUB gdy nauczyciel otworzy projekt w elemencie iframe Przeglądanie prac uczniów. WYMAGANE
  3,9 Dodatki POWINNY być zgodne z wytycznymi WCAG 2.1 na poziomie AA dotyczącymi ułatwień dostępu. Deweloperzy dodatków będą sami zgłaszać, że to wymaganie jest spełnione w momencie przesyłania dodatku, a także że dodatek pozostaje zgodny z przyszłymi zmianami. POLECANE
  3.10 Wszystkie błędy, które napotka użytkownik, POWINNY być zrozumiałe dla człowieka. POLECANE
  3.11 Jeśli dodatek studentViewUri, teacherViewUri lub studentWorkViewUri jest uruchamiany ze skopiowanego projektu lub skopiowanego kursu, NIE MOŻE wyświetlać strony błędu w elemencie iframe. WYMAGANE
4,0 Wykrywanie załączników
  4.1 Jeśli załącznik wymaga przesłania przez ucznia, MUSI zawierać symbol studentWorkReviewUri, aby był traktowany jako załącznik typu aktywność, a nie typu treść. WYMAGANE
  4.2 Element iframe do wykrywania załączników MUSI udostępniać interfejs użytkownika, który oferuje co najmniej jedną z tych funkcji:
  • Tworzenie nowych treści do załączenia
  • Przeglądanie, wybieranie i dołączanie treści z biblioteki treści
  • instrukcje dołączania treści z Twojej witryny lub innych usług,
 WYMAGANE
  4.3 Nauczyciel POWINIEN mieć możliwość znalezienia i uzyskania dostępu do wszystkich treści i aktywności dostępnych dla nauczyciela. POLECANE
  4.4 Nauczyciel powinien mieć możliwość wyświetlenia podglądu treści lub aktywności przed podjęciem decyzji o dołączeniu ich do projektu. POLECANE
  4,5 Jeśli nauczyciel musi wykonać pracę, aby utworzyć treść lub aktywność, zanim będzie można ją załączyć, powinien to zrobić w elemencie iframe. POLECANE
5.0 Widok ucznia
  5.1 Po uruchomieniu studentViewUri dodatek NIE powinien przenosić użytkownika poza element iframe w celu wykonania zadania.
Jeśli dodatek przenosi użytkownika poza element iframe, musi wyświetlać komunikat lub inne wskazówki, które pomogą uczniom wrócić do Classroom.		 POLECANE
  5.2 Jeśli aktywność dodatku wyskoczy z elementu iframe, w tym elemencie POWINIEN być widoczny podgląd zadania. POLECANE
  5.3 Jeśli w aktywności znajduje się przycisk lub link oznaczony jako Oddaj, MUSI on powodować wysłanie żądania do interfejsu API w celu przesłania pracy ucznia do sprawdzenia przez nauczyciela. WYMAGANE
6.0 Widok nauczyciela
  6.1 Nauczyciel powinien widzieć to, co uczeń zobaczy podczas wykonywania projektu. POLECANE
7,0 Sprawdzanie prac uczniów
  7.1 Jeśli zostanie uruchomiony przycisk studentWorkReviewUri, dodatek MUSI wyświetlić w ramce iframe pracę ucznia, aby nauczyciel mógł ją sprawdzić. Materiały dodatkowe mogą zawierać linki do treści spoza elementu iframe. WYMAGANE
  7.2 Dodatek NIE MOŻE umożliwiać przełączania się między uczniami w widoku studentWorkReviewUri. Przełączanie się 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, URL MUSI otwierać natywną aplikację mobilną partnera lub mobilną aplikację internetową partnera, a w obu przypadkach musi zawierać precyzyjny link do odpowiedniego widoku. Jeśli urządzenie nie jest obsługiwane, użytkownik MUSI zobaczyć komunikat informujący o tym, że urządzenie nie jest obsługiwane, a także o tym, które urządzenia są obsługiwane. WYMAGANE
  8.2 Prace uczniów POWINNY być możliwe do wykonania 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 używasz integracji z CourseWork do tworzenia projektów poza Classroom, w przypadku wszystkich linków zgodnych z dodatkiem domyślnie twórz załączniki dodatków. POLECANE

Historia zmian

Wersja 1.1 Zaktualizowano 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 Przeformułowano. Niedawna zmiana umożliwia deweloperom dodatków niezawodne przesyłanie prac uczniów za pomocą interfejsu API.
Wersja 1.0 Zaktualizowano 30 kwietnia 2024 r.
1.1 Połączyliśmy wymagania 1.1 i 1.2 w jedno.
2.1 Połączyliśmy wymagania 2.1 i 2.5 w jedno.
2.2 Połączyliśmy wymagania 2.2, 2.3 i 2.4 w jedno.
3,5 Połączyliśmy wymagania 3.5, 3.6 i 3.7 w jedno.
3.10 Dodano wymaganie, aby dodatek nigdy nie przechodził w stan niezrozumiały lub niemożliwy do odzyskania.
3.11, 3.12 Połączyliśmy wymagania 5.5, 5.6, 6.3, 6.4, 7.5 i 7.6 w 2 nowe wymagania.
4.2 Rozszerzyliśmy opis dopuszczalnych funkcji wykrywania załączników.
4.3 Zmieniono numerację, wcześniej 4.2. Zmieniono też z WYMAGANE na ZALECANE.
4.4 Zmieniono numerację, wcześniej 4.3.
4,5 Zmieniono numerację, wcześniej 4.4.
5.2 Zmieniono numerację, wcześniej 5.3.
5.3 Zmieniono numerację, wcześniej 5.2.
9.1 Dodaliśmy rekomendację dotyczącą uaktualniania wklejonych linków do załączników.
9.2 Dodano rekomendację, aby podczas programowego tworzenia zadań w ramach zajęć domyślnie tworzyć załączniki dodatków.
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 podpowiedzi logowania.
2.4 Dodano scenariusz, w którym wymagane jest wdrożenie hd.
3.2 Zmieniliśmy sformułowanie „podaj ścieżkę”.
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Dodaliśmy wymagane i zalecane wskazówki dotyczące treści kursu dla właściwości studentViewUri, teacherViewUri i studentWorkReviewUri.
Wersja 0.2 Zaktualizowano 29 października 2021 r.
1.3 Poprawiliśmy tekst, aby był bardziej zrozumiały.
3.1 Dodano zdanie „Dodatek MUSI być zgodny z ogólnymi wytycznymi dotyczącymi zatwierdzania w GWM znajdującymi się na stronie internetowej”.
3,9 WCAG zmieniono z WYMAGANE na ZALECANE.
5.1 Zmieniono z WYMAGANE na ZALECANE.
5.3 Dodano informację: „Jeśli dodatek wyskakuje z elementu iframe, MUSI zawierać podgląd zadania w tym elemencie”.
5.4 Dodano zdanie „Jeśli dodatek wyskoczy z elementu iframe, uczniowie POWINNI zobaczyć prośbę o powrót do Classroom”.
8.1 Dodano zdanie „Jeśli urządzenie nie jest obsługiwane, użytkownikowi MUSI zostać wyświetlony komunikat z informacją, że urządzenie nie jest obsługiwane, a także, które urządzenia są obsługiwane”.
8.2 Praca ucznia na urządzeniu mobilnym została zmieniona z WYMAGANEJ na ZALECANĄ.
Wersja 0.1 Zaktualizowano 22 września 2021 r.
  Pierwsza wersja.