Hướng dẫn này giải thích cách sử dụng phương thức get
trên tài nguyên Message
của
API Google Chat để trả về thông tin chi tiết về một tin nhắn văn bản hoặc tin nhắn dạng thẻ.
Trong API Chat, tin nhắn trong Chat được biểu thị bằng
Tài nguyên Message
.
Mặc dù người dùng Chat chỉ có thể gửi tin nhắn có chứa văn bản,
Các ứng dụng nhắn tin có thể dùng nhiều tính năng nhắn tin khác, bao gồm
hiển thị giao diện người dùng tĩnh hoặc tương tác, thu thập thông tin từ
và gửi thư một cách riêng tư. Để tìm hiểu thêm về tính năng nhắn tin
các tính năng dành cho API Chat, hãy xem
Tổng quan về tin nhắn trong Google Chat.
Điều kiện tiên quyết
Python
- Doanh nghiệp Tài khoản Google Workspace có quyền truy cập vào Google Chat.
- Thiết lập môi trường:
- Tạo một dự án trên Google Cloud.
- Định cấu hình màn hình xin phép bằng OAuth.
- Bật và định cấu hình API Google Chat bằng tên, biểu tượng và nội dung mô tả cho ứng dụng Chat.
- Cài đặt Python Thư viện ứng dụng API của Google.
- Tạo thông tin xác thực truy cập dựa trên cách bạn muốn xác thực trong API Google Chat
yêu cầu:
- Cách xác thực là người dùng Chat:
tạo mã ứng dụng OAuth
thông tin xác thực và lưu thông tin đăng nhập dưới dạng tệp JSON có tên
client_secrets.json
vào thư mục địa phương của bạn. - Cách xác thực là ứng dụng Chat:
tạo tài khoản dịch vụ
thông tin xác thực và lưu thông tin đăng nhập dưới dạng tệp JSON có tên
credentials.json
.
- Cách xác thực là người dùng Chat:
tạo mã ứng dụng OAuth
thông tin xác thực và lưu thông tin đăng nhập dưới dạng tệp JSON có tên
- Chọn phạm vi uỷ quyền dựa trên việc bạn muốn xác thực là người dùng hay Ứng dụng Chat.
Nhận thông báo xác thực người dùng
Để xem chi tiết về tin nhắn với xác thực người dùng, 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.messages.readonly
hoặcchat.messages
. - Gọi
Phương thức
get
trênMessage
tài nguyên. - Đặt
name
thành tên tài nguyên của thông báo cần nhận.
Ví dụ sau đây nhận được một thông báo có nội dung xác thực người dùng:
Python
- Trong thư mục đang làm việc, hãy tạo một tệp có tên
chat_message_get_user.py
. Đưa mã sau vào
chat_message_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.messages.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then gets a message. ''' # 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().messages().get( # The message 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. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name = 'spaces/SPACE/messages/MESSAGE' ).execute() # Prints details about the message. print(result) if __name__ == '__main__': main()
Trong mã, thay thế các nội dung sau:
SPACE
: tên không gian mà bạn có thể lấy từ thời gian Phương thứcspaces.list
trong API Chat hoặc qua URL của một không gian.MESSAGE
: tên thông báo mà bạn có thể lấy từ nội dung phản hồi được trả về sau khi tạo thông báo một cách không đồng bộ với API Chat hoặc bằng tên tuỳ chỉnh gán cho thư khi tạo.
Trong thư mục đang làm việc, hãy tạo và chạy mẫu:
python3 chat_message_get_user.py
API Chat trả về một phiên bản của
Message
nêu chi tiết thông báo được chỉ định.
Nhận tin nhắn qua quy trình xác thực ứng dụng
Để xem chi tiết về tin nhắn với xác thực ứng dụng, 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.bot
. - Gọi
Phương thức
get
trênMessage
tài nguyên. - Đặt
name
thành tên tài nguyên của thông báo cần nhận.
Ví dụ sau đây nhận được một thông báo có nội dung xác thực ứng dụng:
Python
- Trong thư mục đang làm việc, hãy tạo một tệp có tên
chat_get_message_app.py
. Đưa mã sau vào
chat_get_message_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) # Get a Chat message. result = chat.spaces().messages().get( # The message 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. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE' ).execute() # Print Chat API's response in your command line interface. print(result)
Trong mã, thay thế các nội dung sau:
SPACE
:name
của không gian nơi mà bạn có thể lấy từ thông báo phương thứcspaces.list
trong API Chat hoặc qua URL của một không gian.MESSAGE
: tên thông báo mà bạn có thể lấy từ nội dung phản hồi được trả về sau khi tạo thông báo một cách không đồng bộ với API Chat hoặc bằng tên tuỳ chỉnh gán cho thư khi tạo.
Trong thư mục đang làm việc, hãy tạo và chạy mẫu:
python3 chat_get_message_app.py
API Chat trả về một phiên bản của
Message
nêu chi tiết thông báo được chỉ định.