本頁面由 Cloud Translation API 翻譯而成。

取得聊天室詳細資料

本指南說明如何在 Google Chat API 的 Space 資源上使用 get() 方法，查看聊天室的詳細資料，例如顯示名稱、說明和規範。

如果您是 Google Workspace 管理員，可以呼叫 get() 方法，擷取 Google Workspace 機構中任何空間的詳細資料。

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

即時訊息 (DM) 是兩位使用者或使用者和 Chat 應用程式之間的對話。
群組通訊是三位以上使用者和 Chat 應用程式的對話。
已命名的聊天室是使用者傳送訊息、共用檔案及協同合作的永久位置。

使用應用程式驗證進行驗證後，Chat 應用程式就能取得 Chat 應用程式所屬聊天室的詳細資料。透過使用者驗證進行驗證，您就能取得已驗證使用者可存取的聊天室，無論是聊天室成員或Google Workspace 管理員皆可。

必要條件

Node.js

具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API，並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Node.js Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式建立存取憑證：
  - 如要以 Chat 使用者的身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並將憑證儲存為名為 client_secrets.json 的 JSON 檔案，並儲存在本機目錄中。
  - 如要以 Chat 應用程式的形式進行驗證，請建立服務帳戶憑證，並將憑證儲存為名為 credentials.json 的 JSON 檔案。
根據您想以使用者或 Chat 應用程式身分驗證，選擇授權範圍。

Google Chat 聊天室，且已通過驗證的使用者或呼叫 Chat 擴充應用程式的成員。如要以 Chat 應用程式驗證，請將 Chat 應用程式新增至聊天室。

Python

可存取 Google Chat 的 Business 或 Enterprise Google Workspace 帳戶。

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API，並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Python Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式建立存取憑證：
  - 如要以 Chat 使用者的身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並將憑證儲存為名為 client_secrets.json 的 JSON 檔案，並儲存在本機目錄中。
  - 如要以 Chat 應用程式的形式進行驗證，請建立服務帳戶憑證，並將憑證儲存為名為 credentials.json 的 JSON 檔案。
根據您想以使用者或 Chat 應用程式身分驗證，選擇授權範圍。

Google Chat 聊天室：使用者或發出呼叫的 Chat 應用程式是其中成員。如要以 Chat 應用程式驗證，請將 Chat 應用程式新增至聊天室。

Java

具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API，並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Java Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式建立存取憑證：
  - 如要以 Chat 使用者身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並以 client_secrets.json 檔案格式將憑證儲存至本機目錄。
  - 如要以 Chat 應用程式進行驗證，請建立服務帳戶憑證，並將憑證儲存為名為 credentials.json 的 JSON 檔案。
根據您想以使用者或 Chat 應用程式身分驗證，選擇授權範圍。

Google Chat 聊天室：使用者或發出呼叫的 Chat 應用程式是其中成員。如要以 Chat 應用程式驗證，請將 Chat 應用程式新增至聊天室。

Apps Script

可存取 Google Chat 的 Business 或 Enterprise Google Workspace 帳戶。

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 使用 Chat 應用程式的名稱、圖示和說明啟用並設定 Google Chat API。
- 建立獨立的 Apps Script 專案，然後開啟進階 Chat 服務。
- 在本指南中，您必須使用使用者或應用程式驗證。如要以 Chat 應用程式身分進行驗證，請建立服務帳戶憑證。如需步驟，請參閱「以 Google Chat 應用程式身分驗證及授權」。
根據要以使用者或 Chat 應用程式身分進行驗證，選擇授權範圍。

Google Chat 聊天室：使用者或發出呼叫的 Chat 應用程式是其中成員。如要以 Chat 應用程式的身分進行驗證，請將 Chat 應用程式新增至聊天室。

取得聊天室

如要取得 Google Chat 中的聊天室，請在要求中傳遞以下內容：

授權範圍：
- 使用使用者驗證時，請指定 chat.spaces.readonly 或 chat.spaces 授權範圍。
- 使用應用程式驗證時，請指定 chat.bot 授權範圍或 chat.app.spaces 範圍。chat.app.spaces 範圍可在開發人員預覽版中使用，且需要管理員核准。
呼叫 GetSpace() 方法，傳遞要取得的空間的 name。從 Google Chat 的 Space 資源或聊天室網址取得聊天室名稱。

