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 של [email protected] הוא 123456789, אפשר להשתמש ב-users/[email protected] ככינוי כדי לציין את users/123456789. רק השם הקנוני של המשאב (לדוגמה users/123456789) יוחזר מה-API.
displayName

string

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

string

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

enum (Type)

סוג המשתמש.
isAnonymous

boolean

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

סוג

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