このページは Cloud Translation API によって翻訳されました。

Google Chat アプリにアプリのホームカードメッセージを送信する

このページでは、Chat アプリのアプリのホームカードメッセージを作成して送信する方法について説明します。アプリのホームは、ユーザーが Chat アプリでダイレクトメッセージを開いたときに、Chat アプリから送信されるカスタマイズ可能なカードメッセージです。

2 つのメッセージが表示されているアプリのホームカード。

たとえば、スラッシュコマンドを使用して Chat アプリを操作するためのヒントが含まれるように、アプリのホームカードメッセージを構成できます。エンドユーザーに対しては、アプリデベロッパーがこの機能を有効にした場合にのみ、Chat アプリのダイレクトメッセージでアプリホームを使用できます。

カードビルダーを使用して、Chat アプリ用の JSON カードメッセージを設計し、プレビューします。

カードビルダーを開く

前提条件

Python

Google Chat へのアクセス権を持つ Google Workspace アカウント。
公開されている Chat アプリ。Chat アプリを作成するには、このquickstartをご覧ください。
インタラクティビティ用に構成された Google Chat アプリ。詳細については、インタラクションイベントを受信するように Google Chat アプリを構成するをご覧ください。

Apps Script

Google Chat へのアクセス権を持つ Google Workspace アカウント。
公開されている Chat アプリ。Chat アプリを作成するには、このquickstartの手順に沿ってください。
インタラクティビティ用に構成された Google Chat アプリ。詳細については、インタラクションイベントを受信するように Google Chat アプリを構成するをご覧ください。

Google Cloud コンソールで構成する

Python

Google Cloud コンソールで、メニュー アイコン > [その他のプロダクト] > [Google Workspace] > [プロダクトライブラリ] > [Google Chat API] に移動します。

Google Chat API に移動
[Manage] をクリックし、[Configuration] タブをクリックします。
[Support App Home] を有効にします。
[Support App Home] チェックボックスをオンにします。
[App Home URL] フィールドに URL を追加します。この値は通常、[アプリの URL] と同じ URL です。この URL は APP_HOME イベントで呼び出されます。
[保存] をクリックします。

Apps Script

Google Cloud コンソールで、メニュー アイコン > [その他のプロダクト] > [Google Workspace] > [プロダクトライブラリ] > [Google Chat API] に移動します。

Google Chat API に移動
[Manage] をクリックし、[Configuration] タブをクリックします。
[Support App Home] チェックボックスをオンにします。
[保存] をクリックします。

チャットアプリを構成する

アプリのホームに新しいカードメッセージを送信するように Chat アプリを構成します。

Python

ユーザーが Chat アプリからダイレクトメッセージを開くと、APP_HOME イベントが Chat アプリに送信されます。Chat アプリがこのイベントを受信すると、pushCard ナビゲーションとともに RenderActions の JSON インスタンスが返されます。

@app.route('/', methods=['POST'])
def on_event():
  event = request.get_json()
  chat = event.get('chat')
  if chat is not None:
    return handle_chat_event(event)

def handle_chat_event(event):
  if event['chat'].get('type') == 'APP_HOME':
    return get_app_home_card()

