Wymagania dotyczące dodatków

Wersja 1.0, 30 kwietnia 2024 r.

Kryteria na tej stronie dotyczą wszystkich dodatków do Classroom. Aby Twój dodatek musi spełniać wszystkie wymagania, aby był zatwierdzony do umieszczenia w Google Workspace Marketplace, był to dodatek o treści „Współpracuje z Classroom”.

Słowa kluczowe „MUSI”, „MUSISZ”, „WYMAGANE”, „SHALL”, „WOLNE”, „POWINNY”, „NIE POWINNY”, „ZALECANE”, „MOŻE” i „OPCJONALNIE” należy interpretować w sposób opisany w RFC 2119.

Wymagania

Identyfikator Typ
1.0 Licencja użytkownika (jeśli dotyczy)
  1.1 Jeśli użytkownik nie ma licencji, MUSI być wyświetlana przyjazna dla użytkownika wiadomość. Komunikat MUSI zawierać jasny powód, dla którego nie można użyć dodatku, i sugerować podjęcie działań przez użytkownika w celu rozwiązania tej sytuacji. WYMAGANE
  1,3 Informacje o dodatku w Google Workspace Marketplace MUSZĄ zawierać szczegółowe informacje o wymaganiach licencyjnych, które mogą być wymagane do jego używania. 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 Dodatek MUSI używać logowania jednokrotnego Google, aby automatycznie logować użytkownika przy kolejnych wizytach bez wyświetlania prośby o zalogowanie.
Jeśli wskazówka dotycząca logowania nie pasuje do aktualnie zalogowanego użytkownika, 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 (co wynika z podpowiedzi dotyczącej logowania), dodatek MUSI wyświetlać przycisk „Zaloguj się przez Google”, aby aktywować proces logowania.
Uwaga: jest to konieczne, aby zachować zgodność ze wskazówkami dotyczącymi promowania marki Google, a także unikać blokowania wyskakujących okienek.		 WYMAGANE
  2.8 Dodatek POWINIEN pokazywać, kto jest obecnie zalogowany. POLECANE
3,0 Ogólne
  3.1 Dodatek MUSI być zgodny z ogólnymi wytycznymi dotyczącymi zatwierdzania 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ść tylko przez proces korzystania z dodatku. Nie może przechodzić do procesu szkoleń ani użyć przycisku udostępniania w Classroom. WYMAGANE
  3.4 Wybór lokalizacji: język POWINNY być obrany na podstawie ustawień lokalnych ustawionych przez przeglądarkę (jeśli są dostępne). POLECANE
  3,5 Jeśli dodatek definiuje maxPoints, MUSI też ustawić pointsEarned, gdy uczeń ukończy zadanie przy użyciu zapisanych danych logowania nauczyciela (zalecane) LUB gdy nauczyciel otworzy zadanie w elemencie iframe z oceną pracy ucznia. WYMAGANE
  3,9 Dodatki MUSZĄ być zgodne z wytycznymi WCAG 2.1, poziom AA w zakresie ułatwień dostępu. Deweloperzy dodatków samodzielnie zgłaszają, że to wymaganie jest spełnione w momencie ich przesyłania i że dodatek zachowuje zgodność z przyszłymi zmianami w dodatku. POLECANE
  3,10 Wszelkie błędy napotkane przez użytkownika MUSZĄ być czytelne dla człowieka. WYMAGANE
  3,11 Jeśli interfejs studentViewUri, teacherViewUri lub studentWorkViewUri został uruchomiony ze skopiowanego projektu lub skopiowanych zajęć, dodatek NIE MOŻE wyświetlać strony błędu w elemencie iframe. WYMAGANE
  3,12 Jeśli interfejs studentViewUri, teacherViewUri lub studentWorkViewUri został uruchomiony ze skopiowanego projektu lub skopiowanego kursu, dodatek POWINIEN wyświetlić nowy załącznik do ukończenia i NIE POWINNO wyświetlać w elemencie iframe odpowiedzi ucznia z wcześniejszych projektów ani zajęć. POLECANE
4,0 Wykrywanie 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ądać, wybierać i załączać treści z biblioteki treści;
  • instrukcje załączania treści z witryny lub innych produktów;
 WYMAGANE
  4.3 Nauczyciel POWINIEN mieć dostęp do wszystkich treści i działań dostępnych dla nauczyciela. POLECANE
  4.4 Przed podjęciem zobowiązań dotyczących załączenia materiałów do projektu nauczyciel MUSI mieć możliwość wyświetlenia podglądu treści/działania. WYMAGANE
  4.5 Jeśli nauczyciel potrzebuje pracy, aby utworzyć treść lub zadanie, zanim będzie można je załączyć, należy je wykonać w elemencie iframe. 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 z elementu iframe wyskakuje działanie dodatku, 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ąć nieporozumień z przyciskiem Oddaj w Classroom. WYMAGANE
