更新聊天室

本指南說明如何針對 Google Chat API 的 Space 資源使用 patch 方法，以更新聊天室。更新聊天室即可變更聊天室屬性，例如使用者能看到的顯示名稱、說明和規範。

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

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

先備知識

Python

  • Python 3.6 以上版本
  • pip 套件管理工具

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

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

  • 已為 Chat 應用程式設定授權。如要更新聊天室，需要具備 chat.spaces 授權範圍的使用者驗證。

Node.js

  • Node.js 與 npm

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

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

  • 已為 Chat 應用程式設定授權。如要更新聊天室，需要具備 chat.spaces 授權範圍的使用者驗證。

更新聊天室

如果要更新 Google Chat 中的現有聊天室，請在要求中傳遞以下內容：

  • 指定 chat.spaces 授權範圍。
  • 呼叫 Space 資源上的 patch 方法。在要求中指定空格 name 欄位、有一或多個要更新欄位的 updateMask 欄位，以及包含已更新空間資訊的 body。

您可以更新顯示名稱、聊天室類型、記錄狀態等項目。如要查看可更新的所有欄位，請參閱參考說明文件。

以下說明如何更新現有聊天室的「spaceDetails」欄位：

Python

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

  2. 在 chat_space_update.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"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates the specified space description and guidelines.
    '''

    # 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().patch(

      # The space to update, and the updated space details.
      #
      # 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',
      updateMask='spaceDetails',
      body={

        'spaceDetails': {
          'description': 'This description was updated with Chat API!',
          'guidelines': 'These guidelines were updated with Chat API!'
        }

      }

    ).execute()

    # Prints details about the updated space.
    print(result)

if __name__ == '__main__':
    main()

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

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

    python3 chat_space_update.py

Node.js

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

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

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

/**
* Updates a Chat space with the description and guidelines.
* @return {!Promise<!Object>}
*/
async function updateSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces',
  ];

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

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

  return await chatClient.spaces.patch({
    name: 'spaces/SPACE',
    updateMask: 'spaceDetails',
    requestBody: {
      spaceDetails: {
        description: 'This description was updated with Chat API!',
        guidelines: 'These guidelines were updated with Chat API!'
      },
    }
  });
}

updateSpace().then(console.log);

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

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

    node update-space.js

Google Chat API 會傳回反映更新的 Space 資源執行個體。