Cập nhật không gian

Hướng dẫn này giải thích cách sử dụng phương thức patch trên tài nguyên Space của API Google Chat để cập nhật một không gian. Cập nhật một không gian để thay đổi các thuộc tính của một không gian, chẳng hạn như tên hiển thị mà người dùng nhìn thấy, nội dung mô tả và nguyên tắc của không gian đó.

Tài nguyên Space đại diện cho nơi mọi người và các ứng dụng trong Chat có thể gửi tin nhắn, chia sẻ tệp và cộng tác. Có một số loại không gian:

  • Tin nhắn trực tiếp (DM) là các cuộc trò chuyện giữa hai người dùng hoặc một người dùng và một ứng dụng trong Chat.
  • Cuộc trò chuyện nhóm là cuộc trò chuyện giữa ba người dùng trở lên và các ứng dụng Chat.
  • Không gian được đặt tên là những địa điểm cố định nơi mọi người gửi tin nhắn, chia sẻ tệp và cộng tác.

Điều kiện tiên quyết

Python

  • Python 3.6 trở lên
  • Công cụ quản lý gói pip

  • Các thư viện ứng dụng mới nhất của Google dành cho Python. Để cài đặt hoặc cập nhật các trình mô phỏng, hãy chạy lệnh sau trong giao diện dòng lệnh:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Một dự án trên Google Cloud đã bật và định cấu hình API Google Chat. Để biết các bước, hãy xem bài viết Tạo ứng dụng Google Chat.

  • Đã định cấu hình uỷ quyền cho ứng dụng Chat. Để cập nhật không gian, bạn cần phải Xác thực người dùng với phạm vi uỷ quyền chat.spaces.

Node.js

  • Node.js và npm

  • Các thư viện ứng dụng mới nhất của Google dành cho Node.js. Để cài đặt các trình xử lý sự kiện đó, hãy chạy lệnh sau trong giao diện dòng lệnh:

    npm install @google-cloud/local-auth @googleapis/chat
  • Một dự án trên Google Cloud đã bật và định cấu hình API Google Chat. Để biết các bước, hãy xem bài viết Tạo ứng dụng Google Chat.

  • Đã định cấu hình uỷ quyền cho ứng dụng Chat. Để cập nhật không gian, bạn cần phải Xác thực người dùng với phạm vi uỷ quyền chat.spaces.

Cập nhật không gian

Để cập nhật một không gian hiện có trong Google Chat, hãy chuyển những nội dung sau vào yêu cầu:

  • Chỉ định phạm vi uỷ quyền chat.spaces.
  • Gọi phương thức patch trên tài nguyên Space. Trong yêu cầu, bạn chỉ định trường name của không gian, trường updateMask có một hoặc nhiều trường cần cập nhật và body với thông tin không gian đã cập nhật.

Bạn có thể cập nhật những thông tin như tên hiển thị, loại không gian, trạng thái nhật ký và nhiều thông tin khác. Để xem tất cả các trường mà bạn có thể cập nhật, hãy xem tài liệu tham khảo.

Dưới đây là cách cập nhật trường spaceDetails của một không gian hiện có:

Python

  1. Trong thư mục đang làm việc, hãy tạo một tệp có tên chat_space_update.py.

  2. Đưa mã sau vào 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. Trong đoạn mã, hãy thay thế SPACE bằng tên không gian mà bạn có thể lấy từ phương thức spaces.list trong API Chat hoặc từ URL của không gian.

  4. Trong thư mục đang làm việc, hãy tạo và chạy mẫu:

    python3 chat_space_update.py

Node.js

  1. Trong thư mục đang làm việc, hãy tạo một tệp có tên update-space.js.

  2. Đưa mã sau vào 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. Trong đoạn mã, hãy thay thế SPACE bằng tên không gian mà bạn có thể lấy từ phương thức spaces.list trong API Chat hoặc từ URL của không gian.

  4. Trong thư mục đang làm việc, hãy chạy mẫu:

    node update-space.js

API Google Chat trả về một thực thể của tài nguyên Space phản ánh nội dung cập nhật.