User

Google Chat のユーザー。

リクエストの出力として返される場合、Chat 用アプリがユーザーとして認証されると、User リソース(Messages API や 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 人物プロファイル ID と同じ人物を表します。

  • Admin SDK Directory API のユーザーの id。

  • ユーザーのメールアドレスは、API リクエストで {user} のエイリアスとして使用できます。たとえば、user@example.com の People API の人物プロファイル ID が 123456789 の場合、users/user@example.com をエイリアスとして使用して users/123456789 を参照できます。API から返されるのは、正規のリソース名(users/123456789 など)のみです。

displayName

string

出力専用。ユーザーの表示名。

アプリ認証とユーザー認証の両方で入力されます。このフィールドは、アプリ認証を使用して行われたリクエストに対して常に設定されます。ユーザー認証を使用してメッセージ API とメンバーシップ API を呼び出す場合、ユーザーがスペースのメンバーであるか、呼び出しユーザーと以前に親和性がある場合、メッセージの sender、annotations 内のユーザー(ユーザーメンションなど)、Membership リソースの両方について、内部ユーザーと外部ユーザーの両方に対してこのフィールドが入力されます。

avatarUrl

string

出力専用。ユーザーのアバター画像の URL。

ユーザー認証を使用してメッセージ API とメンバーシップ API を呼び出す場合、ユーザーがスペースのメンバーであるか、呼び出しユーザーと以前に親和性がある場合、メッセージの sender、annotations 内のユーザー(ユーザーメンションなど)、Membership リソースの両方について、内部ユーザーと外部ユーザーの両方に対してこのフィールドが入力されます。

email

string

出力専用。ユーザーのメール アドレスです。

ユーザー認証を使用してメッセージ API とメンバーシップ API を呼び出す場合、ユーザーがスペースのメンバーであるか、呼び出しユーザーと以前に親和性がある場合、メッセージの sender、annotations 内のユーザー(ユーザーメンションなど)、Membership リソースの両方について、内部ユーザーと外部ユーザーの両方に対してこのフィールドが入力されます。

domainId

string

ユーザーの Google Workspace ドメインの固有識別子。

type

enum (Type)

ユーザータイプ。

isAnonymous

boolean

出力専用。true の場合、ユーザーが削除されたか、プロフィールが表示されません。たとえば、ユーザーがメンバーではなく、通話ユーザーとの親近感もないスペースで言及された場合などです。

タイプ

列挙型
TYPE_UNSPECIFIED 列挙型のデフォルト値。使用しないでください。
HUMAN 人間のユーザー。
BOT Chat アプリのユーザー。