Membangun aplikasi Google Chat dengan Google Apps Script

Halaman ini menjelaskan cara membuat add-on Google Workspace yang berfungsi di Google Chat menggunakan Google Apps Script.

Catatan: Di Google Chat, add-on muncul kepada pengguna sebagai aplikasi Google Chat. Anda juga dapat membuat aplikasi Chat menggunakan peristiwa interaksi Google Chat API. Untuk mempelajari lebih lanjut, lihat Ringkasan cara memperluas Google Chat.

Aplikasi Chat memungkinkan Anda mengirim pesan langsung dan merespons dengan mengulangi pesan Anda.

Diagram berikut menunjukkan arsitektur dan pola pengiriman pesan:

Dalam diagram sebelumnya, pengguna yang berinteraksi dengan aplikasi Chat Apps Script memiliki alur informasi berikut:

1. Pengguna mengirim pesan ke aplikasi Chat, baik di pesan langsung maupun di ruang Chat.
2. Logika aplikasi Chat yang diterapkan di Apps Script, yang berada di Google Cloud, menerima dan memproses pesan.
3. Secara opsional, logika aplikasi Chat dapat terintegrasi dengan layanan Google Workspace, seperti Kalender atau Spreadsheet, atau Layanan Google lainnya, seperti Google Maps atau YouTube.
4. Logika aplikasi Chat mengirim respons kembali ke layanan aplikasi Chat di Chat.
5. Respons dikirimkan kepada pengguna.

Tujuan

• Siapkan lingkungan Anda.
• Siapkan skrip.
• Konfigurasi aplikasi Chat.
• Uji aplikasi Chat.

Prasyarat

• Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
• Project Google Cloud. Untuk membuatnya, lihat Membuat project Google Cloud.

Menyiapkan lingkungan Anda

Buka project Cloud Anda di konsol Google Cloud

Jika belum terbuka, buka project Cloud yang ingin Anda gunakan untuk contoh ini:

1. Di konsol Google Cloud, buka halaman Select a project.

   Pilih project Cloud

2. 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 Chat 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 Konsol Google Cloud, aktifkan Google Chat API.

Mengaktifkan API

Mengonfigurasi layar izin OAuth

Semua aplikasi yang menggunakan OAuth 2.0 memerlukan konfigurasi layar izin. Mengonfigurasi layar izin OAuth aplikasi Anda menentukan apa yang ditampilkan kepada pengguna dan peninjau aplikasi, serta mendaftarkan aplikasi Anda sehingga Anda dapat memublikasikannya nanti.

1. Di Konsol Google Cloud, buka Menu > Google Auth platform > Branding.

   Buka Branding

2. Jika sudah mengonfigurasi Google Auth platform, Anda dapat mengonfigurasi setelan Layar Izin OAuth berikut di Branding, Audiens, dan Akses Data. Jika Anda melihat pesan yang bertuliskan Google Auth platform belum dikonfigurasi, klik Mulai:
1. Di bagian Informasi Aplikasi, di Nama aplikasi, masukkan nama untuk aplikasi.
2. Di bagian Email dukungan pengguna, pilih alamat email dukungan yang dapat dihubungi pengguna jika mereka memiliki pertanyaan tentang izin mereka.
3. Klik Berikutnya.
4. Di bagian Audiens, pilih Internal.
5. Klik Berikutnya.
6. Di bagian Informasi Kontak, masukkan Alamat email tempat Anda dapat menerima notifikasi tentang perubahan apa pun pada project Anda.
7. Klik Berikutnya.
8. Di bagian Selesai, tinjau Kebijakan Data Pengguna Layanan Google API dan jika Anda setuju, pilih Saya menyetujui Layanan Google API: Kebijakan Data Pengguna.
9. Klik Lanjutkan.
10. Klik Buat.
3. Untuk saat ini, Anda dapat melewati penambahan cakupan. Pada masa mendatang, saat membuat aplikasi untuk digunakan di luar organisasi Google Workspace Anda, Anda harus mengubah Jenis pengguna menjadi Eksternal. Kemudian tambahkan cakupan otorisasi yang diperlukan aplikasi Anda. Untuk mempelajari lebih lanjut, lihat panduan lengkap Mengonfigurasi izin OAuth.

Menyiapkan skrip

Untuk menyiapkan skrip, Anda menggunakan template aplikasi Chat dari halaman Mulai Apps Script.

Buat project Apps Script

1. Dari halaman Mulai Apps Script, buka Google Workspace add-on starters, lalu klik template Chat app:

   Buka template aplikasi Chat

2. Di project Apps Script baru yang terbuka, beri nama project:

   1. Klik Project tanpa judul.

   2. Di Project title, ketik Add-on Chat app.

   3. Klik Ganti nama.

