Halaman ini menjelaskan cara aplikasi Google Chat dapat mengidentifikasi atau menentukan Pengguna Chat.
Untuk melakukan salah satu dari hal berikut, aplikasi Chat harus menentukan pengguna:
- Buat pesan yang @ menyebut pengguna.
- Undang atau tambahkan pengguna ke ruang yang ada, atau menambahkan pengguna ke ruang baru.
- Menemukan pesan langsung antara aplikasi Chat dan pengguna tertentu, atau di antara dua pengguna.
- Mendapatkan detail keanggotaan pengguna di ruang.
- Kirim pesan pribadi kepada pengguna.
- Berlangganan ke pengguna menggunakan Google Workspace Events API untuk mendapatkan peristiwa terkait perubahan langganan mereka.
Cara Chat mengidentifikasi pengguna
Google Chat API membuat
Referensi User
setiap orang yang menggunakan Chat. Berikut ini adalah dua hal penting
Kolom User
:
name
adalah nama resource untuk resource, yang diformat sebagaiusers/{user}
, dengan{user}
mewakili ID yang unik dan stabil.users/app
dapat digunakan sebagai alias untuk aplikasi Chat pemanggil.type
adalah jenis pengguna. Jenis ini akan memberi tahu Chat apakah pengguna adalah orang atau aplikasi Chat. Sebagai Aplikasi Chat, nilainya adalahBOT
. Bagi orang, nilainya adalahHUMAN
.
Menentukan pengguna dalam panggilan ke Google Chat API
Untuk menentukan pengguna, gunakan nilai berikut untuk nilai {user}
:
Untuk pengguna di organisasi Google Workspace Anda, gunakan salah satu pendekatan berikut:
name
dariUser
referensi di Chat API, sepertiusers/123456789
.{person_id}
untuk nama ResourcePerson
di People API, denganresourceName
adalahpeople/{person_id}
—misalnya,users/123456789
di Chat API mewakili orang yang sama sebagaipeople/123456789
di People API.id
untuk resourceUser
di Directory API—misalnya,users/123456789
di Chat API mewakili orang yang sama sebagaiusers/123456789
di Directory API.
Untuk pengguna di organisasi Google Workspace eksternal, atau pengguna yang menggunakan Akun Google, menggunakan alias email—misalnya,
users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com
atauusers/EMAIL_USERNAME@gmail.com
.
Mengidentifikasi pengguna dari suatu peristiwa interaksi
Setiap kali pengguna berinteraksi dengan aplikasi Chat, Chat mengirimkan peristiwa interaksi dengan informasi tentang interaksi dengan pengguna. Misalnya, ketika seorang pengguna menyebutkan aplikasi Chat dalam pesan, Aplikasi Chat menerima informasi tentang interaksi, termasuk apa isi pesannya, dan siapa yang mengirimnya. Aplikasi Chat merujuk pengguna saat mengambil informasi tentang resource Chat.
Untuk mengidentifikasi pengguna yang berinteraksi dengan aplikasi Chat,
dapatkan nilai properti name
pada
User
referensi,
yang bisa Anda dapatkan dari
Event.user.name
.
Contoh JSON berikut menunjukkan format yang diharapkan dari identitas pengguna dalam dengan aplikasi Chat:
{
...,
"user": {
"name": "users/12345678901234567890",
"displayName": "Sasha",
"avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
"email": "sasha@example.com"
}
}
Pesan merupakan jenis interaksi tertentu. Untuk mengidentifikasi pengguna yang mengirim
pesan ke aplikasi Chat,
dapatkan nilai properti name
pada
User
resource, menggunakan salah satu
berikut ini: