User

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

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

string

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

פורמט: 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. לדוגמה, אם מזהה פרופיל האנשים של user@example.com ב-People API הוא 123456789, תוכלו להשתמש ב-users/user@example.com ככינוי כדי להפנות אל users/123456789. רק השם של המשאב הקנוני (לדוגמה users/123456789) יוחזר מה-API.

displayName

string

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

domainId

string

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

type

enum (Type)

סוג משתמש.

isAnonymous

boolean

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

סוג

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