Halaman ini menjelaskan cara aplikasi Google Chat dapat mengidentifikasi atau menentukan pengguna Chat.
Untuk melakukan salah satu hal berikut, aplikasi Chat harus menentukan pengguna:
- Buat pesan yang @ menyebutkan pengguna.
- Undang atau tambahkan pengguna ke ruang yang ada, atau tambahkan pengguna ke ruang baru.
- Menemukan pesan langsung antara aplikasi Chat dan pengguna tertentu, atau antara dua pengguna.
- Mendapatkan detail keanggotaan pengguna di ruang.
- Mengirim pesan pribadi kepada pengguna.
- Berlangganan pengguna menggunakan Google Workspace Events API untuk mendapatkan peristiwa tentang perubahan langganan mereka.
Cara Chat mengidentifikasi pengguna
Google Chat API menghasilkan
resource User
untuk setiap orang yang menggunakan Chat. Berikut adalah dua kolom
User
yang penting:
name
adalah nama resource untuk resource, yang diformat sebagaiusers/{user}
, dengan{user}
mewakili ID unik dan stabil.users/app
dapat digunakan sebagai alias untuk aplikasi Chat yang melakukan panggilan.type
adalah jenis pengguna. Jenis ini memberi tahu Chat apakah pengguna adalah aplikasi Chat atau orang. Untuk aplikasi Chat, nilainya adalahBOT
. Untuk 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
dari resourceUser
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 denganpeople/123456789
di People API.id
untuk resourceUser
di Directory API—misalnya,users/123456789
di Chat API mewakili orang yang sama denganusers/123456789
di Directory API.
Untuk pengguna di organisasi Google Workspace eksternal, atau pengguna yang menggunakan Akun Google, gunakan alias email—misalnya,
users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com
atauusers/EMAIL_USERNAME@gmail.com
.
Mengidentifikasi pengguna dari peristiwa interaksi
Setiap kali pengguna berinteraksi dengan aplikasi Chat, Chat akan mengirimkan peristiwa interaksi dengan informasi tentang interaksi dan pengguna. Misalnya, saat pengguna menyebutkan aplikasi Chat dalam pesan, aplikasi Chat akan menerima informasi tentang interaksi tersebut, termasuk isi pesan dan siapa yang mengirimnya. Aplikasi Chat mereferensikan pengguna saat mengambil informasi tentang resource Chat.
Untuk mengidentifikasi pengguna yang berinteraksi dengan aplikasi Chat,
dapatkan nilai properti name
di
resource User
,
yang dapat Anda dapatkan dari
Event.user.name
.
Contoh JSON berikut menunjukkan format identitas pengguna yang diharapkan dalam interaksi dengan aplikasi Chat:
{
...,
"user": {
"name": "users/12345678901234567890",
"displayName": "Sasha",
"avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
"email": "sasha@example.com"
}
}
Pesan adalah jenis interaksi tertentu. Untuk mengidentifikasi pengguna yang mengirim
pesan ke aplikasi Chat,
dapatkan nilai properti name
di
resource User
, menggunakan salah satu
hal berikut: