辨識及指定 Google Chat 使用者

本頁面說明 Google Chat 應用程式識別或指定 Chat 使用者的方式。

如要執行下列任一操作,Chat 應用程式必須指定使用者:

Chat 辨識使用者的方式

Google Chat API 會為使用 Chat 的每位使用者產生 User 資源。以下是兩個重要的 User 欄位:

  • name 是資源的資源名稱,格式為 users/{user},其中 {user} 代表不重複的穩定 ID。users/app 可做為呼叫 Chat 應用程式的別名。
  • type 是使用者的類型。這種類型會告知 Chat 使用者是 Chat 應用程式還是個人。如果是 Chat 應用程式,這個值為 BOT。針對人,這個值則為 HUMAN

指定 Google Chat API 的呼叫使用者

如要指定使用者,請在 {user} 值中使用下列值:

  • 針對 Google Workspace 機構的使用者,採用下列其中一種方法:

    • Chat API 中的 User 資源 name,例如 users/123456789
    • 在 People API 中,Person 資源的名稱 {person_id},其中 resourceNamepeople/{person_id};舉例來說,Chat API 中的 users/123456789 代表與 People API 中的 people/123456789 相同。
    • Directory API 中 User 資源的 id (例如 Chat API 中的 users/123456789) 代表與 Directory API 中的 users/123456789 相同的人員。
  • 如果是外部 Google Workspace 機構的使用者或 Google 帳戶使用者,請使用電子郵件別名,例如 users/EMAIL_USERNAME@WORKSPACE_DOMAIN.comusers/EMAIL_USERNAME@gmail.com

辨識互動事件中的使用者

每次有使用者與 Chat 應用程式互動時,Chat 都會傳送「互動事件」,其中含有互動和使用者的相關資訊。舉例來說,當使用者在訊息中提及 Chat 應用程式時,Chat 應用程式會收到互動相關資訊,包括訊息內容及傳送者。即時通訊應用程式會在擷取 Chat 資源的相關資訊時參照使用者。

如要找出與 Chat 應用程式互動的使用者,請在 User 資源中取得 name 屬性值,您可在 Event.user.name 中取得。

以下 JSON 範例顯示與 Chat 應用程式互動時預期的使用者身分格式:

{
  ...,
  "user": {
    "name": "users/12345678901234567890",
    "displayName": "Sasha",
    "avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
    "email": "sasha@example.com"
  }
}

訊息是一種特定的互動類型。如要識別傳送訊息給 Chat 應用程式的使用者,請使用下列任一方法,取得 User 資源name 屬性值: