Konfiguracja projektu Google Cloud

Na tej stronie znajdziesz informacje na temat tworzenia konfigurowanie projektów Google Cloud na potrzeby dodatków do Classroom. Projekty Google Cloud są używane do wdrażania logowania jednokrotnego Google za pomocą protokołu OAuth 2.0 (SSO w Google), aby autoryzować żądania wysyłane przez dodatek i zarządzać informacje o dodatku w Google Workspace Marketplace sklepu.

Ogólne informacje o publikowaniu dodatku do Marketplace: zobacz Publikowanie aplikacji.

Tworzenie projektu Google Cloud

Istnieją 2 typy projektów, które można utworzyć: projekt prywatny używany do oraz projekt publiczny dostępny dla użytkowników. „Serwis publiczny” oraz „prywatny” etykiety odnoszą się do widoczności Twojej aplikacji w Google Workspace Marketplace; prywatna usługa Marketplace aplikację mogą instalować tylko użytkownicy w domenie, w której została została utworzona, podczas gdy publiczna aplikacja z Marketplace w dowolnej domenie Google Workspace. Muszą to być 2 osobne dokumenty. jako projekt nie może być jednocześnie publiczny i prywatny. Aplikacje publiczne muszą zostać sprawdzone i zatwierdzone, zanim trafią na platformę handlową.

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

Tworzenie publicznego projektu Google Cloud

Ten projekt reprezentuje aplikację dodatku, do której mają dostęp dla administratorów, nauczycieli i uczniów. Projekt publiczny musi zostać sprawdzony zatwierdzone przez zespół Google Workspace Marketplace przed wprowadzeniem na rynek lub Zainstalowano.

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

    Tworzenie projektu Google Cloud

  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. Ustawianie pakietu SDK Marketplace Konfiguracja aplikacji Widoczność aplikacji na Publiczna i zaznacz pole Niepubliczna.

  5. Wypełnij wymagane pola w pakiecie SDK Marketplace Informacje o aplikacji i kliknij OPUBLIKUJ.

  6. Twoja aplikacja zostanie sprawdzona przez zespół Google Workspace Marketplace. Ta skontaktuje się z Tobą, używając adresu e-mail dewelopera podanego w Pakiet SDK Marketplace. Gdy aplikacja zostanie zatwierdzona, wyczyść jej zawartość pole Niepubliczny, aby nauczyciele i administratorzy mogli je znaleźć w Rynek.

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ą. W związku z tym Google zaleca za pomocą tego projektu, aby zaprogramować i przetestować dodatek w środowisku kontrolowanym.

Musisz mieć dostęp do domeny Google Workspace for Education w sekcji Teaching and Learning Upgrade. Nauka lub Plus na utworzenie prywatnego projektu. Jeśli nie masz jeszcze dostępu do , wykonaj te czynności, aby skonfigurować domenę demonstracyjną Google Workspace for Education i przenieść ją do Dodaj licencję i zezwól jej na dostęp do interfejsu API dodatków do Classroom:

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

  2. Po zalogowaniu się jako administrator w domenie demonstracyjnej utwórz nowe konto Projekt Google Cloud.

    Tworzenie projektu Google Cloud

    Jeśli nie masz dostępu do konsoli Google Cloud lub nie masz możliwości utworzenia W projektach Cloud sprawdź te elementy w Konsola administracyjna:

    • Przejdź do sekcji Ustawienia konta > ustawienia dostępu na podstawie wieku oraz Zaznacz opcję Wszyscy użytkownicy w tej grupie lub jednostce organizacyjnej mają co najmniej 18 lat lub starsze.
    • 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 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. Przesyłam z prośbą o przeniesienie przez Google Twojej domeny demonstracyjnej do Google Workspace for Education Plus licencji i umożliwia projektowi Cloud dostęp do Interfejs API dodatków do Classroom.

    Otrzymasz e-maila, gdy procesy przekształcania i dodania do listy dozwolonych zostaną gotowe. Przypisz licencje Plus do kont nauczycieli testowych w konsoli administracyjnej. Poniżej Katalog > Użytkownicy, utwórz lub wybierz konta nauczycieli testowych. W każdym na Licencji nauczyciela, sprawdź, czy usługa Google Workspace for Education Plus ma stan Przypisane.

  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. Ustawianie pakietu SDK Marketplace Konfiguracja aplikacji Widoczność aplikacji na prywatną.

  7. Wypełnij wymagane pola w pakiecie SDK Marketplace Informacje o aplikacji i kliknij OPUBLIKUJ. Po opublikowaniu informacji o aplikacji użytkownicy w domenie mogą znaleźć i zainstalować aplikację w Google Workspace Marketplace; otwórz adres URL aplikacji widoczny na stronie z informacjami o aplikacji.

