זיהוי וציון של משתמשי Google Chat

בדף הזה מוסבר איך אפליקציות Google Chat יכולות לזהות או לציין משתמשי Chat.

כדי לבצע את הפעולות הבאות, אפליקציית צ'אט חייבת לציין משתמש:

איך מערכת Chat מזהה משתמשים

‏Google Chat API יוצר משאב User לכל משתמש ב-Chat. אלה שני שדות חשובים של User:

  • name הוא שם המשאב, בפורמט users/{user}, כאשר {user} מייצג מזהה ייחודי וקבוע. אפשר להשתמש ב-users/app ככינוי לאפליקציית Chat שבאמצעותה מתבצעת הקריאה.
  • type הוא סוג המשתמש. הסוג הזה מאפשר ל-Chat לדעת אם המשתמש הוא אפליקציית Chat או אדם. באפליקציות צ'אט, הערך הוא BOT. עבור אנשים, הערך הוא HUMAN.

ציון משתמש בקריאה ל-Google Chat API

כדי לציין משתמש, צריך להשתמש בערכים הבאים עבור הערך {user}:

  • למשתמשים בארגון שלכם ב-Google Workspace, תוכלו להשתמש באחת מהגישות הבאות:

    • השדה name של המשאב User ב-Chat API, למשל users/123456789.
    • השדה {person_id} של שם משאב Person ב-People API, כאשר השדה resourceName הוא people/{person_id}. לדוגמה, השדה users/123456789 ב-Chat API מייצג את אותו אדם כמו השדה people/123456789 ב-People API.
    • השדה id של משאב User ב-Directory API. לדוגמה, הערך users/123456789 ב-Chat API מייצג את אותו אדם כמו הערך users/123456789 ב-Directory API.

  • אם מדובר במשתמש בארגון חיצוני ב-Google Workspace או במשתמש שמשתמש בחשבון Google, צריך להשתמש בכתובת אימייל חלופית – לדוגמה, users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com או users/EMAIL_USERNAME@gmail.com.

זיהוי משתמש מאירוע אינטראקציה

בכל פעם שמשתמש מבצע אינטראקציה עם אפליקציית Chat, ‏Chat שולח אירוע אינטראקציה עם מידע על האינטראקציה ועל המשתמש. לדוגמה, כשמשתמש מזכיר אפליקציית Chat בהודעה, אפליקציית Chat מקבלת מידע על האינטראקציה, כולל תוכן ההודעה ומי שלח אותה. אפליקציות Chat מפנות למשתמשים כשהן מאחזרות מידע על משאבים של Chat.

כדי לזהות את המשתמש שהייתה לו אינטראקציה עם אפליקציית Chat, צריך לקבל את הערך של המאפיין name במשאב User, שאפשר לקבל מ-Event.user.name.

בדוגמה הבאה ל-JSON מוצג הפורמט הצפוי של זהות המשתמש באינטראקציה עם אפליקציית Chat:

{
  ...,
  "user": {
    "name": "users/12345678901234567890",
    "displayName": "Sasha",
    "avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
    "email": "sasha@example.com"
  }
}

הודעה היא סוג ספציפי של אינטראקציה. כדי לזהות משתמש ששלח הודעה לאפליקציית Chat, אפשר לקבל את הערך של המאפיין name במשאב User באמצעות אחת מהשיטות הבאות: