Level coding: Menengah
Durasi: 30 menit
Jenis project: Add-on Google Workspace
Tujuan
- Memahami fungsi add-on.
- Memahami cara membuat add-on menggunakan Apps Script, dan memahami fungsi layanan Apps Script.
- Menyiapkan lingkungan Anda.
- Siapkan skrip.
- Jalankan skrip.
Tentang Add-on Google Workspace ini
Dalam contoh ini, Anda membuat Add-on Google Workspace yang mempratinjau link dari Google Buku di dokumen Google Dokumen. Saat Anda mengetik atau menempel URL Google Buku ke dokumen, add-on akan mengenali link dan memicu pratinjau link. Untuk melihat pratinjau link, Anda dapat mengonversi link menjadi smart chip dan mengarahkan kursor ke link untuk melihat kartu yang menampilkan informasi selengkapnya tentang buku.
Add-on ini menggunakan Layanan UrlFetch dari Apps Script untuk terhubung ke Google Books API dan mendapatkan informasi tentang Google Buku untuk ditampilkan di Google Dokumen.
Cara kerjanya
Dalam file manifes Add-on Google Workspace, skrip mengonfigurasi add-on untuk memperluas Google Dokumen dan memicu pratinjau link untuk URL yang cocok dengan pola tertentu dari situs Google Buku (https://books.google.com
).
Dalam file kode, skrip terhubung ke Google Books API dan menggunakan URL
untuk mendapatkan informasi tentang buku (yang merupakan instance resource
Volume
). Skrip
menggunakan informasi ini untuk menghasilkan smart chip yang menampilkan judul
buku dan kartu pratinjau yang menampilkan ringkasan, jumlah halaman, gambar
sampul buku, dan jumlah rating.
Layanan Apps Script
Add-on ini menggunakan layanan berikut:
- UrlFetch Service–Menghubungkan ke Google Books
API untuk mendapatkan informasi tentang buku (yang merupakan instance dari
resource
Volume
API). - Card Service–Membuat antarmuka pengguna add-on.
Prasyarat
Untuk menggunakan contoh ini, Anda memerlukan prasyarat berikut:
- Akun Google (akun Google Workspace mungkin memerlukan persetujuan administrator).
Browser web dengan akses ke internet.
Project Google Cloud dengan akun penagihan terkait. Lihat Mengaktifkan penagihan untuk suatu project.
Menyiapkan lingkungan Anda
Bagian berikut menyiapkan lingkungan Anda untuk membangun add-on.
Buka project Cloud Anda di konsol Google Cloud
Jika belum dibuka, buka project Cloud yang ingin Anda gunakan untuk contoh ini:
- Di konsol Google Cloud, buka halaman Select a project.
- Pilih project Google Cloud yang ingin Anda gunakan. Atau, klik Buat project dan ikuti petunjuk di layar. Jika membuat project Google Cloud, Anda mungkin perlu mengaktifkan penagihan untuk project tersebut.
Mengaktifkan Google Books API
Add-on ini terhubung ke Google Books API. Sebelum menggunakan Google API, Anda harus mengaktifkannya di project Google Cloud. Anda dapat mengaktifkan satu atau beberapa API dalam satu project Google Cloud.
Di project Cloud Anda, aktifkan Books API.
Mengonfigurasi layar izin OAuth
Add-on ini memerlukan project Cloud dengan layar izin yang dikonfigurasi. Mengonfigurasi layar izin OAuth akan menentukan apa yang ditampilkan Google kepada pengguna dan mendaftarkan aplikasi Anda sehingga Anda dapat memublikasikannya nanti.
- Di konsol Google Cloud, buka Menu > APIs & Services > OAuth consent screen.
- Untuk Jenis pengguna, pilih Internal, lalu klik Buat.
- Lengkapi formulir pendaftaran aplikasi, lalu klik Simpan dan Lanjutkan.
Untuk saat ini, Anda dapat melewati penambahan cakupan, lalu mengklik Simpan dan Lanjutkan. Pada masa mendatang, jika Anda membuat aplikasi untuk digunakan di luar organisasi Google Workspace, Anda harus mengubah Jenis pengguna menjadi Eksternal, lalu menambahkan cakupan otorisasi yang diperlukan aplikasi Anda.
- Tinjau ringkasan pendaftaran aplikasi Anda. Untuk melakukan perubahan, klik Edit. Jika pendaftaran aplikasi sudah benar, klik Back to Dashboard.
Mendapatkan kunci API untuk Google Books API
- Buka Konsol Google Cloud. Pastikan project yang mendukung penagihan terbuka.
Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.
Klik Create credentials > API key.
Catat kunci API Anda untuk digunakan di langkah berikutnya.
Menyiapkan skrip
Bagian berikut menyiapkan skrip untuk mem-build add-on.
Membuat project Apps Script
- Klik tombol berikut untuk membuka project Apps Script Pratinjau dari Google Buku.
Membuka project - Klik Ringkasan.
- Di halaman ringkasan, klik Buat salinan.
- Pada salinan project Apps Script, buka file
Code.gs
dan gantiYOUR_API_KEY
dengan kunci API yang Anda buat di bagian sebelumnya.
Salin nomor project Cloud
- Di konsol Google Cloud, buka Menu > IAM & Admin > Settings.
- Di kolom Project number, salin nilainya.
Menetapkan project Cloud project Apps Script
- Di project Apps Script Anda, klik Project Settings.
- Pada Google Cloud Platform (GCP) Project, klik Change project.
- Di GCP project number, tempel nomor project Google Cloud.
- Klik Set project.
Menguji add-on
Bagian berikut akan menguji add-on yang Anda buat.
Menginstal deployment pengujian
- Di project Apps Script, klik Editor.
- Ganti
YOUR_API_KEY
dengan kunci API untuk Google Books API yang dibuat di bagian sebelumnya. - Klik Deploy > Test deployment.
- Klik Instal > Selesai.
Melihat pratinjau link di Google Dokumen
- Buat dokumen Google Dokumen di docs.new.
- Tempel URL berikut ke dokumen, lalu tekan tombol tab untuk
mengonversi URL menjadi smart chip:
https://www.google.com/books/edition/Software_Engineering_at_Google/V3TTDwAAQBAJ
- Arahkan kursor ke smart chip, dan saat diminta, izinkan akses untuk menjalankan add-on. Kartu pratinjau menampilkan informasi tentang buku.
Gambar berikut menampilkan pratinjau link:
Meninjau kode
Untuk meninjau kode Apps Script untuk add-on ini, klik Lihat kode sumber untuk meluaskan bagian tersebut: