User

משתמש ב-Google Chat. כשהפלט מוחזר מבקשה, אם אפליקציית Chat מאמתת כמשתמש, הפלט של משאב User מאכלס רק את name ו-type של המשתמש.

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "domainId": string,
  "type": enum (Type),
  "isAnonymous": boolean
}
שדות
name

string

שם המשאב של user ב-Google Chat.

פורמט: users/{user} אפשר להשתמש ב-users/app ככינוי למשתמש bot באפליקציית השיחה.

בשביל human users, {user} הוא אותו מזהה משתמש כמו:

  • השדה id של האדם ב-People API. לדוגמה, הערך users/123456789 ב-Chat API מייצג את אותו אדם כמו מזהה פרופיל האדם 123456789 ב-People API.

  • השדה id של משתמש ב-Admin SDK Directory API.

  • אפשר להשתמש בכתובת האימייל של המשתמש ככתובת חלופית ל-{user} בבקשות API. לדוגמה, אם מזהה פרופיל המשתמש של People API של user@example.com הוא 123456789, אפשר להשתמש ב-users/user@example.com ככינוי כדי לציין את users/123456789. רק שם המשאב הקנוני (לדוגמה users/123456789) יוחזר מה-API.
displayName

string

פלט בלבד. השם המוצג של המשתמש.
domainId

string

המזהה הייחודי של דומיין Google Workspace של המשתמש.
type

enum (Type)

סוג המשתמש.
isAnonymous

boolean

פלט בלבד. כשהערך של true הוא 0, המשתמש נמחק או שהפרופיל שלו לא גלוי.

סוג

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של המאפיין enum. אין להשתמש בו.
HUMAN משתמש אנושי.
BOT משתמש באפליקציית Chat.