使用 Google Chat API 傳送訊息

Python

• 企業或企業 具有存取權的 Google Workspace 帳戶 Google Chat。

• Python 3.6 以上版本
• pip 套件管理工具
• 最新的 Google 用戶端程式庫。安裝或更新 在指令列介面中執行下列指令：

  pip3 install --upgrade google-api-python-client google-auth-oauthlib
  

• 設定環境：
  • 建立 Google Cloud 專案。
  • 設定 OAuth 同意畫面。
  • 啟用並設定 Google Chat API。 圖示和說明
  • 根據您要在 Google Chat API 中驗證的方式建立存取憑證 要求：
    • 如要以 Chat 使用者的身分進行驗證， 建立 OAuth 用戶端 ID 憑證，並將憑證儲存為 JSON 檔案 client_secrets.json 至本機目錄。
    • 如要以 Chat 應用程式的身分進行驗證， 建立服務帳戶 憑證，並將憑證儲存為 JSON 檔案 credentials.json。
• 根據你要以使用者或使用者身分驗證選擇授權範圍 Chat 應用程式。

• 通過驗證的 Google Chat 聊天室 撥打的即時通訊應用程式為成員。如要以 即時通訊應用程式，新增 Chat 擴充應用程式至聊天室。

Python

1. 在工作目錄中，建立名為 chat_create_message_user.py。

2. 在 chat_create_message_user.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.create"]
   
   def main():
       '''
       Authenticates with Chat API via user credentials,
       then creates a text message in a Chat space.
       '''
   
       # Start with no credentials.
       creds = None
   
       # 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().create(
   
           # The space to create the message in.
           #
           # Replace SPACE with a space name.
           # Obtain the space name from the spaces resource of Chat API,
           # or from a space's URL.
           parent='spaces/SPACE',
   
           # Optional. Sets custom ID for the message to use in other requests.
           messageId='client-myfirstusermessage',
   
           # The text message to create.
           body={
             'text': '👋 🌎Hello world! Text messages can contain things like:\n\n'
   
             + '* Hyperlinks 🔗\n'
             + '* Emojis 😄🎉\n'
             + '* Mentions of other Chat users `@` \n\n'
   
             'For details, see the <https://developers.google.com/workspace/chat/format-messages|Chat API developer documentation>.'
         }
   
       ).execute()
   
       # Prints details about the created message.
       print(result)
   
   if __name__ == '__main__':
       main()
   

   將 SPACE 替換為聊天室的 ID name ] 欄位。您可以呼叫 spaces.list() 方法 或從聊天室網址複製

3. 在工作目錄中建構並執行範例：

   python3 chat_create_message_user.py
   

4. 如果系統提示您輸入網址，請開啟該網址進行授權。 根據您在 請求。

Python

1. 在工作目錄中，建立名為 chat_create_message_app.py。

2. 在 chat_create_message_app.py 中加入下列程式碼：

   from apiclient.discovery import build
   from google.oauth2 import service_account
   
   # 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', scopes=SCOPES)
   
   # Build the URI and authenticate with the service account.
   chat = build('chat', 'v1', credentials=CREDENTIALS)
   
   # Specify the Chat space where the message is posted. Obtain the ID
   # from the resource name, or from the space's URL.
   SPACE = 'spaces/SPACE'
   
   # Create a Chat message.
   result = chat.spaces().messages().create(
   
       # The Chat space.
       parent=SPACE,
   
       # Optional. Sets custom ID for the message to use in other requests.
       messageId='client-myfirstappmessage',
   
       # The message to create with text, a card, and a button at the
       # bottom of the message.
       body=
       {
         'text': '👋 🌎Hello world! I created this message by calling the Chat API\'s `messages.create()` method.',
         'cardsV2': [{
           'cardId': 'myCardId',
           'card': {
             'header': {
               'title': 'About this message',
               'imageUrl': 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg',
               'imageType': 'CIRCLE'
             },
           "sections": [
               {
               "header": "Contents",
               "widgets": [
                   {
                   "textParagraph": {
                       "text": "🔡 <b>Text</b> which can include hyperlinks 🔗, emojis 😄🎉, and @mentions 🗣️."
                   }},
                   {
                   "textParagraph": {
                       "text": "🖼️ A <b>card</b> to display visual elements and request information such as text 🔤, dates and times 📅, and selections ☑️."
                   }},
                   {
                   "textParagraph": {
                       "text": "👉🔘 An <b>accessory widget</b> which adds a button to the bottom of a message."
                   }},
                 ]
               },
               {
               "header": "What's next",
               "collapsible": True,
               "widgets": [
                   {
                   "textParagraph": {
                       "text": "❤️ <a href='https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions/create'>Add a reaction</a>."
                   }},
                   {
                   "textParagraph": {
                       "text": "🔄 <a href='https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/patch'>Update</a> or ❌ <a href='https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/delete'>delete</a> the message."
                   }},
                   {
                   "textParagraph": {
                       "text": '💡 <b>Pro tip</b>: To specify the message in other API requests, use its custom name: <i>' + SPACE + '/messages/client-myfirstappmessage</i>.'
                   }}
                 ]
               }
             ]}
         }],
         "accessoryWidgets":
         [
             {
                 "buttonList":
                 {
                     "buttons":
                     [
                         {
                             "text": "View documentation",
                             "altText": "Opens a new browser tab and navigates to the Google Chat developer documentation website.",
                             "icon":
                             {
                                 "material_icon":
                                 {
                                     "name": "link"
                                 }
                             },
                             "onClick":
                             {
                                 "openLink":
                                 {
                                     "url": "https://developers.google.com/workspace/chat/create-messages"
                                 }
                             }
                         }
                     ]
                 }
             }
         ]
       }
   
   ).execute()
   
   print(result)
   

   將 SPACE 替換為聊天室的 ID name ] 欄位。您可以呼叫 spaces.list() 方法 或從聊天室網址複製

3. 在工作目錄中建構並執行範例：

   python3 chat_create_message_app.py