以使用者身分取得聊天室詳細資料

以下說明如何使用使用者驗證取得聊天室詳細資料：

Node.js

chat/client-libraries/cloud/get-space-user-cred.js

前往 GitHub 查看

import {createClientWithUserCredentials} from './authentication-utils.js';

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

// This sample shows how to get 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 SPACE_NAME here
    name: 'spaces/SPACE_NAME'
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/get_space_user_cred.py

前往 GitHub 查看

from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.spaces.readonly"]

# This sample shows how to get space with user credential
def get_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.GetSpaceRequest(
        # Replace SPACE_NAME here
        name = "spaces/SPACE_NAME",
    )

    # Make the request
    response = client.get_space(request)

    # Handle the response
    print(response)

get_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetSpaceUserCred.java

前往 GitHub 查看

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to get space with user credential.
public class GetSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces.readonly";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      GetSpaceRequest.Builder request = GetSpaceRequest.newBuilder()
        // Replace SPACE_NAME here
        .setName("spaces/SPACE_NAME");
      Space response = chatServiceClient.getSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

前往 GitHub 查看

/**
 * This sample shows how to get space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function getSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = 'spaces/SPACE_NAME';

  // Make the request
  const response = Chat.Spaces.get(name);

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

如要執行這個範例，請將 SPACE_NAME 替換為聊天室 name 欄位中的 ID。您可以呼叫 ListSpaces() 方法，或從空間的網址取得 ID。

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

以 Google Workspace 管理員身分取得聊天室詳細資料

如果您是 Google Workspace 管理員，可以呼叫 GetSpace 方法，擷取 Google Workspace 機構內任何空間的詳細資料。

如要以 Google Workspace 管理員身分呼叫這個方法，請按照下列步驟操作：

使用使用者驗證來呼叫方法，並指定支援使用管理員權限呼叫方法的授權範圍。
在要求中，將查詢參數 useAdminAccess 指定為 true。

如需進一步瞭解相關資訊和範例，請參閱「以 Google Workspace 管理員身分管理 Google Chat 聊天室」。

以 Chat 應用程式的形式取得聊天室詳細資料

以下說明如何透過應用程式驗證取得空間詳細資料：

Node.js

chat/client-libraries/cloud/get-space-app-cred.js

前往 GitHub 查看

import {createClientWithAppCredentials} from './authentication-utils.js';

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

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

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/get_space_app_cred.py

前往 GitHub 查看

from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to get space with app credential
def get_space_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.GetSpaceRequest(
        # Replace SPACE_NAME here
        name = "spaces/SPACE_NAME",
    )

    # Make the request
    response = client.get_space(request)

    # Handle the response
    print(response)

get_space_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetSpaceAppCred.java

前往 GitHub 查看

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to get space with app credential.
public class GetSpaceAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      GetSpaceRequest.Builder request = GetSpaceRequest.newBuilder()
        // Replace SPACE_NAME here
        .setName("spaces/SPACE_NAME");
      Space response = chatServiceClient.getSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

即時通訊/advanced-service/Main.gs

前往 GitHub 查看

/**
 * This sample shows how to get space with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function getSpaceAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = 'spaces/SPACE_NAME';
  const parameters = {};

  // Make the request
  const response = Chat.Spaces.get(name, parameters, getHeaderWithAppCredentials());

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

如要執行這個範例，請將 SPACE_NAME 替換為空間 name 欄位的 ID。您可以呼叫 ListSpaces() 方法，或從空間的網址取得 ID。

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

取得聊天室詳細資料

必要條件

Node.js

Python

Java

Apps Script

取得聊天室

以使用者身分取得聊天室詳細資料

Node.js

Python

Java

Apps Script

以 Google Workspace 管理員身分取得聊天室詳細資料

以 Chat 應用程式的形式取得聊天室詳細資料

Node.js

Python

Java

Apps Script

相關主題