Mengidentifikasi dan menentukan pengguna Google Chat

Halaman ini menjelaskan cara aplikasi Google Chat dapat mengidentifikasi atau menentukan pengguna Chat.

Untuk melakukan salah satu hal berikut, aplikasi Chat harus menentukan pengguna:

Cara Chat mengidentifikasi pengguna

Google Chat API menghasilkan resource User untuk setiap orang yang menggunakan Chat. Berikut adalah dua kolom User penting:

  • name adalah nama resource untuk resource, yang diformat sebagai users/{user}, dengan {user} mewakili ID yang 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 pengguna atau aplikasi Chat. Untuk aplikasi Chat, nilainya adalah BOT. Untuk orang, nilainya adalah HUMAN.

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 resource User di Chat API, seperti users/123456789.
    • {person_id} untuk nama resource Person di People API, dengan resourceName adalah people/{person_id}—misalnya, users/123456789 di Chat API mewakili orang yang sama dengan people/123456789 di People API.
    • id untuk resource User di Directory API—misalnya, users/123456789 di Chat API mewakili orang yang sama dengan users/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 atau users/EMAIL_USERNAME@gmail.com.

Mengidentifikasi pengguna dari peristiwa interaksi

Setiap kali pengguna berinteraksi dengan aplikasi Chat, Chat 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 bisa 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 pada resource User, menggunakan salah satu hal berikut: