Wymagania dotyczące dodatków

Wersja 1.1, 5 grudnia 2024 r.

Kryteria na tej stronie dotyczą wszystkich dodatków do Classroom. Aby Twój dodatek został zatwierdzony do umieszczenia w Google Workspace Marketplace i mógł być oznaczony jako „Działa z Classroom”, musi on spełniać wszystkie obowiązujące wymagania.

Słowa kluczowe „MUST” (musieć), „MUST NOT” (nie wolno), „REQUIRED” (wymagane), „SHALL” (należy), „SHALL NOT” (nie należy), „SHOULD” (powinno), „SHOULD NOT” (nie powinno), „RECOMMENDED” (zalecane), „MAY” (móc) oraz „OPTIONAL” (opcjonalne) w tym dokumencie mają znaczenie zgodne z opisem w RFC 2119.

Wymagania

Identyfikator Typ
1.0 Licencja użytkownika (jeśli dotyczy)
  1.1 Gdy użytkownik nie ma licencji, powinien zobaczyć przyjazny dla użytkownika komunikat. Komunikat powinien wyraźnie informować o przyczynie, dla której nie można używać dodatku, oraz sugerować użytkownikowi, co może zrobić, aby rozwiązać ten problem. POLECANE
  1.3 Informacje o dodatku w Google Workspace Marketplace powinny zawierać szczegóły dotyczące licencji i wymagań subskrypcji, które mogą być wymagane do korzystania z dodatku. Jeśli dodatek ma płatny poziom, informacje w Marketplace powinny zawierać link do strony internetowej z dodatkowymi informacjami o cenach lub o tym, jak skontaktować się z przedstawicielem handlowym. 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 użytkownicy z rolą uczeń są proszeni o zalogowanie się w dodatku, MUSZĄ to zrobić 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.
Gdy podpowiedź logowania nie pasuje do aktualnie zalogowanego użytkownika, dodatek MUSI wyświetlić użytkownikowi przycisk logowania i przekazać podpowiedź logowania 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 podpowiedzi logowania), dodatek MUSI wyświetlić przycisk „Zaloguj się przez Google”, aby użytkownik mógł wyraźnie zainicjować 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 aktualnie 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 jest uruchamiane w nowej karcie lub oknie z dowolnej ścieżki iframe, POWINNO wyświetlać przyjazny dla użytkownika komunikat o powrocie do Classroom. POLECANE
  3.3 Użytkownik MUSI przejść ścieżkę tylko za pomocą przepływu pracy dodatku i nie może przełączać się na przepływ pracy związany z zadaniami ani używać przycisku udostępniania w Classroom. WYMAGANE
  3.4 Wybór języka: język POWINIEN być oparty na preferencjach lokalnych ustawionych w przeglądarce, jeśli są dostępne. POLECANE
  3.5 Jeśli dodatek definiuje parametr maxPoints, MUSI też ustawić parametr pointsEarned, gdy uczeń prześle projekt za pomocą zapisanych danych logowania nauczyciela (zalecane) LUB gdy nauczyciel otworzy projekt w elemencie iframe do sprawdzania prac uczniów. WYMAGANE
  3.9 Dodatki POWINNY być zgodne z wytycznymi dotyczącymi dostępności WCAG 2.1 na poziomie AA. Deweloperzy dodatków sami zgłaszają, że to wymaganie jest spełnione w momencie przesyłania dodatku, i że dodatek będzie nadal zgodny z przyszłymi zmianami. POLECANE
  3.10 Wszystkie błędy, które napotka użytkownik, POWINNY być czytelne. POLECANE
  3.11 Jeśli element studentViewUri, teacherViewUri lub studentWorkViewUri jest uruchamiany z skopiowanego projektu lub skopiowanego kursu, dodatek NIE MOŻE wyświetlać strony z błędem w elemencie iframe. WYMAGANE
4.0 Wykrywanie załączników
  4.1 Jeśli załącznik wymaga przesłania projektu przez ucznia, MUSI on zawierać element studentWorkReviewUri, aby był traktowany jako załącznik typu aktywność, a nie typ treści. WYMAGANE
  4.2 Element iframe do wykrywania załączników MUSI udostępniać interfejs użytkownika, który oferuje co najmniej jedną z tych opcji:
  • Utwórz nową treść do dołączenia
  • Przeglądaj, wybieraj i dołączaj z biblioteki treści
  • Instrukcje dołączania treści z Twojej witryny lub innych usług
 WYMAGANE
  4.3 Nauczyciel POWINIEN mieć możliwość znajdowania i otwierania wszystkich treści lub 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ą dołączyć, POWINIEN wykonać tę pracę w elemencie iframe. POLECANE
5.0 Widok ucznia
  5.1 Gdy uruchamiany jest element studentViewUri, dodatek NIE POWINIEN wysuwać użytkownika z elementu iframe, aby mógł wykonać zadanie.
Jeśli dodatek wysuwa użytkownika z elementu iframe, MUSI wyświetlać komunikat lub inną informację, aby uczniowie mogli wrócić do Classroom.		 POLECANE
  5.2 Jeśli aktywność dodatku wysuwa się z elementu iframe, w elemencie iframe POWINIEN być widoczny podgląd zadania. POLECANE
  5.3 Jeśli w aktywności znajduje się przycisk lub link o nazwie Oddaj, MUSI on powodować wysłanie żądania API, aby przesłać pracę ucznia do sprawdzenia przez nauczyciela. WYMAGANE
6.0 Widok nauczyciela
  6.1 Nauczyciel POWINIEN mieć możliwość zobaczenia tego, co zobaczy uczeń, gdy będzie wykonywać projekt. POLECANE
7.0 Sprawdzanie prac uczniów
  7.1 Jeśli uruchamiany jest element studentWorkReviewUri, dodatek MUSI renderować pracę ucznia w elemencie iframe, 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ć nawigacji między uczniami w widoku studentWorkReviewUri. Nawigacja między uczniami MUSI odbywać się tylko w interfejsie Classroom. WYMAGANE
8.0 Obsługa aplikacji mobilnej Classroom
  8.1 Gdy aplikacja mobilna Classroom uruchamia element teacherViewUri, studentViewUri lub studentWorkReviewUri, adres URL MUSI otwierać natywną aplikację mobilną partnera lub mobilną aplikację internetową partnera, a w obu przypadkach MUSI zawierać link bezpośredni 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 najlepiej także o tym, które urządzenia są obsługiwane. WYMAGANE
  8.2 Zadania uczniów POWINNY być wykonywane 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, POWINIENEŚ uaktualnić linki do załączników dodatków. POLECANE
  9.2 Jeśli używasz integracji z CourseWork do tworzenia projektów spoza Classroom, POWINIENEŚ domyślnie tworzyć załączniki dodatków dla wszystkich linków zgodnych z Twoim dodatkiem. 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 POLECANE.
3.12 Usunięto.
5.3 Zmieniono treść. Ostatnia zmiana umożliwia deweloperom dodatków niezawodne oddawanie projektów uczniów za pomocą interfejsu API.
Wersja 1.0 Zaktualizowano 30 kwietnia 2024 r.
1.1 Połączono wymagania 1.1 i 1.2 w jedno.
2.1 Połączono wymagania 2.1 i 2.5 w jedno.
2.2 Połączono wymagania 2.2, 2.3 i 2.4 w jedno.
3.5 Połączono wymagania 3.5, 3.6 i 3.7 w jedno.
3.10 Dodano wymaganie, aby dodatek nigdy nie przechodził w stan niezrozumiały lub nieodwracalny.
3.11, 3.12 Połączono wymagania 5.5, 5.6, 6.3, 6.4, 7.5 i 7.6 w 2 nowe wymagania.
4.2 Rozszerzono opis akceptowalnych funkcji wykrywania załączników.
4.3 Zmieniono numer na 4.2. Zmieniono też z WYMAGANE na POLECANE.
4.4 Zmieniono numer na 4.3.
4.5 Zmieniono numer na 4.4.
5.2 Zmieniono numer na 5.3.
5.3 Zmieniono numer na 5.2.
9.1 Dodano zalecenie, aby uaktualnić wklejone linki do załączników.
9.2 Dodano zalecenie, aby domyślnie tworzyć załączniki dodatków podczas tworzenia projektów CourseWork programowo.
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 wytycznych dotyczących podpowiedzi logowania.
2.4 Dodano scenariusz, w którym wymagane jest wdrożenie parametru hd.
3.2 Zmieniono treść „podaj ścieżkę”.
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Dodano wymagane i zalecane wytyczne dotyczące kopiowania kursu w przypadku elementów studentViewUri, teacherViewUri i studentWorkReviewUri.
Wersja 0.2 Zaktualizowano 29 października 2021 r.
1.3 Dostosowano tekst, aby był bardziej zrozumiały.
3.1 Dodano "Dodatek MUSI być zgodny z ogólnymi wytycznymi dotyczącymi zatwierdzania w GWM które można znaleźć w witrynie"
3.9 Zmieniono WCAG z WYMAGANE na POLECANE.
5.1 Zmieniono WYMAGANE na POLECANE.
5.3 Dodano „Jeśli dodatek wysuwa się z elementu iframe, w elemencie iframe MUSI być widoczny podgląd zadania”.
5.4 Dodano „Jeśli dodatek wysuwa się z elementu iframe, uczniowie POWINNI zobaczyć prośbę o powrót do Classroom”.
8.1 Dodano "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 najlepiej także o tym, które urządzenia są obsługiwane".
8.2 Zmieniono wymaganie dotyczące zadań uczniów na urządzeniach mobilnych z WYMAGANE na POLECANE.
Wersja 0.1 Zaktualizowano 22 września 2021 r.
  Pierwsza wersja.