メッセージを送信する

Node.js

• Google Workspace アクセス権があるアカウント Google Chat。
• Google Chat API が有効で構成されている Google Cloud プロジェクト。手順については、以下をご覧ください。 Google Chat アプリを作成します。
• Chat 用アプリに送信するための承認が構成されました 非同期メッセージです。送信に認証構成は必要ありません リアルタイムで会話できます。
  • メッセージを送信しています。 テキスト メッセージ は次の両方の認証方法をサポートしています。 <ph type="x-smartling-placeholder">
    </ph>
    • ユーザー認証 chat.messages.create または chat.messages 承認を使用する あります。
    • アプリの認証 （chat.bot 承認スコープ）。
  • メッセージを送信しています。 カード メッセージ 必要 アプリの認証 （chat.bot 承認スコープ）。

Python

• Google Workspace アクセス権があるアカウント Google Chat。
• Python 3.6 以降
• pip パッケージ管理ツール

• 最新の Python 用 Google クライアント ライブラリ。インストールまたは更新する手順は次のとおりです。 コマンドライン インターフェースで次のコマンドを実行します。

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

• Google Chat API が有効で構成されている Google Cloud プロジェクト。手順については、以下をご覧ください。 Google Chat アプリを作成します。

• Chat 用アプリに送信するための承認が構成されました 非同期メッセージです。送信に認証構成は必要ありません リアルタイムで会話できます。

  • メッセージを送信しています。 テキスト メッセージ は次の両方の認証方法をサポートしています。 <ph type="x-smartling-placeholder">
    </ph>
    • ユーザー認証 chat.messages.create または chat.messages 承認を使用する あります。
    • アプリの認証 （chat.bot 承認スコープ）。
  • メッセージを送信しています。 カード メッセージ 必要 アプリの認証 （chat.bot 承認スコープ）。

Apps Script

• Google Workspace アクセス権があるアカウント Google Chat。
• 公開されている Chat アプリ。独自の Chat アプリについては、 クイックスタート。
• Chat 用アプリに送信するための承認が構成されました 非同期メッセージです。送信に認証構成は必要ありません リアルタイムで会話できます。
  • メッセージを送信しています。 テキスト メッセージ は次の両方の認証方法をサポートしています。 <ph type="x-smartling-placeholder">
    </ph>
    • ユーザー認証 chat.messages.create または chat.messages 承認を使用する あります。
    • アプリの認証 （chat.bot 承認スコープ）。
  • メッセージを送信しています。 カード メッセージ 必要 アプリの認証 （chat.bot 承認スコープ）。

Node.js

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app. An onboarding message that
 * introduces the app and helps people get started with it.
 */
exports.onMessage = function onMessage(req, res) {
  if (req.method === 'GET' || !req.body.message) {
    res.send(
      'Hello! This function is meant to be used in a Google Chat space.');
  }

  // Send an onboarding message when added to a Chat space
  if (req.body.type === 'ADDED_TO_SPACE') {
    res.json({
      'text': 'Hi, Cymbal at your service. I help you manage your calendar
      from Google Chat. Take a look at your schedule today by typing
      `/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To
      learn what else I can do, type `/help`.'
    });
  }
};

Apps Script

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app. An onboarding message that
 * introduces the app and helps people get started with it.
 */
function onAddToSpace(event) {

  return {
    'text': 'Hi, Cymbal at your service. I help you manage your calendar
    from Google Chat. Take a look at your schedule today by typing
    `/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To learn
    what else I can do, type `/help`.'
  }
}

Python

1. 作業ディレクトリに、先ほど作成した chat_create_text_message_app.py。

2. chat_create_text_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)
   
   # Create a Chat message.
   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',
   
       # The message to create.
       body={'text': 'Hello, world!'}
   
   ).execute()
   
   print(result)
   

3. コードで SPACE をスペース名に置き換えます。スペースには こちらの spaces.list() メソッド スペースの URL から取得できます。

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

   python3 chat_create_text_message_app.py
   

Python

1. 作業ディレクトリに、先ほど作成した chat_create_text_message_user.py。

2. chat_create_text_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',
   
           # The message to create.
           body={'text': 'Hello, world!'}
   
       ).execute()
   
       # Prints details about the created message.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. コードで SPACE をスペース名に置き換えます。スペースには こちらの spaces.list() メソッド スペースの URL から取得できます。

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

   python3 chat_create_text_message_user.py
   

Node.js

/**
 * Google Cloud Function that responds to messages sent from a
 * Google Chat room.
 *
 * @param {Object} req Request sent from Google Chat room
 * @param {Object} res Response to send back
 */
exports.helloChat = function helloChat(req, res) {
  if (req.method === 'GET' || !req.body.message) {
    res.send('Hello! This function is meant to be used in a Google Chat '  
      'Room.');
  }

  const sender = req.body.message.sender.displayName;
  const image = req.body.message.sender.avatarUrl;

  const data = createMessage(sender, image);

  res.send(data);
};

/**
 * Creates a card with two widgets.
 * @param {string} displayName the sender's display name
 * @param {string} imageUrl the URL for the sender's avatar
 * @return {Object} a card with the user's avatar.
 */
function createMessage(displayName, imageUrl) {
  const cardHeader = {
    title: `Hello ${displayName}!`,
  };

  const avatarWidget = {
    textParagraph: {text: 'Your avatar picture: '},
  };

  const avatarImageWidget = {
    image: {imageUrl},
  };

  const avatarSection = {
    widgets: [
      avatarWidget,
      avatarImageWidget,
    ],
  };

  return {
    text: 'Here\'s your avatar',
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: cardHeader,
        sections: [avatarSection],
      }
    }],
  };
}