Pada masa mendatang, jika ingin menggunakan API Google tertentu atau memublikasikan aplikasi, Anda harus mengaitkan project Cloud dengan project Apps Script. Untuk panduan ini, Anda tidak perlu melakukannya. Untuk mempelajari lebih lanjut, lihat panduan project Google Cloud.

Membuat deployment pengujian

Anda memerlukan ID deployment untuk project Apps Script ini, sehingga Anda dapat menggunakannya pada langkah berikutnya.

Untuk mendapatkan ID deployment head, lakukan hal berikut:

1. Di project Apps Script aplikasi Chat, klik Deploy > Test deployments.
2. Salin ID deployment head untuk digunakan di langkah berikutnya, lalu klik Selesai.

Mengonfigurasi aplikasi Chat

Lakukan langkah-langkah berikut untuk mengonfigurasi aplikasi Google Chat:

1. Di konsol, cari Google Chat API, lalu klik Google Chat API.
2. Klik Manage.

3. Klik Konfigurasi dan siapkan aplikasi Chat:

   1. Di kolom Nama aplikasi, masukkan Add-on Chat app.
   2. Di kolom Avatar URL, masukkan https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png.
   3. Di kolom Description, masukkan Add-on Chat app.
   4. Di bagian Functionality, pilih Join spaces and group conversations.
   5. Di bagian Connection settings, pilih Apps Script project.
   6. Di kolom Deployment ID, tempelkan ID deployment Head yang sebelumnya Anda salin.
   7. Di bagian Visibilitas, pilih Orang dan grup tertentu di domain Anda, lalu masukkan email Anda.

4. Klik Simpan.

Aplikasi Chat siap merespons pesan.

Menguji aplikasi Chat

Untuk menguji aplikasi Chat Anda, buka ruang pesan langsung dengan aplikasi Chat dan kirim pesan:

1. Buka Google Chat menggunakan akun Google Workspace yang Anda berikan saat menambahkan diri Anda sebagai penguji tepercaya.

   Buka Google Chat

2. Klik Chat baru.
3. Di kolom Tambahkan 1 orang atau lebih, ketik nama aplikasi Chat Anda.

4. Pilih aplikasi Chat Anda dari hasil. Pesan langsung akan terbuka.

   Catatan: Jika Anda tidak melihat aplikasi Chat di daftar hasil, pastikan Anda telah menyertakan akun Google Workspace di setelan Visibilitas pada halaman Konfigurasi Chat API di konsol Google Cloud.

5. Di pesan langsung baru dengan aplikasi, ketik Hello, lalu tekan enter.

   Aplikasi Chat berterima kasih kepada Anda karena telah menambahkannya dan mengulangi pesan Anda.

Untuk menambahkan penguji tepercaya dan mempelajari lebih lanjut pengujian fitur interaktif, lihat Menguji fitur interaktif untuk aplikasi Google Chat.

Memecahkan masalah

Saat aplikasi atau kartu Google Chat menampilkan error, antarmuka Chat akan menampilkan pesan yang mengatakan "Terjadi masalah". atau "Tidak dapat memproses permintaan Anda". Terkadang UI Chat tidak menampilkan pesan error apa pun, tetapi aplikasi atau kartu Chat menghasilkan hasil yang tidak terduga; misalnya, pesan kartu mungkin tidak muncul.

Meskipun pesan error mungkin tidak ditampilkan di UI Chat, pesan error deskriptif dan data log tersedia untuk membantu Anda memperbaiki error jika logging error untuk aplikasi Chat diaktifkan. Untuk mendapatkan bantuan dalam melihat, men-debug, dan memperbaiki error, lihat Memecahkan masalah dan memperbaiki error Google Chat.

Pembersihan

Agar tidak menimbulkan biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam tutorial ini, sebaiknya hapus project Cloud tersebut.

Perhatian: Menghapus project akan mengakibatkan:

• Semua hal dalam project akan dihapus. Jika menggunakan project yang sudah ada untuk tutorial ini, saat menghapusnya, Anda juga akan menghapus pekerjaan lain yang telah dilakukan dalam project tersebut.
• Project ID kustom akan hilang. Saat membuat project ini, Anda mungkin telah membuat project ID kustom yang masih ingin Anda gunakan pada masa mendatang. Untuk mempertahankan URL yang menggunakan project ID tersebut, seperti URL di appspot.com, hapus resource yang dipilih di dalam project, alih-alih menghapus seluruh project.

Jika Anda berencana mempelajari beberapa tutorial dan panduan memulai, menggunakan kembali project dapat membantu Anda agar tidak melampaui batas kuota project.

1. Di Konsol Google Cloud, buka halaman Manage resources. Klik Menu > IAM & Admin > Kelola Resource.

   Buka Resource Manager

2. Dalam daftar project, pilih project yang ingin Anda hapus, lalu klik Hapus .
3. Pada dialog, ketik project ID, lalu klik Shut down untuk menghapus project.