本指南說明如何針對 Google Chat API 的 Reaction
資源使用 create
方法,為訊息新增回應 (例如 👍?、🚲? and Settings)。
Reaction
資源代表一種表情符號,供使用者用來回應訊息,例如 👍?、🚲?
和 ⌃。
必要條件
Python
- Python 3.6 以上版本
- pip 套件管理工具
最新的 Python 專用 Google 用戶端程式庫。如要安裝或更新,請在指令列介面中執行下列指令:
pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client
已發布的 Chat 應用程式。如要建立及發布 Chat 應用程式,請參閱「建構 Google Chat 應用程式」。
已設定 Chat 應用程式的授權。如要建立回應,您需要使用
chat.messages.reactions.create
、chat.messages.reactions
或chat.messages
授權範圍的使用者驗證。
在訊息中加入回應
如要建立訊息回應,請在要求中傳遞以下內容:
- 指定
chat.messages.reactions.create
、chat.messages.reactions
或chat.messages
授權範圍。 - 呼叫
Reaction
資源上的create
方法。 - 將
parent
設為要回應訊息的資源名稱。 - 將
body
(要求主體) 設為Reaction
的執行個體,其中unicode
欄位是由萬國碼 (Unicode) 字串表示的標準表情符號。
以下範例會使用 😀? 表情符號回應訊息:
Python
- 在工作目錄中,建立名為
chat_reaction_create.py
的檔案。 在
chat_reaction_create.py
中加入下列程式碼:import os.path from google.auth.transport.requests import Request from google.oauth2.credentials import Credentials from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.errors import HttpError # 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.create"] def main(): ''' Authenticates with Chat API via user credentials, then creates a reaction 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().create( # The message to create a reaction 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', # The reaction to the message. body = { 'emoji': { # A standard emoji represented by a unicode string. 'unicode': '😀' } } ).execute() # Prints details about the created reaction. print(result) if __name__ == '__main__': main()
在程式碼中,替換以下內容:
SPACE
:張貼訊息的聊天室name
,您可以透過 Chat API 的spaces.list
方法或聊天室網址取得。MESSAGE
:訊息名稱,您可以在使用 Chat API 以非同步方式建立訊息後,從傳回的回應主體中取得,或在建立訊息時指派給訊息的自訂名稱。
在工作目錄中建構並執行範例:
python3 chat_reaction_create.py
Chat API 會傳回 Reaction
的執行個體,詳細說明建立的回應。