Python

from typing import Any, Mapping

import flask
import functions_framework


# Google Cloud Function that responds to messages sent in
# Google Chat.
#
# @param {Object} req Request sent from Google Chat.
# @param {Object} res Response to send back.
@functions_framework.http
def hello_chat(req: flask.Request) -> Mapping[str, Any]:
  if req.method == "GET":
    return "Hello! This function must be called from Google Chat."

  request_json = req.get_json(silent=True)

  display_name = request_json["message"]["sender"]["displayName"]
  avatar = request_json["message"]["sender"]["avatarUrl"]

  response = create_message(name=display_name, image_url=avatar)

  return response


# Creates a card with two widgets.
# @param {string} name the sender's display name.
# @param {string} image_url the URL for the sender's avatar.
# @return {Object} a card with the user's avatar.
def create_message(name: str, image_url: str) -> Mapping[str, Any]:
  avatar_image_widget = {"image": {"imageUrl": image_url}}
  avatar_text_widget = {"textParagraph": {"text": "Your avatar picture:"}}
  avatar_section = {"widgets": [avatar_text_widget, avatar_image_widget]}

  header = {"title": f"Hello {name}!"}

  cards = {
      "text": "Here's your avatar",
      "cardsV2": [
          {
              "cardId": "avatarCard",
              "card": {
                  "name": "Avatar Card",
                  "header": header,
                  "sections": [avatar_section],
              },
          }
      ]
  }

  return cards

Apps Script

この例では、メッセージにカード メッセージを送信する際に、 カード JSON。 また、 Apps Script カードサービス。

/**
 * Responds to a MESSAGE event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onMessage(event) {
  const displayName = event.message.sender.displayName;
  const avatarUrl = event.message.sender.avatarUrl;

  return createMessage(displayName, avatarUrl);
}

/**
 * Creates a card with two widgets.
 * @param {string} displayName the sender's display name
 * @param {string} avatarUrl the URL for the sender's avatar
 * @return {Object} a card with the sender's avatar.
 */
function createMessage(displayName, avatarUrl) {
  const cardHeader = {
    title: `Hello ${displayName}!`
  };

  const avatarWidget = {
    textParagraph: {text: 'Your avatar picture: '}
  };

  const avatarImageWidget = {
    image: {imageUrl: avatarUrl}
  };

  const avatarSection = {
    widgets: [
      avatarWidget,
      avatarImageWidget
    ],
  };

  return {
    text: 'Here\'s your avatar',
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: cardHeader,
        sections: [avatarSection],
      }
    }],
  };
}

Python

1. 作業ディレクトリに、先ほど作成した chat_create_card_message.py。

2. chat_create_card_message.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)
   
   # Create a Chat message.
   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',
   
       # The message to create.
       body=
       {
         'cardsV2': [{
           'cardId': 'createCardMessage',
           'card': {
             'header': {
               'title': 'A card message!',
               'subtitle': 'Created with the Chat API',
               'imageUrl': 'https://developers.google.com/chat/images/chat-product-icon.png',
               'imageType': 'CIRCLE'
             },
             'sections': [
               {
                 'widgets': [
                   {
                     'buttonList': {
                       'buttons': [
                         {
                           'text': 'Read the docs!',
                           'onClick': {
                             'openLink': {
                               'url': 'https://developers.google.com/chat'
                             }
                           }
                         }
                       ]
                     }
                   }
                 ]
               }
             ]
           }
         }]
       }
   
   ).execute()
   
   print(result)
   

3. コードで SPACE をスペース名に置き換えます。スペースには こちらの spaces.list メソッド スペースの URL から取得できます。

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

   python3 chat_create_card_message.py
   

Python

1. 作業ディレクトリに、先ほど作成した chat_create_message_thread.py。

2. chat_create_message_thread.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)
   
   # Create a Chat message.
   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',
   
       # Whether to start a thread or reply to an existing one.
       #
       # Required when threading is enabled in a space unless starting a
       # thread.  Ignored in other space types. Threading is enabled when
       # space.spaceThreadingState is THREADED_MESSAGES.
       #
       # REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD replies to an existing thread
       # if one exists, otherwise it starts a new one.
       messageReplyOption='REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD',
   
       # The message body.
       body={
   
           # The message to create.
           'text': 'Start or reply to another message in a thread!',
   
           # The thread to start or reply to.
           'thread': {
               'threadKey': 'nameOfThread'
           }
       }
   
   ).execute()
   
   print(result)
   

3. コードで SPACE をスペース名に置き換えます。スペースには こちらの spaces.list メソッド スペースの URL から取得できます。

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

   python3 chat_create_message_thread.py
   

Python

1. 作業ディレクトリに、先ほど作成した chat_create_named_message.py。

2. chat_create_named_message.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)
   
   # Create a Chat message with a custom name.
   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',
   
       # Custom name for the message used to facilitate later operations.
       messageId='client-NAME',
   
       # The message to create.
       body={'text': 'Hello, world!'}
   
   ).execute()
   
   print(result)
   

3. コードの次のように置き換えます。

   • SPACE: 追加するスペースの ID メッセージを投稿します。この情報は spaces.list メソッド スペースの URL から取得できます。
   • NAME: メッセージのカスタム名。

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

   python3 chat_create_named_message.py