Google Chat API を使用してメッセージを送信する

Python

• 企業または大企業 以下へのアクセス権を持つ Google Workspace アカウント Google Chat。

• Python 3.6 以降
• pip パッケージ管理ツール
• 最新の Google クライアント ライブラリ。インストールまたは更新する手順は次のとおりです。 コマンドライン インターフェースで次のコマンドを実行します。

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

• 環境を設定します。 <ph type="x-smartling-placeholder">
  </ph>
  • Google Cloud プロジェクトを作成します。
  • OAuth 同意画面を構成します。
  • Google Chat API を有効にして構成する。名前、 アプリのアイコン、説明を入力します。
  • Google Chat API での認証方法に基づいてアクセス認証情報を作成する request: <ph type="x-smartling-placeholder">
    </ph>
    • Chat ユーザーとして認証するには、 OAuth クライアント ID を作成する 認証情報を JSON ファイルとして保存し、 client_secrets.json をローカル ディレクトリに移動します。
    • Chat 用アプリとして認証するには、 サービス アカウントの作成 認証情報を JSON ファイルとして保存し、 credentials.json。
• <ph type="x-smartling-placeholder"></ph> ユーザーとして認証するか、ユーザーとして認証するかに基づいて、承認スコープを選択します。 Chat アプリ。

• 認証されたユーザーまたはスペースでやり取りされる Google Chat スペース 1 人です。ID プロバイダとして認証するには、 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 表示されます。ID を取得するには、 spaces.list() メソッド またはスペースの URL から取得できます。

3. 作業ディレクトリでサンプルをビルドして実行します。

   python3 chat_create_message_user.py
   

4. URL を求められたら、URL を開いて スペースで使用したスコープに基づいて リクエストできます。

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 表示されます。ID を取得するには、 spaces.list() メソッド またはスペースの URL から取得できます。

3. 作業ディレクトリでサンプルをビルドして実行します。

   python3 chat_create_message_app.py