6,0 Widok nauczyciela
  6.1 Nauczyciel MUSI zobaczyć, co widzi uczeń podczas wykonywania zadania. POLECANE
7,0 Sprawdzanie pracy ucznia
  7.1 Jeśli studentWorkReviewUri został uruchomiony, dodatek MUSI renderować w elemencie iframe zadanie ucznia do sprawdzenia przez nauczyciela. Materiały dodatkowe mogą zawierać link poza elementem iframe. WYMAGANE
  7.2 Dodatek NIE MOŻE umożliwiać przechodzenia między uczniami w widoku studentWorkReviewUri. Poruszanie się 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 uruchomi teacherViewUri, studentViewUri lub studentWorkReviewUri, URL MUSI otworzyć natywną aplikację mobilną partnera lub aplikację internetową partnera i w obu przypadkach umieścić precyzyjny link do odpowiedniego widoku. Jeśli urządzenie nie jest obsługiwane, MUSISZ wyświetlić użytkownikowi komunikat z informacją, że nie obsługuje on obsługiwanych urządzeń. WYMAGANE
  8.2 Zadania uczniów POWINNY być wykonywanie zadań 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, NALEŻY uaktualnić linki do załączników dodatków. POLECANE
  9.2 Jeśli korzystasz z integracji CourseWork do tworzenia projektów poza Classroom, musisz domyślnie tworzyć załączniki dodatków dla wszystkich linków zgodnych z Twoim dodatkiem. POLECANE

Historia zmian

Wersja 1.0 Aktualizacja: 30 kwietnia 2024 r.
1.1 Połączenie 1.1 i 1.2 w jednym wymaganiu.
2.1 Połączenie 2.1 i 2.5 w jednym wymaganiu.
2.2 Połączenie 2.2, 2.3 i 2.4 w jednym wymaganiu.
3,5 Połączenie 3, 5, 3.6 i 3.7 w jednym wymaganiu.
3,10 Dodano wymaganie, aby dodatek nigdy nie przechodził w niezrozumiały lub nieodwracalny stan.
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 Rozszerzyliśmy opis akceptowanych sposobów wykrywania załączników.
4.3 Zmieniono numerację (wcześniej 4.2). Zmieniono też z REQUIRED na RECOMMENDED.
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 Dodano rekomendację dotyczącą uaktualnienia wklejonych linków do załączników.
9.2 Dodaliśmy rekomendację dotyczącą domyślnego tworzenia załączników dodatków przy automatycznym tworzeniu projektów CourseWork.
2,6, 3,7, 3,8, 6,2, 7,3, 7,4 Usunięto.
Wersja 0.3 Aktualizacja: 22 listopada 2022 r.
2.3 Korekta wskazówek dotyczących logowania.
2.4 Wprowadzono scenariusz, w którym wymagane jest wdrożenie hd.
3.2 Przeformułowane hasło „zapewnianie ścieżki”.
5,5, 5,6, 6,3, 6,4, 7,5, 7,6 Dodaliśmy wymagane treści i zalecane wskazówki dotyczące tych kwestii: studentViewUri, teacherViewUri i studentWorkReviewUri.
Wersja 0.2 Zaktualizowano 29 października 2021 r.
1,3 Ulepszyliśmy tekst, aby był bardziej zrozumiały.
3.1 Dodano „Dodatek MUSI być zgodny z ogólnymi wskazówkami dotyczącymi zatwierdzania GWM podanymi na jego stronie”.
3,9 WCAG zmieniono ustawienie REQUIRED na RECOMMENDED.
5.1 Zmieniono REQUIRED na RECOMMENDED.
5.3 Dodano „Jeśli dodatki wyskakują z elementu iframe, MUSISZ mieć w nim 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 Dodaliśmy informację „Jeśli urządzenie nie jest obsługiwane, MUSI wyświetlić się komunikat informujący użytkownika, że dane urządzenie nie jest obsługiwane, a najlepiej, jakie urządzenia są obsługiwane”.
8.2 Zmiana zadań uczniów mobilnych z WYMAGANE na ZALECANE.
Wersja 0.1 Aktualizacja: 22 września 2021 r.
  Pierwsza wersja.