Membangun aplikasi Google Chat dengan Google Apps Script

Halaman ini menjelaskan cara membuat aplikasi Google Chat menggunakan Google Apps Script. Aplikasi Chat memungkinkan Anda mengirim pesan langsung dan merespons dengan menggemakan pesan Anda.

Diagram berikut menunjukkan arsitektur dan pola pesan:

Arsitektur aplikasi Chat yang diimplementasikan dengan Apps Script.

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 diintegrasikan dengan layanan Google Workspace, seperti Kalender atau Spreadsheet, atau layanan Google lainnya, seperti Google Maps atau YouTube.
  4. Logika aplikasi Chat mengirimkan respons kembali ke layanan aplikasi Chat di Chat.
  5. Respons dikirimkan kepada pengguna.

Tujuan

  • Menyiapkan lingkungan Anda.
  • Siapkan skrip.
  • Mengonfigurasi aplikasi Chat.
  • Menguji aplikasi Chat.

Prasyarat

Menyiapkan lingkungan Anda

Membuka project Cloud 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.

    Memilih project Cloud

  2. Pilih project Google Cloud yang ingin Anda gunakan. Atau, klik Create project dan ikuti petunjuk di layar. Jika Anda 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.

Mengonfigurasi layar izin OAuth

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

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

    Buka Branding

  2. Jika sudah mengonfigurasi platform Google Auth, Anda dapat mengonfigurasi setelan Layar Izin OAuth berikut di Branding, Audiens, dan Akses Data. Jika Anda melihat pesan yang menyatakan Google Auth platform not configured yet, klik Get Started:
    1. Di bagian App Information, di App name, masukkan nama untuk aplikasi.
    2. Di Email dukungan pengguna, pilih alamat email dukungan yang dapat dihubungi pengguna jika mereka memiliki pertanyaan tentang izin mereka.
    3. Klik Berikutnya.
    4. Di bagian Audience, 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 Finish, tinjau Kebijakan Data Pengguna Layanan Google API dan jika Anda setuju, pilih I agree to the Google API Services: User Data Policy.
    9. Klik Lanjutkan.
    10. Klik Buat.
  3. Untuk saat ini, Anda dapat melewati penambahan cakupan. Pada masa mendatang, saat Anda membuat aplikasi untuk digunakan di luar organisasi Google Workspace, Anda harus mengubah User type menjadi External. Kemudian, tambahkan cakupan otorisasi yang diperlukan aplikasi Anda. Untuk mempelajari lebih lanjut, lihat panduan Mengonfigurasi izin OAuth selengkapnya.

Menyiapkan skrip

Untuk menyiapkan skrip, gunakan template aplikasi Chat dari halaman Getting Started Apps Script.

Membuat project Apps Script

  1. Dari halaman Getting Started Apps Script, buka Google Workspace add-on starters, lalu klik template aplikasi Chat:

    Buka template aplikasi Chat

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

    1. Klik Project tanpa judul.

    2. Di Project title, ketik Quickstart app.

    3. Klik Ganti nama.

Pada masa mendatang, jika Anda ingin menggunakan Google API 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 di langkah berikutnya.

Untuk mendapatkan ID deployment head, lakukan tindakan 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 API, telusuri Google Chat API, lalu klik Google Chat API.
  2. Klik Manage.
  3. Klik Configuration dan siapkan aplikasi Chat:

    1. Di kolom App name, masukkan Quickstart app.
    2. Di kolom Avatar URL, masukkan https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
    3. Di kolom Description, masukkan Quickstart 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 Visibility, pilih Specific people and groups in your domain, dan masukkan email Anda.
  4. Klik Simpan.

Aplikasi Chat siap merespons pesan.

Menguji aplikasi Chat

Untuk menguji aplikasi Chat, 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 New chat.
  3. Di kolom Tambahkan 1 orang atau lebih, ketik nama aplikasi Chat Anda.
  4. Pilih aplikasi Chat Anda dari hasil. Pesan langsung akan terbuka.

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

    Aplikasi Chat akan berterima kasih karena Anda telah menambahkannya dan menggemakan pesan Anda.

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

Memecahkan masalah

Saat aplikasi Google Chat atau kartu menampilkan error, antarmuka Chat akan menampilkan pesan yang bertuliskan "Terjadi error". atau "Tidak dapat memproses permintaan Anda". Terkadang UI Chat tidak menampilkan pesan error apa pun, tetapi aplikasi atau kartu Chat memberikan 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 saat 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.

  1. Di Konsol API Google, buka halaman Manage resources. Klik Menu > IAM & Admin > Manage Resources.

    Buka Resource Manager

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

Langkah berikutnya

  • Membuat kartu interaktif–Pesan kartu mendukung tata letak yang ditentukan, elemen UI interaktif seperti tombol, dan multimedia seperti gambar. Gunakan pesan kartu untuk menyajikan informasi mendetail, mengumpulkan informasi dari pengguna, dan memandu pengguna untuk mengambil langkah berikutnya.
  • Merespons perintah–Perintah membantu pengguna menemukan dan menggunakan fitur utama aplikasi Chat Anda.
  • Meluncurkan dialog–Dialog adalah antarmuka berbasis kartu dalam jendela yang dapat dibuka aplikasi Anda untuk berinteraksi dengan pengguna. Beberapa kartu dapat digabungkan secara berurutan, yang membantu pengguna menyelesaikan proses multi-langkah, seperti mengisi data formulir.
  • Codelab: Siap membuat aplikasi Chat yang lebih canggih? Lihat aplikasi Chat masukan dari codelab Membangun aplikasi untuk Google Chat dengan Gemini.

Aplikasi Chat yang bukan add-on: Membangun aplikasi Google Chat dengan Google Apps Script

Untuk membangun aplikasi Chat yang bukan add-on Google Workspace dengan Apps Script, ikuti langkah-langkah berikut untuk membuat skrip dari template dan mengonfigurasi aplikasi Chat yang bukan add-on.

Membuat skrip dari template

  1. Buka template aplikasi Chat
  2. Klik Untitled project, ketik Quickstart app, dan klik Rename.

    Pada masa mendatang, jika Anda ingin menggunakan Google API 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.

  3. Di project Apps Script aplikasi Chat, klik Deploy > Test deployments.

  4. Salin Head deployment ID untuk digunakan di langkah berikutnya, lalu klik Done.

Mengonfigurasi aplikasi Chat yang bukan add-on

Konfigurasi aplikasi Chat yang bukan add-on dari Konsol API:

  1. Di Konsol API, telusuri Google Chat API, lalu klik Google Chat API.
  2. Klik Manage.
  3. Klik Konfigurasi dan siapkan aplikasi Chat yang bukan add-on:

    1. Buat aplikasi Chat ini sebagai add-on Google Workspace. Dialog akan terbuka dan meminta Anda untuk mengonfirmasi. Pada dialog, klik Nonaktifkan.
    2. Di kolom App name, masukkan Quickstart app.
    3. Di kolom Avatar URL, masukkan https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
    4. Di kolom Description, masukkan Quickstart app.
    5. Di bagian Functionality, pilih Join spaces and group conversations.
    6. Di bagian Connection settings, pilih Apps Script.
    7. Di kolom Deployment ID, tempelkan ID deployment Head yang sebelumnya Anda salin.
    8. Di bagian Visibility, pilih Specific people and groups in your domain, dan masukkan email Anda.
  4. Klik Simpan.