OAuth 2.0

Dostęp do interfejsu Classroom API wymaga zgody na dostęp do danych użytkownika. Te uzyskuje się przez żądanie Google dostępu do zakresów OAuth zalogowanego użytkownika użytkownika i otrzymujący token, który może zostać użyty do późniejszego wywoływania interfejsu API Google Classroom. Zakresy należy skonfigurować w Informacje o aplikacji w Google Workspace Marketplace udostępnione administratorowi domeny mogą wyrazić zgodę w imieniu użytkowników w swojej domenie, jeśli zainstalują dodatek.

Szczegółowa lista wszystkich dostępnych zakresów znajduje się na stronie Zakresy protokołu OAuth dla interfejsów API Google i ich zastosowaniach. Zobacz stronę konfigurowania protokołu OAuth w dokumentacji Workspace. , aby uzyskać ogólne informacje o konfiguracji OAuth.

Uprawnienia użytkownika

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

  • https://www.googleapis.com/auth/userinfo.email, która umożliwia do wyświetlenia adresu e-mail użytkownika.
  • https://www.googleapis.com/auth/userinfo.profile, która umożliwia aplikacji do odczytywania danych osobowych, takich jak portret, imię i nazwisko imiona i nazwiska oraz inne dane osobowe podane przez użytkownika publicznie i dostępności informacji.

Gdy użytkownik autoryzuje jeden z tych zakresów w dodatku, wskazywanych przez parametr zapytania login_hint. Ten parametr jest przekazywany do adresów URL aplikacji po otwarciu elementu iframe. Jeśli użytkownik nie autoryzował z tych zakresów, dane (login_hint) nie zostaną wysłane.

login_hint to standardowe parametry OpenID Connect, które możesz opcjonalnie przekazywane do Google podczas korzystania z Logowania przez Google lub żądania tokena OAuth. it ma na celu ułatwienie procesu autoryzacji.

Zakresy dodatków do Classroom

Te zakresy są specyficzne dla dodatków do Classroom:

  • https://www.googleapis.com/auth/classroom.addons.teacher, która umożliwia do wszystkich metod interfejsu API.
  • https://www.googleapis.com/auth/classroom.addons.student, która umożliwia dostępu z możliwością uruchamiania operacji weryfikacji i odczytu załączników.

Nawet jeśli token dostępu OAuth określa dane uwierzytelniające 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ślone w elemencie courseId w żądaniu.
  • Wymaganie od użytkownika tworzenia, aktualizowania, usuwania i przebiegu zwrotnego ocen załączników zostać nauczycielem.
  • Połączenia z konkretnym postem w Google Classroom są ograniczone przez: weryfikacji.
    • Jeśli dodatek ma już co najmniej jeden załącznik w poście, może wyślij żą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 ma jeszcze załącznika do tego posta. Parametr zapytania addOnToken który może służyć do zgłaszania żądań dotyczących:
      • Utworzenie załącznika pod postem (wymagany jest addOnToken)
      • Weryfikacja uruchamiania (pole addOnToken jest weryfikowane, jeśli zostało podane i jest wymagane, jeśli dodatek nie ma załącznika post)

Weryfikacja OAuth

Dodatek do Classroom korzysta z interfejsów API Google, aby uzyskiwać dostęp do i skalowalnych danych.

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

Informacje o aplikacji w Google Workspace Marketplace

Ogólne informacje o konfiguracji pakietu SDK Google Workspace Marketplace znajdziesz na stronie Włączenie i skonfigurowanie pakietu SDK Google Workspace Marketplace Podaj informacje o aplikacji w Google Workspace Marketplace.

Uwagi na temat wizytówki

Marketplace SDK Store w Twoim publicznym projekcie Google Cloud, Listing zawiera nazwę aplikacji oraz pod kątem odbiorców. Te informacje możesz podać w kilku języki 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”, przez moją firmę” zamiast „Moja firma: Mój dodatek” lub „Mój dodatek, utworzony przeze mnie Firma”.

    • Krótki opis i Szczegółowy opis nie powinny zawierać: dokładnie taki sam tekst.

    + Upewnij się, że masz wybraną wartość w polu Pricing (Ceny). Ten zawiera takie pola: Bezpłatne, Płatne w ramach bezpłatnego okresu próbnego, Zapłacono: funkcje bezpłatne i płatne ceny. Nie musisz określać kosztu jest widoczna na liście produktów w Marketplace.

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

    • Zobaczyć elementy wymienione w aplikacji Marketplace szczegółowy opis, aby dowiedzieć się więcej.

Integracja z usługami licencjonowania i rozliczeń Google

Jeśli chcesz przyznać dostęp do swoich aplikacji z Google Workspace Marketplace przeprowadzić integrację z usługami Google dotyczącymi licencjonowania i rozliczeń, odwiedź stronę API Marketplace.

Ustawienia instalacji

Dodatki umożliwiają instalację pojedynczego urządzenia, a nie tylko przez administratora (administrator). instalacji. Na tej stronie przedstawiliśmy kilka różnic między tymi instalacjami . jego celem nie jest promowanie żadnego z tych typów instalacji. Możesz wybrać, Określa, czy zezwolić na indywidualną instalację w ramach pakietu SDK Google Workspace Marketplace stronie konfiguracji aplikacji.

Instalacja przez administratora

Instalacje przez administratora – umożliwianie administratorowi dodawania dodatków do wszystkich aplikacji kont w domenie albo 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, użytkownicy nie będą proszeni o zgodę na żadne zakresy dostępu, jeśli administrator.

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

  • Bardziej restrykcyjne opcje sterowania Administratorzy mogą określić, którzy użytkownicy mają dostęp do Google Analytics.
  • Zgodność z licencjami. Jeśli aplikacja wymaga licencji, kanałowanie instalacji przez administratora może pomóc w dopilnowaniu, licencje są dystrybuowane i odpowiednio używane wraz z instytucji.
  • Mniejsze obciążenie dla użytkowników. Instalacja przez administratora zmniejsza zestaw pracy nauczycieli i uczniów. Może to ułatwić użytkownikom i uzyskuj mniej kliknięć, a możliwość pomyłki.

Więcej informacji znajdziesz w artykule Instalowanie aplikacji z Marketplace w domenie. przeprowadź instalacje administracyjne i dowiedz się, jak działa struktura organizacyjna. aby dowiedzieć się więcej o jednostkach organizacyjnych i grupach dostępu.

Indywidualna instalacja

Pojedyncze instalacje umożliwiają dodanie dodatku do konta użytkownika. Użytkownik pojawi się prośba o zgodę 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. Może pojawić się prośba o zezwolenie na indywidualną instalację nauczycieli do wdrożenia Twojej usługi lub promowania jej.
  • Testowanie przez administratora. Administrator może samodzielnie zainstalować aby przetestować lub ocenić go przed zatwierdzeniem lub zainstalowaniem do szerszej grupy.

Oprócz instalowania dodatków w imieniu użytkowników administratorzy mogą też utworzyć listę dozwolonych, aby zezwolić użytkownikom na instalowanie dodatków instalacji. Jeśli dodatku nie ma na liście dozwolonych, użytkownicy mogą wyświetlać jest dostępny w Google Workspace Marketplace, ale nie możesz zainstalować add-on; zobaczy komunikat wyjaśniający, że dodatek nie został które może instalować administrator domeny. Zobacz Zarządzanie Google Workspace aplikacji z Marketplace na liście dozwolonych, aby dowiedzieć się więcej o tym działaniu.

Zapoznaj się z dokumentacją dotyczącą ustawień instalacji Google Workspace Marketplace, aby: znajdziesz więcej informacji.

Integracja aplikacji

W polu Identyfikator URI konfiguracji załącznika musisz podać adres URL elementu iframe uruchamiania. Ten Adres URL jest używany jako wartość src elementu iframe 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ń w celu: do swojego projektu.

Musisz też określić wszystkie prefiksy URI, w których dozwolone są załączniki. z Twojego dodatku. Ta funkcja zwiększa bezpieczeństwo, uniemożliwiając załączniki 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 domeny (prywatny). Do przetestowania przełączania się potrzebne są 2 konta uczniów uczniów w elemencie iframe Przegląd pracy ucznia.

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.

Kliknij Dodaj nowego użytkownika. Rysunek 1. Położenie linku Dodaj nowego użytkownika w: w konsoli administracyjnej.

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.

Kliknij Utwórz grupę Rysunek 2. Lokalizacja linku Utwórz grupę w: w konsoli administracyjnej.