def get_app_home_card():
  return {
    "action": {
      "navigations": [
        {
          "pushCard": {
            "sections": [
              {
                "widgets": [
                  {
                    "buttonList": {
                      "buttons": [
                        {
                          "text": "Open documentation",
                          "onClick": {
                            "openLink": {
                              "url": "https://developers.google.com/chat"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  }

Apps Script

この例では、カード JSON を返してカードメッセージを送信します。Apps Script カードサービスを使用することもできます。

pushCard ナビゲーションを使用して RenderActions の JSON インスタンスを返す onAppHome 関数を実装します。

// "onAppHome" is the pre-defined name of the callback that the Chat servers
// execute.
function onAppHome() {
  return {
    action: {
      navigations: [
        {
          pushCard: getCard()
        }
      ]
    }
  };
}

function getCard() {
  return {
    sections: [
      {
        widgets: [
          {
            buttonList: {
              buttons: [
                {
                  text: "Open documentation",
                  onClick: {
                    openLink: {
                      url: "https://developers.google.com/chat"
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  };
}

アプリのホームカードメッセージを更新する

アプリのホームカードメッセージは、ユーザーがカードメッセージで情報を送信したとき、またはダイアログを閉じたときに更新できます。たとえば、アプリの最初のホームカードメッセージは、ユーザーにフォームに記入するよう求めるウェルカムメッセージです。ユーザーがフォームに入力すると、更新されたアプリのホームカードメッセージが送信されます。アップデートは、updateCard ナビゲーションを含む RenderActions のインスタンスとともに返す必要があります。

Python

HTTP アプリの場合、アプリのホームカードメッセージの更新はユーザーが入力したプロセス情報と似ていますが、RenderActions を返す必要があります。invokedFunction は、Card ウィジェットに関連付けられている、呼び出される関数の名前を表します。詳細については、CommonEventObject をご覧ください。次の例の submitForm は、ユーザーがフォームデータを送信したことを示しています。

@app.route('/', methods=['POST'])
def on_event():
  event = request.get_json()
  chat = event.get('chat')
  if chat is not None:
    return handle_chat_event(event)

def handle_chat_event(event):
  if event['chat'].get('type') == 'SUBMIT_FORM':
    event_object = event.get('commonEventObject')
    if event_object is not None:
      // Forms
      if 'submitForm' == event_object.get('invokedFunction'):
        return {
          'render_actions': {
            'action': {
              'navigations': [{
                'updateCard': get_update_card()
              }]
            }
          }
        }

def get_update_card():
  return {
      "action": {
          "navigations": [{
              "pushCard": {
                  "sections": [{
                      "widgets": [{
                          "buttonList": {
                              "buttons": [{
                                  "text": "Open documentation",
                                  "onClick": {
                                      "openLink": {
                                          "url": "https://developers.google.com/chat"
                                      }
                                  },
                              }]
                          }
                      }]
                  }]
              }
          }]
      }
  }

Apps Script

この例では、カード JSON を返してカードメッセージを送信します。Apps Script カードサービスを使用することもできます。

// Called from elsewhere (i.e. on button press).
function updateAppHomeCard(event) {
  return {
    render_actions: {
      action: {
        navigations: [
          {
            updateCard: getCard()
          }
        ]
      }
    }
  }
}

function getCard() {
  return {
    sections: [
      {
        widgets: [
          {
            buttonList: {
              buttons: [
                {
                  text: "Open documentation",
                  onClick: {
                    openLink: {
                      url: "https://developers.google.com/chat"
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  };
}

制限事項

一般に、navigation は Chat アプリでは使用できません。積み重なったカードを返却することはできません。 Chat アプリでは、pushCard（初回レスポンス用）と updateCard（アップデート用）のみを使用できます。

ダイアログを開くには、OPEN_DIALOG インタラクションを使用します。詳細については、アプリのホームカードメッセージに応じてダイアログを開くをご覧ください。
ダイアログを閉じるには、CLOSE_DIALOG インタラクションを使用してダイアログを閉じて、アプリのホームカードメッセージに戻るか、CLOSE_DIALOG_EXECUTE インタラクションを使用してダイアログを閉じて、アプリのホームカードメッセージを更新します。詳細については、アプリのホームカードメッセージのダイアログに応答するをご覧ください。

Google Chat アプリにアプリのホームカード メッセージを送信する

前提条件

Python

Apps Script

Google Cloud コンソールで構成する

Python

Apps Script

チャットアプリを構成する

Python

Apps Script

アプリのホームカード メッセージを更新する

Python

Apps Script

制限事項

関連トピック

Google Chat アプリにアプリのホームカードメッセージを送信する

アプリのホームカードメッセージを更新する