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} 是与以下内容相同的用户标识符：

  • 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 API 和 Memberships API 时，如果用户是聊天室成员或之前与调用用户有亲和关系，则对于消息的 sender、annotations 中的用户（例如提及的用户）以及 Membership 资源中的用户，系统会为内部用户和外部用户填充此字段。
avatarUrl

string

仅限输出。用户的头像图片网址。

通过用户身份验证调用 Messages API 和 Memberships API 时，如果用户是聊天室成员或之前与调用用户有亲和关系，则对于消息的 sender、annotations 中的用户（例如提及的用户）以及 Membership 资源中的用户，系统会为内部用户和外部用户填充此字段。
email

string

仅限输出。用户的电子邮件地址。

通过用户身份验证调用 Messages API 和 Memberships API 时，如果用户是聊天室成员或之前与调用用户有亲和关系，则对于消息的 sender、annotations 中的用户（例如提及的用户）以及 Membership 资源中的用户，系统会为内部用户和外部用户填充此字段。
domainId

string

用户的 Google Workspace 网域的唯一标识符。
type

enum (Type)

用户类型。
isAnonymous

boolean

仅限输出。当值为 true 时，表示用户已被删除或其个人资料不可见，例如在聊天室中提及的用户不是成员，并且与调用用户没有先前的亲和度。

类型

枚举
TYPE_UNSPECIFIED 枚举的默认值。请勿使用。
HUMAN 人类用户。
BOT Chat 应用用户。