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 membership
của API Google Chat để thay đổi các thuộc tính của một thành viên, chẳng hạn như thay đổi thành viên không gian thành người quản lý không gian hoặc thay đổi người quản lý không gian thành thành viên không gian.
Tài nguyên Membership
cho biết người dùng thực hoặc ứng dụng Google Chat được mời tham gia, tham gia hay không tham gia không gian.
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 công cụ này, hãy chạy lệnh sau trong giao diện dòng lệnh của bạn:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Một dự án trên Google Cloud đã bật và thiết lập API Google Chat. Để biết các bước, hãy xem bài viết Tạo ứng dụng Google Chat.
Việc uỷ quyền được định cấu hình cho ứng dụng Chat. Việc cập nhật gói thành viên yêu cầu Xác thực người dùng với phạm vi uỷ quyền
chat.memberships
hoặc nếu nhập dữ liệu vào Chat, thì phạm vi uỷ quyềnchat.import
.
Node.js
- Node.js và npm
Thư viện ứng dụng mới nhất của Google dành cho Node.js. Để cài đặt các công cụ này, hãy chạy lệnh sau trong giao diện dòng lệnh của bạn:
npm install @google-cloud/local-auth @googleapis/chat
- Một dự án trên Google Cloud đã bật và thiết lập API Google Chat. Để biết các bước, hãy xem bài viết Tạo ứng dụng Google Chat.
Việc uỷ quyền được định cấu hình cho ứng dụng Chat. Việc cập nhật gói thành viên yêu cầu Xác thực người dùng với phạm vi uỷ quyền
chat.memberships
hoặc nếu nhập dữ liệu vào Chat, thì phạm vi uỷ quyềnchat.import
.
Apps Script
- Một tài khoản Google Workspace có quyền truy cập vào Google Chat.
- Một ứng dụng Chat đã phát hành. Để tạo ứng dụng Chat, hãy làm theo phần quickstart này.
- Việc uỷ quyền được định cấu hình cho ứng dụng Chat. Việc cập nhật gói thành viên yêu cầu Xác thực người dùng với phạm vi uỷ quyền
chat.memberships
hoặc nếu nhập dữ liệu vào Chat, thì phạm vi uỷ quyềnchat.import
.
Cập nhật gói thành viên
Để cập nhật thành viên của không gian, hãy chuyển nội dung sau vào yêu cầu của bạn:
- Chỉ định phạm vi uỷ quyền
chat.memberships
. - Gọi phương thức
patch
trên tài nguyênMembership
và truyềnname
của thành viên cần cập nhật, cũng nhưupdateMask
vàbody
chỉ định các thuộc tính thành viên đã cập nhật. updateMask
chỉ định các khía cạnh cần cập nhật của gói thành viên và bao gồm những nội dung sau:role
: Vai trò của người dùng trong phòng Chat, xác định các hành động được phép thực hiện trong không gian đó. Các giá trị có thể sử dụng là:ROLE_MEMBER
: Một thành viên của không gian. Người dùng có các quyền cơ bản, chẳng hạn như gửi tin nhắn đến không gian. Trong các cuộc trò chuyện nhóm 1:1 và chưa đặt tên, mọi người đều có vai trò này.ROLE_MANAGER
: Người quản lý không gian. Người dùng có tất cả các quyền cơ bản, cùng với quyền quản trị cho phép họ quản lý không gian, chẳng hạn như thêm hoặc xoá thành viên. Chỉ được hỗ trợ trong những không gian cóspaceType
làSPACE
(không gian được đặt tên).
Đặt một thành viên thông thường trong không gian làm người quản lý không gian
Ví dụ sau đây đặt một thành viên thông thường trong không gian làm người quản lý không gian bằng cách chỉ định role
là ROLE_MANAGER
trong body
để chỉ định các thuộc tính thành viên mới cập nhật:
Python
- Trong thư mục đang làm việc, hãy tạo một tệp có tên
chat_membership_update.py
. Đưa mã sau vào
chat_membership_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.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then updates a specified space member to change it from a regular member to a space manager. ''' # 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().members().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MANAGER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
Trong mã, hãy thay thế các đoạn mã sau:
SPACE
: tên không gian mà bạn có thể lấy từ phương thứcspaces.list
trong API Chat hoặc từ URL của một không gian.MEMBERSHIP
: tên thành viên mà bạn có thể lấy từ phương thứcspaces.members.list
trong API Chat.
Trong thư mục đang làm việc, hãy tạo và chạy mẫu:
python3 chat_membership_update.py
Node.js
- Trong thư mục đang làm việc, hãy tạo một tệp có tên
chat_membership_update.js
. Đưa mã sau vào
chat_membership_update.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a membership in a Chat space to change it from * a space member to a space manager. * @return {!Promise<!Object>} */ async function updateSpace() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.memberships', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); /** * Build a service endpoint for Chat API. */ const chatClient = await chat.chat({version: 'v1', auth: authClient}); /** * Use the service endpoint to call Chat API. */ return await chatClient.spaces.patch({ /** * The membership to update, and the updated role. * * Replace SPACE with a space name. * Obtain the space name from the spaces resource of Chat API, * or from a space's URL. * * Replace MEMBERSHIP with a membership name. * Obtain the membership name from the membership of Chat API. */ name: 'spaces/SPACE/members/MEMBERSHIP', updateMask: 'role', requestBody: { role: 'ROLE_MANAGER' } }); } /** * Use the service endpoint to call Chat API. */ updateSpace().then(console.log);
Trong mã, hãy thay thế các đoạn mã sau:
SPACE
: tên không gian mà bạn có thể lấy từ phương thứcspaces.list
trong API Chat hoặc từ URL của một không gian.MEMBERSHIP
: tên thành viên mà bạn có thể lấy từ phương thứcspaces.members.list
trong API Chat.
Trong thư mục đang làm việc, hãy tạo và chạy mẫu:
python3 chat_membership_update.js
Apps Script
Ví dụ này gọi API Chat bằng Dịch vụ trò chuyện nâng cao.
Thêm phạm vi uỷ quyền
chat.memberships
vào tệpappsscript.json
của dự án Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.memberships" ]
Thêm một hàm như hàm này vào mã của dự án Apps Script:
/** * Updates a membership from space member to space manager. * @param {string} memberName The resource name of the membership. */ function updateMembershipToSpaceManager(memberName) { try { const body = {'role': 'ROLE_MANAGER'}; Chat.Spaces.Members.patch(memberName, body); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to create message with error %s', err.message); } }
API Google Chat thay đổi thành viên đã chỉ định thành người quản lý không gian rồi trả về một thực thể của Membership
nêu chi tiết sự thay đổi đó.
Chỉ định người quản lý không gian làm thành viên thông thường
Ví dụ sau đây sẽ đặt người quản lý không gian trở thành thành viên thông thường của không gian bằng cách chỉ định role
là ROLE_MEMBER
trong body
để chỉ định các thuộc tính thành viên mới:
Python
- Trong thư mục đang làm việc, hãy tạo một tệp có tên
chat_membership_update.py
. Đưa mã sau vào
chat_membership_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.memberships"] def main(): ''' Authenticates with Chat API via user credentials, then updates a specified space member to change it from a regular member to a space manager. ''' # 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().members().patch( # The membership to update, and the updated role. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBERSHIP with a membership name. # Obtain the membership name from the membership of Chat API. name='spaces/SPACE/members/MEMBERSHIP', updateMask='role', body={'role': 'ROLE_MEMBER'} ).execute() # Prints details about the updated membership. print(result) if __name__ == '__main__': main()
Trong mã, hãy thay thế các đoạn mã sau:
SPACE
: tên không gian mà bạn có thể lấy từ phương thứcspaces.list
trong API Chat hoặc từ URL của một không gian.MEMBERSHIP
: tên thành viên mà bạn có thể lấy từ phương thứcspaces.members.list
trong API Chat.
Trong thư mục đang làm việc, hãy tạo và chạy mẫu:
python3 chat_membership_update.py
Node.js
- Trong thư mục đang làm việc, hãy tạo một tệp có tên
chat_membership_update.js
. Đưa mã sau vào
chat_membership_update.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a membership in a Chat space to change it from * a space manager to a space member. * @return {!Promise<!Object>} */ async function updateSpace() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.memberships', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); /** * Build a service endpoint for Chat API. */ const chatClient = await chat.chat({version: 'v1', auth: authClient}); /** * Use the service endpoint to call Chat API. */ return await chatClient.spaces.patch({ /** * The membership to update, and the updated role. * * Replace SPACE with a space name. * Obtain the space name from the spaces resource of Chat API, * or from a space's URL. * * Replace MEMBERSHIP with a membership name. * Obtain the membership name from the membership of Chat API. */ name: 'spaces/SPACE/members/MEMBERSHIP', updateMask: 'role', requestBody: { role: 'ROLE_MEMBER' } }); } /** * Use the service endpoint to call Chat API. */ updateSpace().then(console.log);
Trong mã, hãy thay thế các đoạn mã sau:
SPACE
: tên không gian mà bạn có thể lấy từ phương thứcspaces.list
trong API Chat hoặc từ URL của một không gian.MEMBERSHIP
: tên thành viên mà bạn có thể lấy từ phương thứcspaces.members.list
trong API Chat.
Trong thư mục đang làm việc, hãy tạo và chạy mẫu:
python3 chat_membership_update.js
Apps Script
Ví dụ này gọi API Chat bằng Dịch vụ trò chuyện nâng cao.
Thêm phạm vi uỷ quyền
chat.memberships
vào tệpappsscript.json
của dự án Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.memberships" ]
Thêm một hàm như hàm này vào mã của dự án Apps Script:
/** * Updates a membership from space manager to space member. * @param {string} memberName The resource name of the membership. */ function updateMembershipToSpaceMember(memberName) { try { const body = {'role': 'ROLE_MEMBER'}; Chat.Spaces.Members.patch(memberName, body); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to create message with error %s', err.message); } }
API Google Chat thay đổi thành viên đã chỉ định thành người quản lý không gian rồi trả về một thực thể của Membership
nêu chi tiết sự thay đổi đó.
Chủ đề có liên quan
- Mời hoặc thêm người dùng hay ứng dụng Google Chat vào không gian.
- Xem thông tin chi tiết về gói thành viên của người dùng hoặc ứng dụng Chat.
- Liệt kê thành viên trong một không gian.
- Xoá người dùng hoặc ứng dụng Chat khỏi một không gian.