本指南介绍了如何在 Google Chat API 的 Reaction
资源中使用 list
方法列出对消息的回应,例如 👍?、🚲? 和 🌞?。
Reaction
资源表示用户可以用来回应消息的表情符号,例如 👍?、🚲? 和 🌞?。
前提条件
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.messages.reactions.readonly
、chat.messages.reactions
、chat.messages.readonly
或chat.messages
授权范围进行用户身份验证。
列出回应
要列出对消息的回应,请在请求中传递以下内容:
- 请指定
chat.messages.reactions.readonly
、chat.messages.reactions
、chat.messages.readonly
或chat.messages
授权范围。 - 对
Reaction
资源调用 [list
方法]/workspace(/chat/api/reference/rest/v1/spaces.messages.reactions/list)。
以下示例列出了对指定消息的回应:
Python
- 在您的工作目录中,创建一个名为
chat_reactions_list.py
的文件。 在
chat_reactions_list.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.reactions.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists reactions to 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().reactions().list( # The message to list reactions to. # # 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. parent = 'spaces/SPACE/messages/MESSAGE' ).execute() # Prints details about the created reactions. print(result) if __name__ == '__main__': main()
在代码中,替换以下内容:
SPACE
:聊天室名称,可通过 Chat API 中的spaces.list
方法或聊天室网址获取。MESSAGE
:消息名称,您可以从通过 Chat API 异步创建消息后返回的响应正文中获取,也可以使用在创建消息时分配给该消息的自定义名称获取。
在您的工作目录中,构建并运行示例:
python3 chat_reactions_list.py
Chat API 会返回一个分页的回应数组。