尋找即時訊息 (DM) 聊天室

本指南說明如何在 Google Chat API 的 Space 資源上使用 findDirectMessage() 方法，取得直接訊息 (DM) 聊天室的詳細資料。

Space 資源代表使用者和 Chat 應用程式可傳送訊息、共用檔案和協作的場所。聊天室分為以下幾種類型：

  • 即時訊息 (DM) 是指兩位使用者之間，或使用者與 Chat 應用程式之間的對話。
  • 群組通訊是指三位以上使用者與 Chat 應用程式之間的對話。
  • 命名聊天室是持續存在的空間，可供使用者傳送訊息、共用檔案和協作。

Google Workspace 管理員為整個 Google Workspace 機構安裝 Chat 應用程式時，Google Chat 會在已安裝的 Chat 應用程式與機構內每位使用者之間建立私訊。

使用應用程式驗證進行驗證後，Chat 應用程式就能取得 Chat 應用程式在 Google Chat 中可存取的私訊 (例如，該應用程式所屬的私訊)。使用使用者驗證驗證時，系統會傳回已驗證使用者可存取的私訊。

必要條件

Node.js

尋找即時訊息

如要在 Google Chat 中尋找即時訊息，請在要求中傳遞下列資訊：

  • 使用應用程式驗證功能時，請指定 chat.bot 授權範圍。使用使用者驗證時，請指定 chat.spaces.readonly 或 chat.spaces 授權範圍。
  • 呼叫 FindDirectMessage() 方法，傳遞 DM 中其他使用者的 name 以便傳回。在使用者驗證的情況下，這個方法會傳回呼叫使用者與指定使用者之間的 DM。透過應用程式驗證，這個方法會在呼叫應用程式和指定使用者之間傳回 DM。
  • 如要將真人使用者新增為聊天室成員，請指定 users/{user}，其中 {user} 是 People API 中 person 的 {person_id}，或是 Directory API 中的 user ID。舉例來說，如果 People API 使用者 resourceName 是 people/123456789，您可以加入會員資格，並將 users/123456789 設為 member.name，藉此將使用者加入聊天室。

尋找使用者驗證的即時訊息

以下說明如何尋找含有使用者驗證的即時訊息：

Node.js

chat/client-libraries/cloud/find-dm-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly'];

// This sample shows how to find a Direct Message space with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace USER_NAME here
    name: 'users/USER_NAME'
  };

  // Make the request
  const response = await chatClient.findDirectMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

如要執行這個範例，請將 USER_NAME 替換為使用者 name 欄位的 ID。

Chat API 會傳回 Space 的例項，其中包含指定 DM 的詳細資料。

尋找透過應用程式驗證的即時訊息

以下說明如何找出使用應用程式驗證功能傳送的訊息：

Node.js

chat/client-libraries/cloud/find-dm-space-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to find a Direct Message space with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    // Replace USER_NAME here
    name: 'users/USER_NAME'
  };

  // Make the request
  const response = await chatClient.findDirectMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

如要執行這個範例，請將 USER_NAME 替換為使用者 name 欄位的 ID。

Chat API 會傳回 Space 的例項，其中包含指定 DM 的詳細資料。