Membangun aplikasi Google Chat dengan Google Apps Script

Halaman ini menjelaskan cara mem-build Add-on Google Workspace yang berfungsi di Google Chat menggunakan Google Apps Script. Di Google Chat, add-on akan muncul kepada pengguna sebagai aplikasi Google Chat. Untuk mempelajari lebih lanjut, lihat Ringkasan memperluas Google Chat.

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

Diagram berikut menunjukkan arsitektur dan pola pesan:

Arsitektur aplikasi Chat yang diterapkan dengan Apps Script.

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

  1. Pengguna mengirim pesan ke aplikasi Chat, baik dalam 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 Sheet, 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.
  • Mengonfigurasi Add-on Google Workspace untuk aplikasi Chat.
  • Uji aplikasi Chat.

Prasyarat

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.

    Memilih 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.

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

  1. Di konsol Google Cloud, buka Menu > APIs & Services > OAuth consent screen.

    Buka layar izin OAuth

  2. Untuk Jenis pengguna, pilih Internal, lalu klik Buat.
  3. Isi formulir pendaftaran aplikasi, lalu klik Simpan dan Lanjutkan.
  4. Untuk saat ini, Anda dapat melewati penambahan cakupan dan mengklik Save and Continue. Di masa mendatang, saat membuat aplikasi untuk digunakan di luar organisasi Google Workspace, Anda harus mengubah Jenis pengguna menjadi Eksternal, lalu menambahkan cakupan otorisasi yang diperlukan aplikasi Anda.

  5. Tinjau ringkasan pendaftaran aplikasi Anda. Untuk melakukan perubahan, klik Edit. Jika pendaftaran aplikasi terlihat OK, klik Kembali ke Dasbor.

Menyiapkan skrip

Untuk menyiapkan skrip, Anda membuat salinan project memulai, lalu menyiapkan project Cloud di Apps Script.

Membuat salinan project quickstart

  1. Klik tombol berikut untuk membuka project Apps Script Add-on di Google Chat.
    Membuka project
  2. Klik Ringkasan.
  3. Di halaman ringkasan, klik Ikon untuk membuat salinan Buat salinan.
  4. Beri nama salinan project Apps Script Anda:

    1. Klik Salinan aplikasi Chat Add-on.

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

    3. Klik Ganti nama.

Menyalin nomor project Cloud

  1. Di konsol Google Cloud, buka Menu > IAM & Admin > Settings.

    Buka IAM & Admin Settings

  2. Di kolom Project number, salin nilainya.

Menetapkan project Cloud project Apps Script

  1. Di project Apps Script aplikasi Chat, klik Project Settings Ikon untuk setelan project.
  2. Pada Google Cloud Platform (GCP) Project, klik Change project.
  3. Di GCP project number, tempel nomor project Google Cloud.
  4. Klik Set project.

Sekarang Anda memiliki kode aplikasi yang berfungsi yang dapat Anda coba (seperti yang dijelaskan dalam langkah-langkah berikut), lalu sesuaikan untuk memenuhi persyaratan Anda.

Pastikan Anda login ke Akun Google yang benar saat membuka project Apps Script. Akun saat ini terkadang dapat beralih ke akun default tanpa Anda sadari.

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 hal berikut:

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

Mengonfigurasi add-on

Dengan menggunakan deployment Apps Script, ikuti langkah-langkah berikut untuk membuat add-on dan men-deploy 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/chat/images/quickstart-app-avatar.png.
    3. Di kolom Description, masukkan Add-on Chat app.
    4. Di bagian Functionality, pilih Receive 1:1 messages dan Join spaces and group conversations.
    5. Di bagian Connection settings, pilih Apps Script project.
    6. Di kolom Deployment ID, tempel 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, buka ruang pesan langsung dengan aplikasi Chat dan kirim pesan:

  1. Buka Google Chat menggunakan akun Google Workspace yang Anda berikan saat menambahkan diri 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.

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

    Aplikasi Chat akan berterima kasih karena Anda telah menambahkannya dan mengulangi 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 masalah". atau "Tidak dapat memproses permintaan Anda". Terkadang UI Chat tidak menampilkan pesan error, 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 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 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.