Halaman ini menjelaskan cara mengonfigurasi dan men-deploy aplikasi Google Chat sebagai add-on Google Workspace.
Untuk men-deploy dan menguji add-on Google Workspace yang memperluas Chat, Anda harus mengaktifkan dan mengonfigurasi aplikasi Chat menggunakan Google Chat API. Setelan konfigurasi Chat API adalah tempat Anda menentukan semua detail tentang aplikasi Chat, termasuk nama, avatar, deployment, dan fitur interaktif yang ingin Anda gunakan.
Prasyarat
- Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
- Buat project Google Cloud.
- Konfigurasi layar izin OAuth.
- Aktifkan Google Chat API.
Pilih nama tampilan, avatar, dan deskripsi untuk aplikasi Chat Anda
Nama, avatar, dan deskripsi aplikasi Chat ditampilkan kepada pengguna di UI Chat. Untuk berinteraksi dengan aplikasi Chat, pengguna melihat atau menggunakan informasi ini dengan cara berikut:
- @sebut aplikasi Chat untuk menambahkannya ke ruang atau mengirim pesan ke aplikasi.
- Temukan dan mulai pesan langsung dengan aplikasi Chat. Di menu Aplikasi, pesan langsung menampilkan nama dan avatar aplikasi Chat.
- Dari kolom penulisan, pengguna dapat menjelajahi aplikasi Chat dan melihat nama, avatar, dan deskripsinya.
Sebelum mengonfigurasi aplikasi Chat, Anda harus menyiapkan informasi berikut:
Kolom | Deskripsi | Format |
---|---|---|
Nama aplikasi | Nama tampilan untuk aplikasi Chat. | Maksimal 25 karakter alfanumerik |
URL avatar | Gambar yang ditampilkan sebagai avatar aplikasi Chat Anda. | URL HTTPS yang mengarah ke gambar grafik persegi (PNG atau JPEG). Ukuran yang direkomendasikan adalah 256 x 256 piksel atau lebih. |
Deskripsi | Deskripsi singkat tujuan aplikasi Chat. | Maksimal 40 karakter alfanumerik |
Di bagian berikut, Anda akan menentukan informasi ini di setelan konfigurasi di Chat API.
Mengonfigurasi aplikasi Chat Anda di konsol Google Cloud
Di konsol Google Cloud, Anda mengonfigurasi detail tentang aplikasi Chat yang muncul kepada pengguna di Chat, termasuk nama tampilan, avatar, dan deskripsi. Detail ini hanya muncul di Chat. Untuk memublikasikan aplikasi Chat Anda ke Marketplace, Anda juga harus menentukan detail yang muncul di listingan Marketplace aplikasi Chat Anda.
Setelah Anda memiliki detail aplikasi Chat, buka project Cloud Anda dan konfigurasi Chat API:
Di konsol Google Cloud, buka halaman Chat API, lalu klik halaman Configuration:
Di bagian Info aplikasi, isi kolom Nama aplikasi, URL avatar, dan Deskripsi.
Di bagian Fitur interaktif, klik tombol Aktifkan fitur interaktif ke posisi aktif dan selesaikan langkah-langkah berikut:
Di bagian Functionality, pilih Join spaces and group conversations agar aplikasi Chat Anda tersedia untuk diinstal dan digunakan.
Secara default, Pengguna dapat menginstal dan mengirim pesan dengan aplikasi Chat di ruang khusus antara pengguna dan aplikasi Chat. Pengguna juga dapat menambahkan dan berinteraksi dengan aplikasi Chat di ruang dengan beberapa orang.
Di bagian Connection settings, pilih arsitektur yang ingin Anda gunakan untuk menerima objek peristiwa dari Chat:
- Untuk menggunakan layanan HTTP, pilih URL endpoint HTTP dan berikan URL.
- Untuk menggunakan project Google Apps Script, pilih Apps Script dan berikan ID deployment untuk project tersebut.
Opsional: Untuk menerima objek peristiwa ke lebih dari satu endpoint atau fungsi, buka Setelan koneksi > Pemicu dan berikan atau perbarui fungsi callback untuk Pemicu chat berikut:
- Ditambahkan ke ruang: Pengguna menambahkan aplikasi Chat ke percakapan grup atau ruang, atau menginstal aplikasi Chat untuk pesan 1:1.
- Pesan: Pengguna mengirim pesan ke aplikasi Chat. Misalnya, mengirim pesan langsung ke aplikasi Chat atau @menyebut aplikasi Chat di ruang dengan beberapa orang.
- Dihapus dari ruang: Pengguna meng-uninstal atau menghapus aplikasi Chat dari ruang.
- Perintah aplikasi: Pengguna menggunakan perintah cepat atau perintah garis miring dari aplikasi Chat.
Opsional: Tambahkan fitur interaktif lainnya seperti perintah cepat, perintah garis miring, atau pratinjau link.
Di bagian Visibilitas, tentukan email Anda agar Anda dapat menginstal dan menguji aplikasi Chat sebelum memublikasikannya ke Google Workspace Marketplace. Anda dapat menentukan hingga lima individu, atau satu atau beberapa Google Grup dari organisasi Google Workspace Anda.
Opsional: Di bagian Logs, centang kotak Log errors to Logging untuk menggunakan Google Cloud Logging. Untuk mengetahui informasi selengkapnya, lihat Kueri log error untuk aplikasi Chat dalam dokumentasi Chat API.
Klik Simpan.
Setelah Anda menyimpan konfigurasi, siapa pun yang Anda tentukan dalam setelan Visibilitas Chat API dapat menginstal, menguji, atau menggunakan aplikasi Chat. Untuk mulai menguji dan men-debug aplikasi Chat, lihat Menguji fitur interaktif untuk aplikasi Google Chat dalam dokumentasi Chat API.
Pertimbangan untuk add-on Google Workspace yang sudah ada
Aplikasi Chat memerlukan konfigurasi yang berbeda dibandingkan dengan add-on Google Workspace yang memperluas aplikasi Google Workspace lainnya. Jika add-on Anda memperluas aplikasi Google Workspace lainnya, pertimbangkan persyaratan berikut untuk mengonfigurasi aplikasi Chat:
- Individu dan administrator Google Workspace harus dapat menginstal add-on Anda dari Marketplace. Anda mengonfigurasi setelan penginstalan ini di Google Workspace Marketplace SDK.
- Aplikasi chat tidak menggunakan nama dan logo yang Anda konfigurasi untuk aplikasi Google Workspace lainnya dalam objek
addons.common
dari manifest. - Untuk add-on yang dipublikasikan ke Google Workspace Marketplace, Anda tidak dapat menyimpan draf perubahan apa pun pada setelan konfigurasi Google Chat API. Setelah Anda memperbarui dan menyimpan setelan konfigurasi Chat API, aplikasi Chat yang diperbarui tersedia untuk semua pengguna lama. Untuk memperbarui listingan Marketplace, Anda dapat membuat draf sebelum mengirimkan perubahan.
Jika Anda membuat add-on menggunakan Apps Script:
- Anda harus menggunakan ID deployment Apps Script yang sama dengan yang Anda gunakan untuk konfigurasi add-on lainnya.
- Anda tidak dapat menggunakan editor Apps Script untuk menginstal deployment pengujian di Chat. Sebagai gantinya, Anda harus menginstalnya langsung dari UI Chat.
Jika Anda membuat add-on menggunakan layanan HTTP, hapus detail konfigurasi aplikasi Chat apa pun dalam manifes dan deployment yang Anda buat menggunakan Google Workspace Add-ons API. Deployment HTTP yang Anda tentukan di Google Workspace Marketplace SDK hanya digunakan untuk aplikasi Google Workspace lainnya.
Topik terkait
- Untuk mengelola akses ke Chat API, lihat Mengonfigurasi Google Chat API dalam dokumentasi Google Chat API.
- Menguji fitur interaktif untuk aplikasi Google Chat