本頁說明 Google Chat 應用程式可用來識別或指定 Chat 使用者的方式。
如要執行下列任一操作,Chat 應用程式必須指定使用者:
- 建立@ 提及使用者的訊息。
- 邀請或新增使用者至現有聊天室,或新增使用者至新聊天室。
- 尋找 Chat 應用程式與特定使用者之間,或兩位使用者之間的即時訊息。
- 取得使用者在聊天室中的成員資格詳細資料。
- 傳送私人訊息給使用者。
- 使用 Google Workspace Events API 訂閱使用者,取得會員變更事件。
Chat 如何識別使用者
Google Chat API 會為每位使用 Chat 的使用者產生 User
資源。以下是兩個重要的 User
欄位:
name
是資源的資源名稱,格式為users/{user}
,其中{user}
代表專屬且穩定的 ID。users/app
可用於做為呼叫 Chat 應用程式的別名。type
是使用者類型。這類型會告知 Chat 使用者是 Chat 應用程式還是使用者。對於即時通訊應用程式,這個值為BOT
。針對人員,值為HUMAN
。
在 Google Chat API 呼叫中指定使用者
如要指定使用者,請使用下列 {user}
值:
如果是 Google Workspace 機構中的使用者,請採用下列其中一種做法:
如果是外部 Google Workspace 機構的使用者,或使用 Google 帳戶的使用者,請使用電子郵件別名,例如
users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com
或users/EMAIL_USERNAME@gmail.com
。
從互動事件中識別使用者
每當使用者與 Chat 應用程式互動時,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
屬性值: