Tworzenie aplikacji wiersza poleceń w języku Java, która wysyła żądania do interfejsu Google Classroom API
Krótkie wprowadzenia wyjaśniają, jak skonfigurować i uruchomić aplikację, która wywołuje interfejs Google Workspace API. W tym krótkim wprowadzeniu używamy uproszczonego podejścia do uwierzytelniania, które jest odpowiednie dla środowiska testowego. W przypadku środowiska produkcyjnego zalecamy zapoznanie się z uwierzytelnianiem i autoryzacją przed wybraniem danych logowania odpowiednich dla Twojej aplikacji.
W tym krótkim wprowadzeniu używamy zalecanych przez Google Workspace bibliotek klienta interfejsu API do obsługi niektórych szczegółów procesu uwierzytelniania i autoryzacji.
Cele
- Skonfiguruj środowisko.
- Skonfiguruj próbkę.
- Uruchom próbkę.
Wymagania wstępne
- Java 11 lub nowsza.
- Gradle 7.0 lub nowszy.
- Projekt Google Cloud.
- Konto Google for Education z włączoną usługą Google Classroom.
Konfigurowanie środowiska
Aby ukończyć to krótkie wprowadzenie, skonfiguruj środowisko.
Włącz API
Zanim zaczniesz korzystać z interfejsów API Google, musisz je włączyć w projekcie Google Cloud. W jednym projekcie Google Cloud możesz włączyć co najmniej 1 interfejs API.W konsoli Google Cloud włącz interfejs Google Classroom API.
Konfigurowanie ekranu zgody OAuth
Jeśli do ukończenia tego krótkiego wprowadzenia używasz nowego projektu Google Cloud, skonfiguruj ekran zgody OAuth. Jeśli ten krok został już wykonany w przypadku projektu Cloud, przejdź do następnej sekcji.
- W konsoli Google API otwórz Menu > Platforma uwierzytelniania Google > Elementy marki.
- Jeśli platforma uwierzytelniania Google została już skonfigurowana, możesz skonfigurować te ustawienia ekranu zgody OAuth w sekcjach Elementy marki, Odbiorcy i Dostęp do danych. Jeśli zobaczysz komunikat Platforma uwierzytelniania Google nie została jeszcze skonfigurowana, kliknij Rozpocznij:
- W sekcji Informacje o aplikacji w polu Nazwa aplikacji wpisz nazwę aplikacji.
- W polu Adres e-mail dla użytkowników potrzebujących pomocy wybierz adres e-mail, na który użytkownicy mogą się kontaktować, jeśli mają pytania dotyczące zgody.
- Kliknij Dalej.
- W sekcji Odbiorcy wybierz Wewnętrzni.
- Kliknij Dalej.
- W sekcji Dane kontaktowe wpisz Adres e-mail, na który będziesz otrzymywać powiadomienia o wszelkich zmianach w projekcie.
- Kliknij Dalej.
- W sekcji Zakończ zapoznaj się z Zasadami dotyczącymi danych użytkownika w usługach interfejsu API Google. Jeśli się z nimi zgadzasz, zaznacz pole Akceptuję zasady dotyczące danych użytkownika w usługach interfejsu API Google.
- Kliknij Dalej.
- Kliknij Utwórz.
- Na razie możesz pominąć dodawanie zakresów. W przyszłości, gdy będziesz tworzyć aplikację do użytku poza organizacją Google Workspace, musisz zmienić Typ użytkownika na Zewnętrzny. Następnie dodaj zakresy autoryzacji wymagane przez aplikację. Więcej informacji znajdziesz w pełnym przewodniku Konfigurowanie ekranu zgody OAuth.
Autoryzowanie danych logowania aplikacji na komputer
Aby uwierzytelniać użytkowników i uzyskiwać dostęp do danych użytkowników w aplikacji, musisz utworzyć co najmniej 1 identyfikator klienta OAuth 2.0. Identyfikator klienta wskazuje konkretną aplikację na serwerach OAuth Google. Jeśli Twoja aplikacja działa na kilku platformach, musisz utworzyć osobny identyfikator klienta dla każdej z nich.- W konsoli Google Cloud otwórz Menu > Platforma uwierzytelniania Google > Klienci.
- Kliknij Utwórz klienta.
- Kliknij Typ aplikacji > Aplikacja na komputer.
- W polu Nazwa wpisz nazwę danych logowania. Ta nazwa jest widoczna tylko w konsoli Google Cloud.
- Kliknij Utwórz.
Nowo utworzone dane logowania pojawią się w sekcji „Identyfikatory klientów OAuth 2.0”.
- Zapisz pobrany plik JSON jako
credentials.jsoni przenieś plik do katalogu roboczego.
Przygotowywanie obszaru roboczego
W katalogu roboczym utwórz nową strukturę projektu:
gradle init --type basic mkdir -p src/main/java src/main/resourcesW katalogu
src/main/resources/skopiuj pobrany wcześniej plikcredentials.json.Otwórz domyślny plik
build.gradlei zastąp jego zawartość tym kodem:
Konfigurowanie próbki
W katalogu
src/main/java/utwórz nowy plik Java o nazwie zgodnej z wartościąmainClassNamew plikubuild.gradle.W nowym pliku Java umieść ten kod:
Uruchamianie próbki
Uruchom próbkę:
gradle run
-
Gdy uruchomisz próbkę po raz pierwszy, pojawi się prośba o autoryzację dostępu:
- Jeśli nie zalogowano się na konto Google, zaloguj się, gdy pojawi się prośba. Jeśli korzystasz z kilku kont, wybierz jedno, którego chcesz użyć do autoryzacji.
- Kliknij Akceptuję.
Aplikacja Java zostanie uruchomiona i wywoła interfejs Google Classroom API.
Informacje o autoryzacji są przechowywane w systemie plików, więc gdy następnym razem uruchomisz przykładowy kod, nie zobaczysz prośby o autoryzację.
Dalsze kroki
- Wypróbuj interfejsy Google Workspace API w narzędziu API Explorer.
- Rozwiązywanie problemów z uwierzytelnianiem i autoryzacją
- Dokumentacja interfejsu Classroom API
- Dokumentacja klienta interfejsów API Google do języka Java
- Dokumentacja Javadoc interfejsu Google Classroom API