Mengonfigurasi Google Chat API

Setiap aplikasi Google Chat yang Anda buat memerlukan project Google Cloud-nya sendiri dengan Chat API yang diaktifkan dan dikonfigurasi.

Untuk melakukan panggilan API hanya baca dengan autentikasi pengguna, seperti mendapatkan ruang dan mencantumkan pesan, Anda hanya perlu mengaktifkan API dan membuat klien OAuth.

Untuk melakukan panggilan API buat, perbarui, dan hapus, atau untuk men-deploy dan menguji aplikasi Chat interaktif (yang dibuat sebagai add-on Google Workspace yang memperluas Chat), Anda juga harus mengonfigurasi Chat API. Setelan konfigurasi Chat API adalah tempat Anda menentukan semua detail tentang aplikasi Chat, termasuk nama tampilan, avatar, endpoint deployment, dan fitur interaktifnya.

Prasyarat

• Akun Google Workspace Business atau Enterprise dengan akses ke Google Chat.
• Buat project Google Cloud.
• Konfigurasi layar izin OAuth.
• Aktifkan Google Chat API.

Memilih nama tampilan, avatar, dan deskripsi untuk aplikasi Chat Anda

Saat mengaktifkan Chat API, 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 ke Marketplace, Anda juga harus menentukan detail yang muncul di listingan Marketplace aplikasi Chat Anda.

Sebelum mengonfigurasi aplikasi Chat, siapkan 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 grafis persegi (PNG atau JPEG). Ukuran yang direkomendasikan adalah 256x256 piksel atau lebih.
Deskripsi	Deskripsi singkat tentang tujuan aplikasi Chat.	Maksimal 40 karakter alfanumerik

Nama, avatar, dan deskripsi aplikasi Chat ditampilkan kepada pengguna di UI Chat. Untuk beberapa permintaan tulis Chat API, Chat menggunakan informasi ini untuk mengatribusikan tindakan yang dilakukan aplikasi Chat di Chat.

Misalnya, jika Anda memanggil metode spaces.create(), Chat akan menyertakan nama aplikasi Chat dalam deskripsi pembuat ruang, seperti yang ditunjukkan dalam gambar berikut:

Gambar 1. Pesan atribusi yang ditampilkan Chat saat metode spaces.create() digunakan untuk membuat ruang atas nama pengguna.

Untuk berinteraksi dengan aplikasi Chat, pengguna juga melihat atau menggunakan informasi ini dengan cara berikut:

• @sebut aplikasi Chat untuk menambahkannya ke ruang atau mengirim pesan ke aplikasi tersebut.
• Temukan dan mulai pesan langsung dengan aplikasi Chat. Di menu Aplikasi, pesan langsung menampilkan nama dan avatar aplikasi Chat.
• Dari kolom tulis, pengguna dapat menjelajahi aplikasi Chat dan melihat nama, avatar, dan deskripsinya.

Mengonfigurasi aplikasi Chat di Konsol Google Cloud

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

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

   Buka halaman Chat API Configuration

2. Di bagian Application info, isi kolom App name, Avatar URL, dan Description.

3. Opsional: Dari menu Sintaksis markup, pilih sintaksis markup default (Markdown atau Chat) untuk pesan aplikasi Chat Anda. Untuk mempelajari lebih lanjut pemformatan teks dan cara Chat menentukan sintaksis markup untuk permintaan API, lihat Memformat pesan.

