User

משתמש ב-Google Chat.

כשמוחזר פלט מבקשה, אם אפליקציית Chat מאומתת כמשתמש, הפלט של משאב User (למשל בממשקי API של הודעות וחברות) מאכלס רק את השדות name ו-type גם למשתמשים פנימיים וגם למשתמשים חיצוניים, אלא אם הם חברים במרחב או שיש להם קרבה קודמת למשתמש שקורא לפונקציה.

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

string

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

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

במקרה של human users, המזהה {user} זהה למזהה המשתמש הבא:

  • ‫id Person ב-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. ה-API יחזיר רק את השם הרשמי של המשאב (לדוגמה, users/123456789).
displayName

string

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

השדה הזה מאוכלס גם באימות אפליקציה וגם באימות משתמש. השדה הזה תמיד מאוכלס בבקשות שמתבצעות באמצעות אימות אפליקציות. כשמתקשרים אל ממשקי ה-API של ההודעות והחברות עם אימות משתמש, השדה הזה מאוכלס גם עבור משתמשים פנימיים וגם עבור משתמשים חיצוניים ב-sender של הודעה, משתמשים ב-annotations (כמו תיוגים של משתמשים) ובמשאבי Membership, בתנאי שהמשתמש הוא חבר במרחב או שיש לו קרבה קודמת למשתמש המתקשר.
avatarUrl

string

פלט בלבד. כתובת ה-URL של תמונת האווטאר של המשתמש.

כשמתקשרים אל ממשקי ה-API של ההודעות והחברות עם אימות משתמש, השדה הזה מאוכלס גם עבור משתמשים פנימיים וגם עבור משתמשים חיצוניים ב-sender של הודעה, משתמשים ב-annotations (כמו תיוגים של משתמשים) ובמשאבי Membership, בתנאי שהמשתמש הוא חבר במרחב או שיש לו קרבה קודמת למשתמש המתקשר.
email

string

פלט בלבד. כתובת האימייל של המשתמש.

כשמתקשרים אל ממשקי ה-API של ההודעות והחברות עם אימות משתמש, השדה הזה מאוכלס גם עבור משתמשים פנימיים וגם עבור משתמשים חיצוניים ב-sender של הודעה, משתמשים ב-annotations (כמו תיוגים של משתמשים) ובמשאבי Membership, בתנאי שהמשתמש הוא חבר במרחב או שיש לו קרבה קודמת למשתמש המתקשר.
domainId

string

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

enum (Type)

סוג המשתמש.
isAnonymous

boolean

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

סוג

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