Poziom kodowania: średniozaawansowany
Czas trwania: 30 minut
Typ projektu: dodatek do Google Workspace
Cele
- Dowiedz się, jak działa dodatek.
- Dowiedz się, jak utworzyć dodatek przy użyciu Apps Script, i poznaj działanie usług Apps Script.
- skonfigurować środowisko,
- Skonfiguruj skrypt.
- Uruchom skrypt.
Informacje o tym dodatku do Google Workspace
W tym przykładzie tworzysz dodatek do Google Workspace, który wyświetla podgląd linków z Książek Google w dokumencie Dokumentów Google. Gdy wpiszesz lub wkleisz URL z Książek Google do dokumentu, dodatek rozpozna link i wyświetli jego podgląd. Aby wyświetlić podgląd linku, możesz przekonwertować link na element inteligentny i najechać na niego kursorem, aby wyświetlić kartę z dodatkowymi informacjami o książce.
Ten dodatek korzysta z usługi UrlFetch dostępnej w Apps Script, by łączyć się z interfejsem API Książek Google i pobierać informacje o Książkach Google, które mają być wyświetlane w Dokumentach Google.
Jak to działa
W pliku manifestu dodatku Google Workspace skrypt konfiguruje dodatek w taki sposób, aby rozszerzał on Dokumenty Google i uruchamiał podgląd linków do podstron pasujących do określonych wzorców w witrynie Książki Google (https://books.google.com
).
W pliku kodu skrypt łączy się z interfejsem Google Books API i używa adresu URL do pobrania informacji o książce (który jest wystąpieniem zasobu Volume
). Skrypt korzysta z tych informacji, aby wygenerować element inteligentny, który wyświetla tytuł książki i kartę podglądu, która zawiera podsumowanie, liczbę stron, obraz okładki książki i liczbę ocen.
Usługi Apps Script
Ten dodatek korzysta z następujących usług:
- UrlFetch – łączy się z interfejsem Google Books API, aby pobierać informacje o książkach (które są instancjami zasobu
Volume
interfejsu API). - Usługa karty – tworzy interfejs dodatku.
Wymagania wstępne
Aby korzystać z tego przykładu, musisz spełnić te wymagania wstępne:
- konta Google (konta Google Workspace mogą wymagać zatwierdzenia przez administratora),
Przeglądarka z dostępem do internetu.
Projekt Google Cloud z powiązanym kontem rozliczeniowym. Więcej informacji znajdziesz w artykule Włączanie płatności w projekcie.
Konfigurowanie środowiska
Otwieranie projektu Cloud w konsoli Google Cloud
Jeśli nie jest jeszcze otwarty, otwórz projekt Cloud, którego chcesz użyć w tym przykładzie:
- W konsoli Google Cloud otwórz stronę Wybierz projekt.
- Wybierz projekt Google Cloud, którego chcesz użyć. Możesz też kliknąć Utwórz projekt i postępować zgodnie z instrukcjami wyświetlanymi na ekranie. Jeśli utworzysz projekt Google Cloud, może być konieczne włączenie dla niego płatności.
Włączanie interfejsu Google Books API
Ten dodatek łączy się z interfejsem API Książek Google. Zanim zaczniesz korzystać z interfejsów API Google, musisz włączyć je w projekcie Google Cloud. W jednym projekcie Google Cloud możesz włączyć 1 lub więcej interfejsów API.
W swoim projekcie Cloud włącz interfejs Books API.
Konfigurowanie ekranu zgody OAuth
Ten dodatek wymaga projektu Cloud ze skonfigurowanym ekranem zgody. Skonfigurowanie ekranu zgody OAuth określa, co Google wyświetla użytkownikom, i rejestruje aplikację, aby umożliwić Ci opublikowanie jej później.
- W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Ekran akceptacji OAuth.
- W polu Typ użytkownika wybierz Wewnętrzny i kliknij Utwórz.
- Wypełnij formularz rejestracji aplikacji, a następnie kliknij Zapisz i kontynuuj.
Na razie możesz pominąć dodawanie zakresów i kliknąć Zapisz i kontynuuj. Gdy w przyszłości będziesz tworzyć aplikację do użytku poza organizacją Google Workspace, musisz zmienić Typ użytkownika na Zewnętrzny, a następnie dodać zakresy autoryzacji wymagane przez Twoją aplikację.
- Przejrzyj podsumowanie rejestracji aplikacji. Aby wprowadzić zmiany, kliknij Edytuj. Jeśli rejestracja aplikacji wygląda na prawidłową, kliknij Back to Dashboard (Powrót do panelu).
Uzyskiwanie klucza interfejsu API dla interfejsu API Książek Google
- Otwórz konsolę Google Cloud. Sprawdź, czy projekt z włączonymi płatnościami jest otwarty.
W konsoli Google Cloud kliknij Menu > Interfejsy API i usługi > Dane logowania.
Kliknij Utwórz dane logowania > Klucz interfejsu API.
Zanotuj swój klucz interfejsu API – będzie Ci potrzebny w późniejszym kroku.
Konfigurowanie skryptu
Tworzenie projektu Apps Script
- Kliknij przycisk poniżej, aby otworzyć projekt Apps Script podgląd linków w Książkach Google.
Otwórz projekt - Kliknij Przegląd.
- Na stronie przeglądu kliknij Utwórz kopię.
- W swojej kopii projektu Apps Script otwórz plik
Code.gs
i zastąpYOUR_API_KEY
kluczem interfejsu API wygenerowanym w poprzedniej sekcji.
Kopiowanie numeru projektu Cloud
- W konsoli Google Cloud kliknij Menu > Administracja > Ustawienia.
- Skopiuj wartość z pola Numer projektu.
Ustawianie projektu Cloud dla projektu Apps Script
- W projekcie Apps Script kliknij Ustawienia projektu.
- W sekcji Projekt Google Cloud Platform (GCP) kliknij Zmień projekt.
- W polu Numer projektu GCP wklej numer projektu Google Cloud.
- Kliknij Ustaw projekt.
Testowanie dodatku
Instalowanie wdrożenia testowego
- W projekcie Apps Script kliknij Edytor.
- Otwórz plik
Code.gs
i kliknij Uruchom. Gdy pojawi się odpowiedni komunikat, autoryzuj skrypt. - Kliknij Wdróż > Testuj wdrożenia.
- Kliknij Zainstaluj > Gotowe.
Wyświetlanie podglądu linku w Dokumentach Google
- Utwórz dokument w Dokumentach Google na stronie docs.new.
- Wklej ten adres URL do dokumentu i naciśnij klawisz Tab, aby przekonwertować adres URL na element inteligentny:
https://www.google.com/books/edition/Software_Engineering_at_Google/V3TTDwAAQBAJ
- Najedź kursorem na element inteligentny, a gdy pojawi się prośba, autoryzuj dostęp w celu wykonania dodatku. Karta podglądu zawiera informacje o książce.
Poniższa ilustracja przedstawia podgląd linku:
Sprawdź kod
Aby sprawdzić kod Apps Script tego dodatku, kliknij Wyświetl kod źródłowy poniżej:
Pokaż kod źródłowy
appsscript.json
Code.gs
Dalsze kroki
- Wyświetlanie podglądu linków za pomocą elementów inteligentnych
- Dokumentacja interfejsu API Książek Google