4. Di bagian Fitur interaktif, konfigurasikan apakah aplikasi Chat Anda merespons interaksi pengguna:

   Catatan: Jika aplikasi Chat Anda hanya memanggil Chat API dan tidak menerima atau merespons interaksi pengguna, biarkan Enable interactive features dinonaktifkan dan lanjutkan ke langkah berikutnya.

   Untuk membangun aplikasi Chat interaktif, aktifkan Enable interactive features dan selesaikan langkah-langkah berikut:

   1. Di bagian Functionality:
      • Opsional: Pilih Support App Home untuk menampilkan kartu halaman beranda di tab Home pesan langsung personal dengan aplikasi Chat.
      • Pilih Join spaces and group conversations agar aplikasi Chat Anda dapat 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.

   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.
      • Untuk menggunakan agen Dialogflow, pilih Dialogflow, pilih Dialogflow CX atau Dialogflow ES, dan berikan nama resource agen.
      • Untuk menggunakan Pub/Sub, pilih Cloud Pub/Sub dan masukkan nama topik.
      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 Anda dan dapat memengaruhi listingan Anda di Google Workspace Marketplace. Untuk meninjau konfigurasi add-on, lihat Mengonfigurasi aplikasi Anda di Google Workspace Marketplace SDK.

   3. Opsional: Untuk merutekan objek peristiwa ke endpoint atau fungsi tertentu, buka Connection settings > Triggers, lalu berikan atau perbarui endpoint atau fungsi callback untuk pemicu Chat berikut:

      Catatan: Untuk Apps Script, jika Anda tidak memperbarui pemicu, Anda harus menerapkan fungsi callback default yang diisi di bagian ini (seperti onMessage, onAddedToSpace, onRemovedFromSpace, onAppCommand, dan onAppHome).
      • Beranda aplikasi (jika Dukung Beranda Aplikasi diaktifkan): Pengguna membuka tab Beranda di pesan langsung personal dengan aplikasi Chat.
      • 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, pengguna 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 memanggil perintah cepat, perintah garis miring, atau tindakan pesan dari aplikasi Chat.

   4. Opsional: Tambahkan fitur interaktif lainnya seperti perintah pemicu, perintah (perintah cepat, perintah garis miring, dan tindakan pesan), atau pratinjau link.

   5. Di bagian Visibility, tentukan alamat 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.

5. Opsional: Di bagian Logs, centang kotak Log errors to Logging untuk menggunakan Google Cloud Logging. Untuk mengetahui informasi selengkapnya, lihat Membuat kueri log error untuk aplikasi Chat.

6. Klik Simpan.

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

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 pengguna perorangan 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 konfigurasi untuk aplikasi Google Workspace lainnya di objek addons.common 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 langsung tersedia untuk semua pengguna yang ada. Untuk memperbarui listingan Marketplace, Anda dapat membuat draf sebelum mengirimkan perubahan apa pun.
• 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, hilangkan detail konfigurasi aplikasi Chat 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.

Memberikan izin kepada orang lain untuk mengonfigurasi Chat API

Anda dapat memberi pengguna tertentu akses ke halaman konfigurasi aplikasi Chat dengan memberi mereka peran Google Cloud Identity Access Management (IAM) Pemilik aplikasi Chat atau Pelihat aplikasi Chat. Pengguna dengan peran ini tidak dapat membuka halaman konfigurasi aplikasi Chat menggunakan dasbor APIs & Services, tetapi dapat mengakses halaman konfigurasi dengan membuka Konsol Google Cloud untuk project Cloud host aplikasi Chat sebagai berikut:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

Dengan PROJECT_ID sebagai project ID dari project Google Cloud yang menghosting aplikasi Chat.

Pengguna dengan peran Project juga dapat mengakses halaman konfigurasi aplikasi.

Pengguna dengan peran khusus yang berisi izin resourcemanager.projects.(get|update) tidak dapat mengakses konfigurasi aplikasi Chat. Untuk peran khusus, gunakan izin chat.bots.(get|update).

Topik terkait

• Memilih arsitektur aplikasi Chat
• Menerima dan merespons interaksi pengguna
• Menguji fitur interaktif untuk aplikasi Google Chat

Aplikasi Chat yang bukan add-on: Mengonfigurasi Google Chat API

Jika Anda mengelola aplikasi Chat yang bukan add-on Google Workspace, konfigurasi Anda akan menggunakan satu endpoint untuk semua peristiwa interaksi, bukan pemicu per peristiwa:

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

   Buka halaman Konfigurasi Chat API

2. Di bagian Interactive features, aktifkan Enable interactive features.

3. Buat aplikasi Chat ini sebagai add-on Google Workspace. Dialog akan terbuka dan meminta Anda untuk mengonfirmasi. Pada dialog, klik Nonaktifkan.

4. Di bagian Functionality, pilih Support App Home atau Join spaces and group conversations sesuai kebutuhan.

5. Di bagian Connection settings, tentukan satu endpoint untuk aplikasi Chat Anda (HTTP endpoint URL, ID deployment Apps Script, Cloud Pub/Sub topic name, atau Dialogflow).

6. Konfigurasikan Commands, Link previews, Visibility, dan Logs opsional, lalu klik Save.

Untuk mengupgrade aplikasi Chat yang bukan add-on ke add-on Google Workspace yang memperluas Google Chat, lihat Mengonversi aplikasi Google Chat menjadi add-on Google Workspace.