User

Google Chat 使用者。

如果 Chat 應用程式以使用者身分進行驗證，當要求傳回做為輸出內容時，除非內部和外部使用者是聊天室成員，或與呼叫使用者有先前的親和力，否則 User 資源 (例如 Messages 和 Memberships API) 的輸出內容只會填入 name 和 type 欄位。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "avatarUrl": string,
  "email": string,
  "domainId": string,
  "type": enum (Type),
  "isAnonymous": boolean
}
欄位
name

string

Google Chat user 的資源名稱。

格式：users/{user}。users/app 可做為呼叫應用程式 bot 使用者的別名。

對於 human users，{user} 與下列項目是相同的使用者 ID：

  • People API 中 Person 的 id。舉例來說，Chat API 中的 users/123456789 代表的人與 People API 中的 123456789 Person 設定檔 ID 代表的人相同。

  • Admin SDK Directory API 中使用者的 id。

  • 在 API 要求中，使用者的電子郵件地址可做為 {user} 的別名。舉例來說，如果 user@example.com 的 People API Person 設定檔 ID 為 123456789，您可以使用 users/user@example.com 做為別名來參照 users/123456789。API 只會傳回正規資源名稱 (例如 users/123456789)。
displayName

string

僅供輸出。使用者的顯示名稱。

應用程式驗證和使用者驗證都會填入這個欄位。使用應用程式驗證發出要求時，這個欄位一律會填入內容。使用使用者驗證呼叫 Messages 和 Memberships API 時，如果使用者是聊天室成員，或與呼叫使用者有先前的親和度，系統會為訊息的 sender、annotations 內的使用者 (例如使用者提及) 和 Membership 資源填入這個欄位，適用於內部和外部使用者。
avatarUrl

string

僅供輸出。使用者的顯示圖片網址。

使用使用者驗證呼叫 Messages 和 Memberships API 時，如果使用者是聊天室成員，或與呼叫使用者有先前的親和度，系統會為訊息的 sender、annotations 內的使用者 (例如使用者提及) 和 Membership 資源填入這個欄位，適用於內部和外部使用者。
email

string

僅供輸出。使用者的電子郵件地址。

使用使用者驗證呼叫 Messages 和 Memberships API 時，如果使用者是聊天室成員，或與呼叫使用者有先前的親和度，系統會為訊息的 sender、annotations 內的使用者 (例如使用者提及) 和 Membership 資源填入這個欄位，適用於內部和外部使用者。
domainId

string

使用者 Google Workspace 網域的專屬 ID。
type

enum (Type)

使用者類型。
isAnonymous

boolean

僅供輸出。true，使用者遭到刪除或個人資料不顯示，例如在聊天室中提及使用者，但對方不是成員，且與通話使用者沒有先前的親和度。

類型

列舉
TYPE_UNSPECIFIED 列舉的預設值。請勿使用。
HUMAN 人類使用者。
BOT Chat 應用程式使用者。