Mengonfigurasi aplikasi Google Chat

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.

Catatan: Halaman ini menjelaskan cara mengonfigurasi aplikasi Chat menggunakan Apps Script atau layanan HTTP. Dialogflow dan Pub/Sub tidak tersedia. Untuk mengetahui detailnya, lihat Batasan dan masalah umum.

Prasyarat

HTTP

• Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
• Buat project Google Cloud.
• Konfigurasikan layar izin OAuth.
• Aktifkan Google Workspace API berikut:
  • Google Chat API
  • API add-on Google Workspace
    Anda tidak dapat menggunakan API add-on Google Workspace untuk membuat dan mengelola deployment aplikasi Chat. Untuk mengetahui detailnya, lihat Batasan dan masalah umum.
• Endpoint HTTP yang menghosting arsitektur layanan untuk aplikasi Chat Anda.

Apps Script

• Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
• Buat project Google Cloud.
• Konfigurasikan layar izin OAuth.
• Aktifkan Google Chat API.
• Buat project Apps Script mandiri, dan aktifkan Layanan Chat Lanjutan.
• Konfigurasikan Chat dalam manifes, dengan menambahkan objek addons.chat dan cakupan yang diperlukan (oauthScopes) atau awalan URL HTTPS (urlFetchWhitelist).

Memilih nama tampilan, avatar, dan deskripsi untuk aplikasi Chat

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:

• @sebutkan 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 panel tulis, pengguna dapat menjelajahi aplikasi Chat dan melihat nama, avatar, dan deskripsi mereka.

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 256x256 piksel atau lebih.
Deskripsi	Deskripsi singkat tentang tujuan aplikasi Chat.	Maksimal 40 karakter alfanumerik

Di bagian berikut, Anda akan menentukan informasi ini di setelan konfigurasi di Chat API.

Mengonfigurasi aplikasi Chat di konsol Google Cloud

Setelah memiliki detail aplikasi Chat, buka project Cloud dan konfigurasikan Chat API:

1. Di konsol Google Cloud, buka halaman Chat API, lalu klik halaman Configuration:

   Buka halaman Konfigurasi Chat API

2. Di bagian Info aplikasi, isi kolom Nama aplikasi, URL Avatar, dan Deskripsi.

3. Di bagian Fitur interaktif, klik Aktifkan fitur interaktif ke posisi aktif dan selesaikan hal berikut:

   1. Di bagian Functionality, centang satu atau beberapa kotak untuk membuat aplikasi Chat tersedia untuk diinstal dan digunakan:

      • Menerima pesan 1:1: Pengguna dapat menginstal dan mengirim pesan dengan aplikasi Chat di ruang khusus antara pengguna dan aplikasi Chat.

      • Bergabung ke ruang dan percakapan grup: Pengguna dapat menambahkan dan berinteraksi dengan aplikasi Chat di ruang dengan beberapa orang.

   2. Di bagian Connection settings, pilih arsitektur yang ingin Anda gunakan untuk menerima objek peristiwa dari Chat:

      • Untuk menggunakan layanan HTTP, pilih HTTP endpoint URL dan berikan URL.
      • Untuk menggunakan project Google Apps Script, pilih Apps Script dan berikan ID deployment untuk project tersebut.
      Peringatan: Jika ID deployment Apps Script sudah diisi, project Cloud akan terhubung ke add-on Google Workspace yang ada. Jika Anda memperbarui ID deployment di Chat API, ID deployment akan diperbarui untuk add-on dan dapat memengaruhi listingan Anda di Google Workspace Marketplace. Untuk meninjau konfigurasi add-on, lihat Mengonfigurasi aplikasi Anda di Google Workspace Marketplace SDK dalam dokumentasi Google Workspace Marketplace.

   3. Opsional: Untuk menerima objek peristiwa ke lebih dari satu endpoint atau fungsi, buka Setelan lanjutan > Pemicu dan berikan atau perbarui fungsi callback untuk Pemicu chat berikut:

      Catatan: Untuk Apps Script, jika tidak memperbarui pemicu, Anda harus menggunakan fungsi callback yang sesuai yang diisi di bagian ini (seperti onMessage, onAddedToSpace, dan onRemovedFromSpace).
      • ADDED_TO_SPACE: Pengguna menambahkan aplikasi Chat ke percakapan grup atau ruang, atau menginstal aplikasi Chat untuk pesan 1:1.
      • MESSAGE: Pengguna mengirim pesan ke aplikasi Chat. Misalnya, mengirim pesan langsung ke aplikasi Chat atau @menyebutkan aplikasi Chat di ruang dengan beberapa orang.
      • REMOVED_FROM_SPACE: Pengguna meng-uninstal atau menghapus aplikasi Chat dari ruang.

   4. Opsional: Tambahkan fitur interaktif lainnya seperti perintah garis miring atau pratinjau link.

   5. Di bagian Visibilitas, tentukan email Anda agar dapat menginstal dan menguji aplikasi Chat sebelum memublikasikan ke Google Workspace Marketplace. Anda dapat menentukan maksimal lima individu, atau satu atau beberapa Google Grup dari organisasi Google Workspace Anda.

4. Opsional: Di bagian Logs, centang kotak Log errors to Logging untuk menggunakan Google Cloud Logging. Untuk informasi selengkapnya, lihat Log error kueri untuk aplikasi Chat dalam dokumentasi Chat API.

5. Klik Simpan.

Setelah Anda menyimpan konfigurasi, siapa pun yang Anda tentukan di 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:

• Baik individu maupun 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 konfigurasikan untuk aplikasi Google Workspace lainnya di objek addons.common dari manifes.
• 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 akan tersedia untuk semua pengguna yang ada. Untuk memperbarui listingan Marketplace, Anda dapat membuat draf sebelum mengirimkan perubahan apa pun.

• Jika Anda mem-build 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 penyebaran pengujian di Chat. Sebagai gantinya, Anda harus menginstalnya langsung dari UI Chat.

• Jika Anda mem-build add-on menggunakan layanan HTTP, hapus detail konfigurasi aplikasi Chat dalam manifes dan deployment yang Anda buat menggunakan API add-on Google Workspace. 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
• Memublikasikan aplikasi Google Chat