Konfiguracja projektu Google Cloud

Na tej stronie znajdziesz informacje o tworzeniu i konfigurowaniu projektów Google Cloud z dodatkami do Classroom. Projekty Google Cloud służą do wdrażania logowania jednokrotnego w Google za pomocą protokołu OAuth 2.0 (logowania jednokrotnego Google), autoryzowania żądań wysyłanych przez Twój dodatek oraz zarządzania informacjami o dodatku w sklepie Google Workspace Marketplace.

Ogólne informacje o publikowaniu dodatku w Marketplace znajdziesz w artykule Publikowanie aplikacji.

Tworzenie projektu Google Cloud

Ważne: produkcyjna aplikacja dodatku musi mieć ustawioną widoczność publiczną w pakiecie SDK Google Workspace Marketplace. Projekt prywatny może być przydatny do tworzenia i testowania dodatku, ale wymagany jest tylko projekt publiczny.

Można utworzyć 2 typy projektów: projekt prywatny używany do programowania oraz projekt publiczny dostępny dla użytkowników. Etykiety „publiczna” i „prywatna” odnoszą się do widoczności aplikacji w Google Workspace Marketplace. Prywatną aplikację z Marketplace mogą zainstalować tylko użytkownicy w domenie, w której została utworzona, a publiczna aplikacja z Marketplace jest dostępna dla dowolnej 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 trafią do Marketplace.

Ważne: nie można przekonwertować projektu prywatnego na publiczny.

Ogólne informacje o tworzeniu projektów Google Cloud znajdziesz w artykule Tworzenie projektu Google Cloud.

Tworzenie publicznego projektu Google Cloud

Ten projekt reprezentuje aplikację dodatku, która jest dostępna dla administratorów, nauczycieli i uczniów. Zanim projekt publiczny zostanie uruchomiony lub zainstalowany, musi zostać sprawdzony i zatwierdzony przez zespół Google Workspace Marketplace.

1. Utwórz nowy projekt Google Cloud w domenie produkcyjnej.

   Tworzenie projektu Google Cloud

   Ważne: upewnij się, że projekt należy do Twojej domeny produkcyjnej i że jesteś zalogowany(-a) w konsoli Google Cloud jako użytkownik tej domeny.
   Ostrzeżenie: do testowania musisz używać wersji roboczej projektu. Obecnie funkcja w wersji roboczej jest dostępna tylko w ramach Programu dla programistów Google Workspace. Po utworzeniu projektu Cloud wypełnij formularz zgłoszeniowy, aby włączyć funkcje Programu testowania aktualizacji Google Workspace dla programistów. Więcej informacji znajdziesz w artykule Aktualizowanie informacji o aplikacji przy użyciu wersji roboczych.

2. włączyć interfejs Classroom API w projekcie Cloud;

   Włączanie interfejsu Classroom API

3. Włącz w projekcie Cloud pakiet SDK Google Workspace Marketplace.

   Włączanie pakietu SDK Google Workspace Marketplace

4. Ustaw Konfiguracja aplikacji w pakiecie SDK Marketplace dla opcji Widoczność aplikacji na Publiczna i zaznacz pole Niepubliczna.

   Ważne: nie można udostępniać ani konwertować prywatnego projektu używanego podczas wewnętrznego programowania i testowania.
   Ważne: aplikacji niepublicznych nie można znaleźć w Google Workspace Marketplace przez przeglądanie ani wyszukiwanie. W konfiguracji pakietu SDK Marketplace znajdziesz bezpośredni adres URL, którego możesz użyć do zainstalowania dodatku. Tylko Google i deweloper mogą znaleźć stronę z informacjami o aplikacji. Aplikacja powinna pozostać niepubliczna, dopóki nie chcesz jej udostępniać publicznie. Możesz określić, czy dodatek ma być wymieniony na stronie Konfiguracja aplikacji w pakiecie SDK Marketplace.

5. Wypełnij wymagane pola na stronie Informacje o aplikacji pakietu SDK Marketplace i kliknij OPUBLIKUJ.

6. Twoja aplikacja zostanie sprawdzona przez zespół Google Workspace Marketplace. Skontaktują się z Tobą, używając adresu e-mail dewelopera podanego w pakiecie SDK Marketplace. Po zatwierdzeniu aplikacji wyczyść pole Niepubliczna, aby nauczyciele i administratorzy mogli ją znaleźć w Marketplace.

Tworzenie prywatnego projektu Google Cloud

Ten projekt prywatny reprezentuje aplikację dodatku używaną do programowania. Nie jest dostępny dla użytkowników spoza domeny, w której został utworzony, ale nie wymaga zatwierdzenia przed instalacją. Dlatego Google zaleca wykorzystanie tego projektu do opracowania i przetestowania dodatku w środowisku kontrolowanym.

Aby utworzyć projekt prywatny, musisz mieć dostęp do domeny Google Workspace for Education z licencją Teaching & Learning lub Plus. Jeśli jeszcze nie masz dostępu do takiej domeny, wykonaj te czynności, aby skonfigurować domenę demonstracyjną Google Workspace for Education, uaktualnić ją do licencji Plus i zezwolić jej na dostęp do interfejsu API dodatków do Classroom:

1. Wykonaj te czynności, aby uzyskać domenę testową dewelopera.

2. Zaloguj się jako administrator w domenie demonstracyjnej i utwórz nowy projekt Google Cloud.

   Tworzenie projektu Google Cloud

   Ostrzeżenie: sprawdź, czy projekt należy do domeny demonstracyjnej i czy korzystasz z konsoli Google Cloud przy użyciu konta administratora domeny demonstracyjnej.

   Jeśli nie masz dostępu do konsoli Google Cloud ani nie możesz utworzyć projektów Cloud, sprawdź te kwestie w konsoli administracyjnej:

   • Otwórz 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 > Usługi dodatkowe 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 do Cloud Shell to Zezwól na dostęp do Cloud Shell.

3. Wypełnij i prześlij formularz prośby o uaktualnienie domeny demonstracyjnej. Po przesłaniu tego formularza prosisz Google o uaktualnienie domeny demonstracyjnej do Google Workspace for Education Plus z 10 licencjami oraz zezwolenie Twojemu projektowi Cloud na interfejs API dodatków do 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. W Licencji każdego nauczyciela sprawdź, czy usługa Google Workspace for Education Plus jest przypisana.

4. włączyć interfejs Classroom API w projekcie Cloud;

   Włączanie interfejsu Classroom API

5. Włącz w projekcie Cloud pakiet SDK Google Workspace Marketplace.

   Włączanie pakietu SDK Google Workspace Marketplace

6. Ustaw Konfigurację aplikacji Widoczność aplikacji z pakietu SDK Marketplace na prywatną.

7. Wypełnij wymagane pola na stronie Informacje o aplikacji pakietu SDK Marketplace i kliknij OPUBLIKUJ. Po opublikowaniu informacji o aplikacji użytkownicy w domenie mogą ją znaleźć i zainstalować w Google Workspace Marketplace lub po otwarciu adresu URL aplikacji widocznego na stronie z informacjami o aplikacji.

OAuth 2.0

Dostęp do interfejsu Classroom API wymaga zgody na dostęp do danych użytkownika. Aby uzyskać te uprawnienia, poproś Google o dostęp do zakresów OAuth zalogowanego użytkownika i otrzymaj token, który można wykorzystać 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ę w imieniu użytkowników domeny, jeśli zainstalują oni dodatek.

Ważne: jeśli Twój dodatek żąda dodatkowych zakresów, umieść je na ekranie zgody OAuth, karcie Konfiguracja aplikacji z pakietu SDK Marketplace oraz w kodzie aplikacji dodatku. Niezgodność zakresów w tych lokalizacjach może spowodować problemy u użytkowników podczas instalowania dodatków.

Szczegółową listę wszystkich dostępnych zakresów i ich zastosowań znajdziesz na stronie Zakresy protokołu OAuth dla interfejsów API Google. Ogólne informacje o konfiguracji OAuth znajdziesz w artykule Konfigurowanie strony OAuth w dokumentacji Workspace.

Uprawnienia użytkownika

Aplikacja internetowa powinna żądać co najmniej 1 z tych zakresów:

• https://www.googleapis.com/auth/userinfo.email, który umożliwia aplikacji sprawdzanie adresu e-mail użytkownika.
• https://www.googleapis.com/auth/userinfo.profile, który umożliwia aplikacji dostęp do danych osobowych, takich jak portret, imiona i nazwiska, oraz inne dane osobowe udostępnione przez użytkownika publicznie.

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ł żadnego z tych zakresów, zakres login_hint nie zostanie wysłany.

Ostrzeżenie: aplikacja musi zażądać co najmniej 1 z zakresów userinfo.email lub userinfo.profile, aby otrzymywać login_hint przy kolejnych wizytach tego samego użytkownika.

login_hint to standardowe parametry OpenID Connect, które możesz opcjonalnie przekazywać Google podczas korzystania z Logowania przez Google lub żądania tokena OAuth. Ma to na celu ułatwienie procesu autoryzacji dla użytkownika.

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 dostęp do uruchamiania operacji weryfikacji i odczytu załączników.

