Menghubungkan aplikasi Chat dengan layanan dan alat lainnya

Halaman ini menjelaskan cara menghubungkan aplikasi Google Chat dengan layanan atau alat yang ada di luar Google Chat. Meskipun berfungsi sendiri dengan baik, aplikasi Chat sering kali berfungsi bersama dengan sistem lain dan memerlukan aplikasi pendamping untuk menghubungkan akun, mengizinkan akses data, menampilkan data tambahan, atau mengonfigurasi preferensi pengguna.

Meminta konfigurasi aplikasi Chat dari pengguna

Jika penyelesaian permintaan memerlukan konfigurasi tambahan yang tidak dapat diselesaikan secara langsung di aplikasi Chat, tampilkan URL konfigurasi kepada pengguna sebagai bagian dari balasan normal, atau tampilkan secara pribadi, dalam bentuk berikut:

{
  "actionResponse": {
    "type": "REQUEST_CONFIG",
    "url": "CONFIGURATION_URL"
  }
}

Tindakan ini akan memberi tahu Google Chat untuk menampilkan perintah pribadi kepada pengguna, dengan CONFIGURATION_URL adalah link yang dapat dikunjungi pengguna untuk autentikasi, otorisasi, atau konfigurasi tambahan. Respons REQUEST_CONFIG bersifat sama-sama eksklusif dengan pesan respons reguler. Teks, kartu, atau atribut lainnya akan diabaikan.

Menyelesaikan permintaan konfigurasi

Setiap peristiwa interaksi MESSAGE yang diterima aplikasi Chat Anda juga menyertakan parameter configCompleteRedirectUrl. URL ini harus dienkode di URL konfigurasi untuk digunakan setelah proses selesai. Mengalihkan ke URL ini akan memberi sinyal ke Google Chat bahwa permintaan konfigurasi telah dipenuhi.

Saat aplikasi Chat Anda dimulai, alurnya bergantung pada pesan tertentu yang diterima. Sebagai respons terhadap pesan seperti @app help, aplikasi Chat harus merespons dengan pesan tanpa memerlukan konfigurasi tambahan.

Setelah pengguna berhasil dialihkan ke configCompleteRedirectUrl yang diberikan dalam pesan asli, Google Chat akan melakukan langkah-langkah berikut:

  1. Hapus perintah yang ditampilkan kepada pengguna yang memulai pra-rendering.
  2. Mengonversi pesan asli menjadi publik agar dapat dilihat oleh anggota ruang lainnya.
  3. Kirim pesan asli ke aplikasi Chat yang sama untuk kedua kalinya.

Mengunjungi configCompleteRedirectUrl hanya akan memengaruhi satu pesan pengguna. Jika pengguna telah mencoba mengirim pesan ke aplikasi Chat beberapa kali sehingga menerima beberapa perintah, mengklik prompt tertentu serta menyelesaikan proses autentikasi dan konfigurasi hanya akan memengaruhi pesan tersebut. Pesan lainnya tidak diubah.

Saat peristiwa interaksi MESSAGE dikirim ulang dengan cara ini, peristiwa tersebut harus sama dengan peristiwa asli. Namun, ada beberapa situasi saat peristiwa interaksi MESSAGE dapat berbeda. Misalnya, saat pesan menyebutkan aplikasi Chat A dan aplikasi Chat B, pengguna dapat mengedit pesan tersebut jika aplikasi Chat A merespons dengan pesan reguler sebelum melakukan autentikasi dengan aplikasi Chat B. Dalam hal ini, aplikasi Chat B menerima teks pesan yang telah diedit setelah pengguna menyelesaikan autentikasi dan konfigurasi.

Mengautentikasi pengguna Chat di luar Chat

Dalam beberapa kasus, seperti meminta otorisasi OAuth untuk API, aplikasi Anda harus ditautkan ke URL di luar Chat dengan tetap mempertahankan identitas pengguna. Cara terbaik untuk mengidentifikasi pengguna dalam kasus ini adalah dengan melindungi aplikasi tujuan dengan Login dengan Google.

Gunakan token identitas yang dikeluarkan saat login untuk mendapatkan ID pengguna. Klaim sub berisi ID unik pengguna dan dapat dikorelasikan dengan ID pengguna dari Google Chat.

Meski tidak sama persis, dua ID ini dapat dikonversi. Untuk memaksa nilai klaim sub ke users/{user} Google Chat, awali nilainya dengan users/. Misalnya, nilai klaim 123 setara dengan nama pengguna users/123 dalam pesan ke aplikasi Chat Anda.