取得聊天室詳細資料

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

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

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

透過應用程式驗證進行驗證，可讓 Chat 應用程式取得 Google Chat 中可存取的聊天室 (例如應用程式所屬的聊天室)。以使用者驗證方式進行驗證後，您就能取得已驗證使用者可以存取的空間。

必要條件

Python

  • Python 3.6 或更高版本
  • pip 套件管理工具

  • 最新的 Python 專用 Google 用戶端程式庫。如要安裝或更新，請在指令列介面中執行下列指令：

    pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
  • 已啟用並設定 Google Chat API 的 Google Cloud 專案。相關步驟請參閱「建構 Google Chat 應用程式」。

  • 已為 Chat 應用程式設定授權。取得聊天室支援以下兩種驗證方法：

Node.js

  • Node.js 與 npm

  • 最新的 Node.js 專用 Google 用戶端程式庫。如要安裝，請在指令列介面中執行下列指令：

    npm install @google-cloud/local-auth @googleapis/chat
  • 已啟用並設定 Google Chat API 的 Google Cloud 專案。相關步驟請參閱「建構 Google Chat 應用程式」。

  • 已為 Chat 應用程式設定授權。取得聊天室支援以下兩種驗證方法：

取得聊天室

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

  • 透過應用程式驗證，指定 chat.bot 授權範圍。透過使用者驗證，請指定 chat.spaces.readonly 或 chat.spaces 授權範圍。
  • 呼叫 Space 資源上的 get 方法，並傳遞取得空間的 name。從 Google Chat 的聊天室資源或聊天室網址取得聊天室名稱。

透過使用者驗證機制取得聊天室詳細資料

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

Python

  1. 在工作目錄中，建立名為 chat_space_get_user.py 的檔案。

  2. 在 chat_space_get_user.py 中加入下列程式碼：

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.spaces.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then gets details about a specified space.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().get(

          # The space to get.
          #
          # Replace SPACE with a space name.
          # Obtain the space name from the spaces resource of Chat API,
          # or from a space's URL.
          name='spaces/SPACE'

      ).execute()

    # Prints details about the space.
    print(result)

if __name__ == '__main__':
    main()

  3. 在程式碼中，將 SPACE 替換為聊天室名稱，您可以在 Chat API 的 spaces.list 方法或聊天室網址取得這項資訊。

  4. 在工作目錄中，建構並執行範例：

    python3 chat_space_get_user.py

Node.js

  1. 在工作目錄中，建立名為 get-space.js 的檔案。

  2. 在 get-space.js 中加入下列程式碼：

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Gets details about a Chat space by name.
* @return {!Object}
*/
async function getSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces.readonly',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.get({name: 'spaces/SPACE'});
}

getSpace().then(console.log);

  3. 在程式碼中，將 SPACE 替換為聊天室名稱，您可以在 Chat API 的 spaces.list 方法或聊天室網址取得這項資訊。

  4. 在工作目錄中，執行範例：

    node get-space.js

Chat API 會傳回 Space 的執行個體，詳細說明指定聊天室。

使用應用程式驗證功能取得聊天室詳細資料

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

Python

  1. 在工作目錄中，建立名為 chat_space_get_app.py 的檔案。

  2. 在 chat_space_get_app.py 中加入下列程式碼：

    from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Use the service endpoint to call Chat API.
result = chat.spaces().get(

    # The space to get.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    name='spaces/SPACE'

).execute()

print(result)

  3. 在程式碼中，將 SPACE 替換為聊天室名稱，您可以在 Chat API 的 spaces.list() 方法或聊天室網址取得。

  4. 在工作目錄中，建構並執行範例：

    python3 chat_space_get_app.py

Node.js

  1. 在工作目錄中，建立名為 app-get-space.js 的檔案。

  2. 在 app-get-space.js 中加入下列程式碼：

    const chat = require('@googleapis/chat');

/**
* Gets details about a Chat space by name.
* @return {!Promise<!Object>}
*/
async function getSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.bot',
  ];

  const auth = new chat.auth.GoogleAuth({
    scopes,
    keyFilename: 'credentials.json',
  });

  const authClient = await auth.getClient();
  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.get({name: 'spaces/SPACE'});
}

getSpace().then(console.log);

  3. 在程式碼中，將 SPACE 替換為聊天室名稱，您可以在 Chat API 的 spaces.list 方法或聊天室網址取得這項資訊。

  4. 在工作目錄中，執行範例：

    node app-get-space.js

Chat API 會傳回 Space 的執行個體，詳細說明指定聊天室。