Nawet jeśli token dostępu OAuth określa 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ślonych w atrybucie courseId w żądaniu.
• Aby tworzyć, aktualizować, usuwać i przebiegać oceny załączników, użytkownik musi być nauczycielem.
• Połączenia z konkretnym postem w Google Classroom są objęte następującymi weryfikacjami.
  • Gdy dodatek ma już co najmniej jeden załącznik w poście, może wysyłać żądania dotyczące:
    • Weryfikacja uruchamiania elementu iframe
    • Operacje odczytu, aktualizacji i usuwania załączników
    • aktualizacje ocen w tym poście,
  • Po pierwszym otwarciu elementu iframe wykrywania załączników dodatek może nie mieć jeszcze załącznika w poście. Udostępniany jest parametr zapytania addOnToken, którego można używać do wysyłania żądań dotyczących tych elementów:
    • Utworzenie załącznika pod postem (wymagany jest addOnToken)
    • Weryfikacja uruchamiania (pole addOnToken jest sprawdzane, jeśli podano, i wymagane, gdy dodatek nie ma w poście załącznika)

Weryfikacja OAuth

Uwaga: nie możesz utworzyć filmu demonstracyjnego do przesłania w ramach procesu weryfikacji OAuth. Zamiast tego opublikuj dodatek bez weryfikacji protokołu OAuth. Dzięki temu zespół ds. weryfikacji Google Workspace Marketplace będzie mógł stworzyć w Twoim imieniu film demonstracyjny. Następnie zespół ds. weryfikacji udostępni Ci film, aby możesz go uwzględnić w przesyłanej prośbie o weryfikację OAuth.

Dodatek do Classroom korzysta z interfejsów API Google, aby uzyskiwać dostęp do danych użytkowników Google.

• Weryfikacja tożsamości marki
• Sprawdzanie poufnych zakresów protokołu OAuth

Więcej informacji o procesie weryfikacji znajdziesz w najczęstszych pytaniach o weryfikację interfejsu OAuth API.

Informacje o aplikacji w Google Workspace Marketplace

Ostrzeżenie: gdy zapiszesz opcję widoczności podczas publikowania, nie będzie można później zmienić wyboru.

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 aplikacji w Google Workspace Marketplace.

Uwagi na temat wizytówki

Lista magazynów pakietu SDK Marketplace w publicznym projekcie Google Cloud zawiera nazwę i opisy aplikacji przeznaczone dla użytkowników. Informacje te możesz podać 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 wpisz „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.

  + Upewnij się, że masz wybraną wartość w polu Pricing (Ceny). To pole obejmuje opcje Bezpłatne, Płatne w ramach bezpłatnego okresu próbnego, Płatne funkcje bezpłatne i Płatne. Nie musisz określać kwoty kosztu w informacjach o produkcie w Marketplace.

  • Upewnij się, że wybrano wartość w polu Kategoria. Dobrym rozwiązaniem mogą być Zasoby akademickie lub Narzędzia dla nauczycieli i administratorów.

  • Więcej informacji znajdziesz w opisie szczegółów aplikacji w Marketplace.

Ważne: sprawdź szczegóły aplikacji w przypadku każdego języka, w którym oferujesz dodatek.

• W sekcji Zasoby graficzne:

  • Żadne przesłane zasoby graficzne nie są rozmyte i mają rozmiary określone w standardach Google Workspace Marketplace.

  • Zrzuty ekranu przedstawiają dokładne przedstawienie dodatku.

• W sekcji Linki pomocy:

  • Pamiętaj, by podać link do Warunków korzystania z usługi aplikacji.

• Upewnij się, że postępujesz zgodnie ze wskazówkami dotyczącymi promowania marki w interfejsach API Google, które obejmują dozwolone nazwy i opisy.

• Jeśli w wizytówce odnosi się do którejkolwiek usługi Google, użyj jej nazwy w formacie podanym na liście znaków towarowych. Sprawdź, czy dodano symbol znaku towarowego (TM), jeśli jest podany. Użyj „Dokumentów GoogleTM”, a nie „Dokumentów Google”.

Integracja z usługami licencjonowania i rozliczeń Google

Jeśli chcesz umożliwić integrację swoich aplikacji z Google Workspace Marketplace z usługami licencjonowania i rozliczeń Google, otwórz interfejs Marketplace API.

Ustawienia instalacji

Dodatki umożliwiają instalację pojedynczo, a nie tylko przez instalację przez administratora. Na tej stronie opisujemy pewne różnice między tymi dwoma typami instalacji. Nie służy ona do promowania żadnego z tych typów instalacji. Możesz zdecydować, czy zezwolić na indywidualną instalację, na stronie konfiguracji aplikacji pakietu SDK Google Workspace Marketplace.

Instalacja przez administratora

