このページでは、Google Chat アプリで識別や指定を行う Chat ユーザー。
Chat 用アプリは、次のいずれかの操作を行います。 ユーザーを指定する必要があります。
- メッセージを<ph type="x-smartling-void-element"><wbr /></ph>作成 @ でユーザーの名前リンクが付けられる。
- ユーザーを 既存のスペース スペースにユーザーを追加したり 新しいスペースを開きます。
- ダイレクト メッセージを検索する Chat 用アプリと特定のユーザーの間の通話、または 2 人のユーザーの間で やり取りされます
- スペースでユーザーのメンバーシップの詳細を取得する
- ユーザーにプライベート メッセージを送信します。
- ユーザーをサブスクライブする Google Workspace Events API を使用して、メンバーシップの変更に関するイベントを取得できます。
Chat でユーザーを識別する方法
Google Chat API は
User
リソース
ユーザーごとにライセンスを付与できます。次の 2 つは重要です。
User
フィールド:
name
は、リソースのリソース名(users/{user}
形式)です。 ここで、{user}
は一意の識別子を表します。users/app
さんができること として使用 呼び出し側の Chat アプリのエイリアスになります。type
はユーザーのタイプです。この指定により、Chat に 割り当てることができます。対象 Chat 用アプリの場合、値はBOT
です。人々にとっての価値はHUMAN
。
Google Chat API の呼び出しでユーザーを指定する
ユーザーを指定するには、{user}
の値に次の値を使用します。
Google Workspace 組織内のユーザーの場合は、 次のようなアプローチがあります。
name
のUser
リソース Chat API 内で使用できます(users/123456789
など)。- 名前の
{person_id}
People API のPerson
リソース ここで、resourceName
はpeople/{person_id}
です。例: Chat API のusers/123456789
は、同一人物を表します。 People API ではpeople/123456789
として指定します。 - Directory API の
User
リソースのid
(例: Chat API のusers/123456789
は、同一人物を表します。 Directory API ではusers/123456789
として指定します。
外部の Google Workspace 組織のユーザーまたはユーザー メール エイリアス(
users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com
またはusers/EMAIL_USERNAME@gmail.com
。
インタラクション イベントからユーザーを識別する
ユーザーが Chat 用アプリを操作するたびに、 チャットから インタラクション イベントに関する情報が です。たとえば、 メッセージで Chat 用アプリの名前リンクが付けられた場合、 Chat アプリは、やり取りに関する情報を受信します。 メッセージの内容、送信者などですChat 用アプリ Chat リソースに関する情報を取得するときに、ユーザーを参照します。
Chat 用アプリを操作したユーザーを特定するには、
name
プロパティの値を取得する
User
リソース、
これは
Event.user.name
。
次の JSON の例は、ユーザー ID の形式を示しています。 やり取りする方法の例は次のとおりです。
{
...,
"user": {
"name": "users/12345678901234567890",
"displayName": "Sasha",
"avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
"email": "sasha@example.com"
}
}
メッセージは特定のタイプのインタラクションです。Google Chat で送信した
Chat 用アプリへのメッセージ送信、
name
プロパティの値を取得する
User
リソース。
次のとおりです。