本指南說明如何在 Google Chat API 的 Reaction
資源上使用 list
方法,列出訊息的回應,例如 👍、🚲 和 🌞。
Reaction
項資源
所代表的表情符號,例如 👍?、🚲?
和 CANNOT TRANSLATE
必要條件
Python
- 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。
- 設定環境:
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API。 圖示和說明
- 安裝 Python Google API 用戶端程式庫。
-
為電腦版應用程式建立 OAuth 用戶端 ID 憑證。如要在此程式中執行
指引,將憑證儲存為名為
client_secrets.json
的 JSON 檔案,並儲存至 本機目錄
- 選擇支援使用者驗證的授權範圍。
列出回應
如要列出訊息的回應,請在要求中傳遞以下內容:
- 指定
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 會傳回回應的分頁陣列。