Instalacje administratora umożliwiają administratorowi dodawanie dodatku do wszystkich kont w domenie albo do określonych grup dostępu lub jednostek organizacyjnych. Instalację może przeprowadzić tylko administrator domeny. Administrator może opcjonalnie wyrazić zgodę na wszystkie zakresy dostępu w imieniu wszystkich użytkowników w domenie. Jeśli administrator zdecyduje się to zrobić, użytkownicy nie będą proszeni o zgodę na żadne zakresy dostępu.

Poniżej znajdziesz kilka uwag na temat instalowania przez administratora.

• Bardziej restrykcyjne opcje sterowania Administratorzy mogą ograniczyć dostęp użytkowników do dodatku.
• Zgodność z licencjami. Jeśli Twoja aplikacja wymaga licencji, kierowanie instalacji przez administratora może pomóc w zapewnieniu prawidłowego rozpowszechniania licencji i korzystania z nich w odpowiedniej instytucji.
• Mniejsze obciążenie dla użytkowników. Instalacja przez administratora zmniejsza obciążenie konfiguracyjne dla nauczycieli i uczniów. Zwiększa to wygodę użytkowników i zmniejsza liczbę kliknięć, a jednocześnie eliminuje ryzyko pomyłek.

Zapoznaj się z artykułem Instalowanie aplikacji z Marketplace w domenie, aby dowiedzieć się więcej o przeprowadzaniu instalacji przez administratora, i sposobie działania struktury organizacyjnej, aby dowiedzieć się więcej o jednostkach organizacyjnych i grupach dostępu.

Indywidualna instalacja

Pojedyncze instalacje umożliwiają dodanie dodatku do konta użytkownika. Podczas instalacji użytkownik zostanie poproszony o wyrażenie zgody na zakresy dostępu dodatku.

Poniżej przedstawiamy kilka uwag dotyczących indywidualnej instalacji.

• Ułatwiaj wdrożenie. 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ć nauczycieli do wdrożenia Twojego produktu lub jego poparcia.
• Testowanie przez administratora. Administrator może samodzielnie zainstalować dodatek, aby go przetestować lub ocenić, zanim zatwierdzi go lub zainstaluje dla szerszej grupy.

Oprócz instalowania dodatków w imieniu użytkowników administratorzy mogą też zarządzać listą dozwolonych, aby zezwalać użytkownikom na instalowanie dodatków, które umożliwiają ich instalację. Jeśli dodatku nie ma na liście dozwolonych, użytkownicy nadal mogą zobaczyć informacje o dodatku w Google Workspace Marketplace, ale nie mogą go zainstalować. Zamiast tego zobaczą komunikat z informacją, że administrator domeny nie zezwolił na zainstalowanie dodatku. Więcej informacji o tym działaniu znajdziesz w artykule Zarządzanie aplikacjami z Google Workspace Marketplace na liście dozwolonych.

Więcej informacji znajdziesz w dokumentacji dotyczącej ustawień instalacji Google Workspace Marketplace.

Integracja aplikacji

W polu Identyfikator URI konfiguracji załącznika musisz podać adres 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, w których dodatek może zezwalać na załączniki. Ta funkcja zwiększa bezpieczeństwo, zapobiegając wysyłaniu załączników z nieautoryzowanych źródeł.

Więcej informacji o tych polach znajdziesz na stronie przewodnika po elementach iframe.

Konta testowe

Utwórz konta testowe w domenie demonstracyjnej, aby zweryfikować prawidłowe działanie dodatku prywatnego. Aby przetestować przełączanie się między uczniami w elemencie iframe Przegląd pracy ucznia, potrzebne są 2 konta uczniów.

Sugerowane konta testowe:

• Tammy Teacher, tammy.teacher@<twoja-domena demonstracyjna>
• Sam Student, sam.student@<twoja-domena demonstracyjna>
• Sally Student, sally.student@<twoja-domena demonstracyjna>

Aby utworzyć nowe konto testowe, wykonaj te czynności:

1. Zaloguj się w konsoli administracyjnej.
2. Kliknij Użytkownicy.
3. Kliknij Dodaj nowego użytkownika (zobacz ilustrację 1).
4. Wpisz dane użytkownika i przypisz odpowiednie role.

Rysunek 1. W konsoli administracyjnej znajduje się link Dodaj nowego użytkownika.

Aby utworzyć nową grupę testową, wykonaj te czynności:

1. Zaloguj się w konsoli administracyjnej.
2. Otwórz Grupy dyskusyjne.
3. Kliknij Utwórz grupę (zobacz ilustrację 2).
4. Wpisz członków i właścicieli grupy.

Rysunek 2. W konsoli administracyjnej znajduje się link Utwórz grupę.