Ta strona zawiera informacje o tworzeniu i konfigurowaniu projektów Google Cloud na potrzeby dodatków do Classroom. Projekty Google Cloud służą do wdrażania logowania jednokrotnego Google za pomocą protokołu OAuth 2.0 (SSO w Google), do autoryzowania żądań wysyłanych przez dodatek i do zarządzania informacjami o tym dodatku w sklepie Google Workspace Marketplace.
Ogólne informacje o publikowaniu dodatku w Marketplace znajdziesz w artykule Publikowanie aplikacji.
Tworzenie projektu Google Cloud
Istnieją 2 typy projektów, które można utworzyć: projekt prywatny do celów programistycznych i projekt publiczny dostępny dla użytkowników. Etykiety „publiczne” i „prywatne” odnoszą się do widoczności aplikacji w Google Workspace Marketplace. Aplikacje z prywatnej Marketplace mogą instalować tylko użytkownicy w domenie, w której została utworzona. Natomiast publiczna aplikacja z Marketplace jest dostępna dla każdej domeny Google Workspace. Muszą to być 2 osobne aplikacje, ponieważ projekt nie może być jednocześnie publiczny i prywatny. Aplikacje publiczne muszą zostać sprawdzone i zatwierdzone, zanim pojawią się na platformie handlowej.
Ogólne informacje o tworzeniu projektów Google Cloud znajdziesz w artykule Tworzenie projektu Google Cloud.
Tworzenie prywatnego projektu Google Cloud
Ten prywatny projekt reprezentuje aplikację dodatku używaną do programowania. Nie jest dostępna dla użytkowników spoza domeny, w której została utworzona, ale nie wymaga zatwierdzenia przed instalacją. Z tego względu zalecamy wykorzystanie tego projektu do programowania i testowania dodatku w kontrolowanym środowisku.
Aby utworzyć projekt prywatny, musisz mieć dostęp do domeny Google Workspace for Education z licencją na Teaching & Learning lub Plus. Jeśli nie masz jeszcze dostępu do takiej domeny, wykonaj te czynności, aby skonfigurować domenę demonstracyjną Google Workspace for Education, przejść na licencję Plus i zezwolić jej na dostęp do interfejsu API dodatków do Classroom:
- Wykonaj te czynności, aby uzyskać domenę testową dewelopera.
Po zalogowaniu się jako administrator w domenie demonstracyjnej utwórz nowy projekt Google Cloud.
Tworzenie projektu Google Cloud
Jeśli nie masz dostępu do konsoli Google Cloud lub nie możesz tworzyć projektów Cloud, sprawdź w konsoli administracyjnej:
- Wejdź na stronę Ustawienia konta > Ustawienia dostępu na podstawie wieku i wybierz opcję Wszyscy użytkownicy w tej grupie lub jednostce organizacyjnej mają co najmniej 18 lat.
- W sekcji Aplikacje > Dodatkowe usługi Google:
- Usługa Google Cloud Platform jest włączona dla wszystkich.
- Ustawienia tworzenia projektów to Zezwalaj użytkownikom na tworzenie projektów.
- Ustawienia dostępu Cloud Shell to Zezwalaj na dostęp do Cloud Shell.
Wypełnij i prześlij formularz prośby o uaktualnienie domeny demonstracyjnej. Przesłanie tego formularza wymaga od Google uaktualnienia Twojej domeny demonstracyjnej do Google Workspace for Education Plus z 10 licencjami oraz umożliwienia dostępu do Twojego projektu Cloud do interfejsu API dodatków w Classroom.
.Po zakończeniu procesu uaktualniania i dodawania do listy dozwolonych otrzymasz e-maila. Przypisz licencje Plus do kont nauczycieli testowych w konsoli administracyjnej. W sekcji Katalog > Użytkownicy utwórz lub wybierz konta nauczycieli testowych. Na stronie Licencje każdego nauczyciela sprawdź, czy usługa Google Workspace for Education Plus jest przypisana.
włączyć interfejs Classroom API w projekcie Cloud;
włączyć w projekcie Cloud pakiet SDK Google Workspace Marketplace.
Ustaw Konfiguracja aplikacji Widoczność aplikacji w pakiecie SDK Marketplace na prywatną.
Wypełnij wymagane pola na stronie Informacje o aplikacji w pakiecie SDK Marketplace i kliknij OPUBLIKUJ. Po opublikowaniu informacji o aplikacji użytkownicy w domenie mogą ją znaleźć i zainstalować w Google Workspace Marketplace lub pod adresem URL aplikacji widocznym na stronie z informacjami o aplikacji.
Tworzenie publicznego projektu Google Cloud
Ten projekt reprezentuje aplikację dodatku, która jest dostępna dla administratorów, nauczycieli i uczniów.
Utwórz nowy projekt Google Cloud w domenie produkcyjnej.
włączyć interfejs Classroom API w projekcie Cloud;
włączyć w projekcie Cloud pakiet SDK Google Workspace Marketplace.
Ustaw Konfiguracja aplikacji Widoczność aplikacji na Publiczna i zaznacz pole Niepubliczna.
Aby dodać projekt do listy dozwolonych dodatków, udostępnij identyfikator lub numer projektu Cloud partnerowi Google. Dzięki temu projekt uzyska dostęp do nowych funkcji dodatkowych interfejsu Classroom API.
Wypełnij wymagane pola na stronie Informacje o aplikacji w pakiecie SDK Marketplace i kliknij OPUBLIKUJ.
Twoja aplikacja zostanie sprawdzona przez zespół Google Workspace Marketplace. Zespół ten będzie się z Tobą kontaktować, korzystając z adresu e-mail dewelopera podanego w pakiecie SDK Marketplace. Po zatwierdzeniu aplikacji wyczyść pole Niepubliczna, aby nauczyciele i administratorzy mogli ją znaleźć w Marketplace.
OAuth 2.0
Aby uzyskać dostęp do interfejsu API Classroom, użytkownicy muszą wyrazić zgodę na dostęp do danych. Są one uzyskiwane przez przesłanie do Google prośby o dostęp do zakresów OAuth dla zalogowanego użytkownika i odebranie tokena, który może następnie służyć do wywoływania interfejsów API w Google Classroom. Zakresy muszą być skonfigurowane na stronie aplikacji w Google Workspace Marketplace, aby administrator domeny mógł wyrazić zgodę na instalację dodatku w imieniu użytkowników domeny.
Szczegółowa lista wszystkich dostępnych zakresów i ich zastosowań znajduje się na stronie Zakresy OAuth dla interfejsów API Google. Ogólne informacje o konfiguracji OAuth znajdziesz w sekcji Skonfiguruj OAuth w dokumentacji Workspace.
Uprawnienia użytkownika
Aplikacja internetowa powinna żądać co najmniej jednego z tych zakresów:
https://www.googleapis.com/auth/userinfo.email, co umożliwia aplikacji wyświetlanie adresu e-mail użytkownika.https://www.googleapis.com/auth/userinfo.profile, który umożliwia aplikacji wyświetlanie danych osobowych, takich jak portret, imię i nazwisko, oraz innych danych osobowych udostępnionych publicznie przez użytkownika.
Gdy użytkownik autoryzuje jeden z tych zakresów w dodatku, jest on identyfikowany przez parametr zapytania login_hint. Ten parametr jest przekazywany do adresów URL aplikacji internetowej po otwarciu elementu iframe. Jeśli użytkownik nie autoryzował jednego z tych zakresów, do adresów URL aplikacji internetowej jest przekazywany parametr hd („domena hostowana”).
login_hint i hd to standardowe parametry OpenID Connect, które możesz opcjonalnie przekazywać do Google podczas korzystania z funkcji Logowanie przez Google lub żądania tokena OAuth. Mają one usprawnić proces autoryzacji.
Zakresy dodatków do Classroom
Te zakresy są specyficzne dla dodatków do Classroom:
https://www.googleapis.com/auth/classroom.addons.teacher, który umożliwia dostęp do wszystkich metod interfejsu API.https://www.googleapis.com/auth/classroom.addons.student, który umożliwia uruchamianie operacji weryfikacji i odczytu załączników.
Nawet w przypadku prawidłowego tokena dostępu OAuth wskazującego dane logowania użytkownika wywołania interfejsu API są objęte dodatkowymi wymaganiami:
- Wszystkie metody wymagają, aby użytkownik był nauczycielem lub uczniem na zajęciach określonym w prośbie w polu
courseId. - Tworzenie, aktualizowanie, usuwanie i przebiegi zwrotne ocen wymagają, by użytkownik był nauczycielem.
- Połączenia z określonymi postami w Google Classroom są objęte następującymi zasadami weryfikacji.
- Gdy dodatek ma już co najmniej 1 załącznik do posta, może wysyłać żądania:
- Weryfikacja uruchomienia elementu iframe
- Operacje odczytu, aktualizacji i usuwania załączników
- Aktualizacje ocen tego posta
- Przy pierwszym otwarciu elementu iframe wykrywania załączników dodatek może nie mieć jeszcze załącznika do posta. Podany jest parametr zapytania
addOnToken, który może służyć do wysyłania żądań dotyczących:- Utwórz załącznik pod postem (wymagane:
addOnToken) - Weryfikacja uruchomienia (
addOnTokenjest weryfikowana, jeśli została podana i jest wymagana, gdy dodatek nie ma załącznika do posta)
- Utwórz załącznik pod postem (wymagane:
- Gdy dodatek ma już co najmniej 1 załącznik do posta, może wysyłać żądania:
Weryfikacja OAuth
Dodatek do Classroom używa interfejsów API Google do uzyskiwania dostępu do danych użytkowników Google.
Więcej informacji o procesie weryfikacji znajdziesz w najczęstszych pytaniach o weryfikację interfejsu OAuth API.
Informacje o Google Workspace Marketplace
Podczas tworzenia informacji o dodatkach do Classroom w Marketplace w tym programie należy pamiętać o kilku kwestiach.
Ogólne informacje o konfiguracji pakietu SDK Google Workspace Marketplace znajdziesz w artykułach Włączanie i konfigurowanie pakietu SDK Google Workspace Marketplace oraz Tworzenie informacji o sklepie w Google Workspace Marketplace.
Uwagi na temat wizytówki
Lista sklepów SDK Marketplace publicznego projektu Google Cloud zawiera nazwę i opisy aplikacji przeznaczone dla użytkowników. Możesz podać te informacje w wielu językach w sekcji Szczegóły aplikacji.
Przestrzegaj tych wytycznych:
W sekcji Szczegóły aplikacji:
Unikaj znaków interpunkcyjnych w nazwie aplikacji. Na przykład użyj „Mój dodatek od mojej firmy” zamiast „Moja firma: Mój dodatek” lub „Mój dodatek od mojej firmy”.
Krótki opis i Szczegółowy opis nie powinny zawierać dokładnie tego samego tekstu.
Sprawdź, czy w polu Pricing (Ceny) została wybrana wartość. To pole zawiera opcje Bezpłatna, Płatne w ramach bezpłatnego okresu próbnego, Płatne z funkcjami bezpłatnymi i Płatne. Nie musisz podawać kwoty kosztu na liście w Marketplace.
Sprawdź, czy w polu Kategoria została wybrana wartość. Jako dodatek do Classroom dobrym rozwiązaniem mogą być Zasoby akademickie lub Narzędzia dla nauczycieli i administratorów.
Więcej informacji znajdziesz w opisach elementów wymienionych w opisie szczegółów aplikacji w Marketplace.
W sekcji Zasoby graficzne:
Wszystkie dostarczone zasoby graficzne nie są rozmyte i mają rozmiary określone w standardach Google Workspace Marketplace.
Załączone zrzuty ekranu dokładnie odzwierciedlają sposób korzystania z dodatku.
W sekcji Linki do stron pomocy:
- Upewnij się, że został podany link do Warunków korzystania z usługi aplikacji.
Sprawdź, czy są zgodne ze wskazówkami dotyczącymi promowania marki w interfejsach API Google, które obejmują dozwolone nazwy i opisy.
Jeśli w swoim informacjach o firmie odwołujesz się do dowolnej usługi Google, użyj jej nazwy w formacie podanym na liście znaków towarowych. Pamiętaj, by wpisać symbol znaku towarowego (TM), jeśli jest podany. Użyj „Dokumentów GoogleTM”, a nie „Dokumentów Google”.
Integracja z usługami licencjonowania i rozliczeniowymi Google
Jeśli chcesz umożliwić integrację swoich aplikacji z Google Workspace Marketplace z usługami licencjonowania i rozliczeń Google, odwiedź Marketplace API.
Ustawienia instalacji
Dodatki mogą umożliwić instalację indywidualną oprócz instalacji administratora. Na tej stronie opisujemy niektóre różnice między tymi dwoma typami instalacji. Nie promuje ona żadnego z tych rodzajów instalacji. Na stronie konfiguracji aplikacji z pakietu SDK Google Workspace Marketplace możesz określić, czy chcesz zezwolić na indywidualną instalację.
Instalacja przez administratora
Instalacje przez administratora pozwalają administratorowi dodać dodatek do wszystkich kont w domenie albo do określonych grup dostępu lub jednostek organizacyjnych. Tylko administrator domeny może przeprowadzić instalację administratora. Administrator może opcjonalnie wyrazić zgodę na wszystkie zakresy dostępu w imieniu wszystkich użytkowników w domenie. Jeśli tak się stanie, użytkownicy nie będą proszeni o zgodę na żaden z zakresów dostępu.
Poniżej znajdziesz kilka uwag na temat instalacji aplikacji przez administratora.
- Bardziej restrykcyjne ustawienia Administratorzy mogą określać, którzy użytkownicy mają dostęp do dodatku.
- Zgodność z licencjami. Jeśli Twoja aplikacja wymaga licencji, kanałowanie instalacji przez administratora może pomóc w zapewnieniu, że licencje są dystrybuowane i odpowiednio wykorzystywane w odpowiedniej instytucji.
- Mniejsze obciążenie użytkowników. Instalacja przez administratora zmniejsza obciążenie związane z konfiguracją dla nauczycieli i uczniów. Zwiększy to wygodę użytkowników, ponieważ zmniejszy liczbę kliknięć i zmniejszy ryzyko pomyłek.
Więcej informacji o jednostkach organizacyjnych i grupach dostępu znajdziesz w artykule Instalowanie aplikacji z Marketplace w domenie. Więcej informacji o jednostkach organizacyjnych i grupach dostępu znajdziesz w artykule Jak działa struktura organizacyjna.
Indywidualna instalacja
Indywidualne instalacje powodują dodanie dodatku do konta użytkownika. Podczas instalacji użytkownik jest proszony o wyrażenie zgody na zakresy dostępu dodatku.
Poniżej znajdziesz kilka uwag, które należy wziąć pod uwagę podczas instalacji indywidualnej.
- Ułatwiaj wdrażanie. Więcej użytkowników może zobaczyć i zainstalować Twój dodatek z Google Workspace Marketplace. Zezwolenie na indywidualną instalację może zachęcić większej liczby nauczycieli do wdrożenia lub poparcia dla Twojej usługi.
- Testowanie przez administratora. Administrator może samodzielnie zainstalować dodatek, aby go przetestować lub ocenić przed zatwierdzeniem lub zainstalowaniem w większej grupie.
Oprócz instalowania dodatków w imieniu użytkowników administratorzy mogą też utworzyć listę dozwolonych, aby umożliwić użytkownikom instalowanie dodatków zezwalających na indywidualną instalację. Jeśli dodatek nie znajduje się na liście dozwolonych, użytkownicy nadal widzą jego listę w Google Workspace Marketplace, ale nie mogą go zainstalować. Zamiast tego wyświetla się komunikat z informacją, że administrator domeny nie zezwolił na jego zainstalowanie. Więcej informacji o tym zachowaniu znajdziesz w artykule Zarządzanie aplikacjami z Google Workspace Marketplace na liście dozwolonych.
Więcej informacji znajdziesz w dokumentacji ustawień instalacji Google Workspace Marketplace.
Integracja aplikacji
W polu Identyfikator URI konfiguracji załączników musisz podać URL elementu iframe uruchamiania. Ten adres URL jest używany jako wartość elementu iframe src w elemencie iframe wykrywania załączników. Element iframe wykrywania załączników jest używany przez nauczycieli do wyszukiwania treści lub działań, które można dołączyć do projektu.
Musisz też określić wszystkie prefiksy URI, z których dozwolone są załączniki w dodatku. Ta funkcja zwiększa bezpieczeństwo, ponieważ uniemożliwia dostęp do załączników z nieautoryzowanych źródeł.
Więcej informacji o tych polach znajdziesz na stronie z przewodnikiem po elementach iframe.
Konta testowe
Utwórz konta testowe w domenie demonstracyjnej, aby sprawdzić, czy Twój prywatny dodatek działa prawidłowo. Aby przetestować przełączanie się między uczniami, w elemencie iframe z oceną zadań uczniów potrzebne są 2 konta uczniów.
Sugerowane konta testowe:
- Nauczyciel Tama, adam.nauczyciel@<twoja domena demonstracyjna>
- Jan Student, sam.student@<twoja domena demonstracyjna>
- Sandra Student, anna.student@<twoja domena demonstracyjna>
Aby utworzyć nowe konto testowe, wykonaj te czynności:
- Zaloguj się w konsoli administracyjnej.
- Otwórz kartę Użytkownicy.
- Kliknij Dodaj nowego użytkownika (patrz Rysunek 1).
- Wpisz dane użytkownika i przypisz odpowiednie role.
Rysunek 1. Lokalizacja linku Dodaj nowego użytkownika w konsoli administracyjnej.
Aby utworzyć nową grupę testową, wykonaj te czynności:
- Zaloguj się w konsoli administracyjnej.
- Otwórz Grupy.
- Kliknij Utwórz grupę (patrz Rysunek 2).
- Wpisz członków i właścicieli grupy.
Rysunek 2. Lokalizacja linku Utwórz grupę w konsoli administracyjnej.