更新聊天室

本指南將說明如何在 Google Chat API 的 Space 資源上使用 patch() 方法更新聊天室。更新聊天室，變更聊天室的屬性，例如使用者可見的顯示名稱、說明和規範。

如果您是 Google Workspace 管理員，可以呼叫 patch() 方法，更新 Google Workspace 機構中的任何現有聊天室。

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

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

必要條件

Node.js

Python

Java

Apps Script

以使用者身分更新聊天室

如要透過使用者驗證更新 Google Chat 中的現有聊天室，請在要求中傳遞下列資訊：

  • 指定 chat.spaces 授權範圍。
  • 呼叫 UpdateSpace() 方法。在要求中，您可以指定空間 name 欄位、包含一或多個要更新的欄位的 updateMask 欄位，以及包含更新後空間資訊的 body。

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

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

Node.js

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

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

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

  // Initialize request argument(s)
  const request = {
    space: {
      // Replace SPACE_NAME here
      name: 'spaces/SPACE_NAME',
      displayName: 'New space display name'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['display_name']
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/update_space_user_cred.py
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"]

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

    # Initialize request argument(s)
    request = google_chat.UpdateSpaceRequest(
        space = {
            # Replace SPACE_NAME here
            'name': 'spaces/SPACE_NAME',
            'display_name': 'New space display name'
        },
        # The field paths to update. Separate multiple values with commas.
        update_mask = 'displayName'
    )

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

    # Handle the response
    print(response)

update_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateSpaceRequest;
import com.google.chat.v1.Space;
import com.google.protobuf.FieldMask;

// This sample shows how to update space with user credential.
public class UpdateSpaceUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateSpaceRequest.Builder request = UpdateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          // Replace SPACE_NAME here.
          .setName("spaces/SPACE_NAME")
          .setDisplayName("New space display name"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("display_name"));
      Space response = chatServiceClient.updateSpace(request.build());

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to update a space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces'
 * referenced in the manifest file (appsscript.json).
 */
function updateSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = 'spaces/SPACE_NAME';
  const space = {
    displayName: 'New space display name'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'displayName';

  // Make the request
  const response = Chat.Spaces.patch(space, name, {
    updateMask: updateMask
  });

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

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

Google Chat API 會傳回反映更新內容的 Space 例項。

以 Google Workspace 管理員身分更新聊天室

如果您是 Google Workspace 管理員，可以呼叫 UpdateSpace() 方法，更新 Google Workspace 機構中的任何空間。

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

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

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

將聊天室更新為 Chat 應用程式

應用程式驗證功能需要一次性的管理員核准。

如要使用應用程式驗證更新 Google Chat 中的現有聊天室，請在要求中傳遞下列資訊：

  • 指定 chat.app.spaces 授權範圍。透過應用程式驗證，您只能更新 Chat 應用程式建立的聊天室。
  • 呼叫 Space 資源上的 patch 方法。在要求中，您可以指定空間 name 欄位、包含一或多個要更新的欄位的 updateMask 欄位，以及包含更新後空間資訊的 body。

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

建立 API 金鑰

如要呼叫開發人員預覽版 API 方法，您必須使用 API 探索文件的非公開開發人員預覽版。您必須傳送 API 金鑰，才能驗證要求。

如要建立 API 金鑰，請開啟應用程式的 Google Cloud 專案，然後執行下列操作：

  1. 在 Google Cloud 控制台中，依序前往「Menu」(選單) >「APIs & Services」(API 和服務) >「Credentials」(憑證)。

    前往「憑證」

  2. 依序按一下「建立憑證」>「API 金鑰」。
  3. 系統會顯示新的 API 金鑰。
    • 按一下「複製」 即可複製 API 金鑰，以便在應用程式程式碼中使用。您也可以在專案憑證的「API 金鑰」部分找到 API 金鑰。
    • 按一下「限制金鑰」，即可更新進階設定並限制 API 金鑰的使用情形。詳情請參閱「套用 API 金鑰限制」。

編寫呼叫 Chat API 的指令碼

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

Python

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

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

    from google.oauth2 import service_account
from apiclient.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.app.spaces"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates the specified space description and guidelines.
    '''

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

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # 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. 在程式碼中，請替換下列內容：

    • API_KEY：您為建構 Chat API 服務端點而建立的 API 金鑰。
    • SPACE 搭配聊天室名稱，您可以透過 Chat API 中的 spaces.list 方法或聊天室網址取得這項資訊。

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

    python3 chat_space_update_app.py

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