カテゴリー: 技術系

Hangouts ChatのChat Botからのメッセージは、JSONオブジェクトで内容を記述して返す。

ポイントは、onMessage() で返す（return）内容を返すときに、return { “cards”: [ ここにJSON ]}; の形式で記述すること。

とくに、cardsのあとの[]の中にJSONオブジェクトでプロパティを記述することが重要。

サンプル

ユーザからのメッセージが届いたら、カード型メッセージで返信を返す。

/**
 * Responds to a MESSAGE event in Hangouts Chat.
 *
 * @param {Object} event the event object from Hangouts Chat
 *
 */
function onMessage(event) {

  return {

    "cards": [
      {
        "header": {
          "title": "タイトル（カード型のメッセージを返信する）",
          "subtitle": "サブタイトル（画像も表示させてみる）",
          "imageUrl": "https://goo.gl/yKKjbw",
          "imageStyle": "IMAGE"
        }
      }
    ]
  };

}

Hangouts ChatのChat Botが送信するメッセージの形式は、JSONオブジェクト。JSONオブジェクトとして、送信することで、Chat API側でテキストメッセージやカード形式のメッセージに変換されて表示される。

Hangouts Chatで、GASで作ったChat Botと会話するとき、Chat BotのGASプログラム側では”onMessage(event)”関数が呼び出されている。この関数の中で、ユーザからの送られてきたテキストの中身を処理することで、ユーザと様々なやり取りをすることができる。

function onMessage(event) {
  return { "text": "このメッセージをチャットで返す" };
}

ちなみに、ユーザ側が入力した内容は、`event.message.text`で取得することができる。

Hangouts Chatで、GASで作ったChat Botを呼び出すとき、関数のonAddToSpace(event)がHangouts Chat APIから呼び出される。このイベントが発生するのは、Chat Botを追加したときのみ。

function onAddToSpace(event) {
  return { "text": "このメッセージを返す" };
}

■Googleのサンプルプログラム。

function onAddToSpace(event) {
  var message = "";

  if (event.space.type == "DM") {
    message = "Thank you for adding me to a DM, " + event.user.displayName + "!";
  } else {
    message = "Thank you for adding me to " + event.space.displayName;
  }

  return { "text": message };
}

eventは、オブジェクトで、Hangouts Chatから渡される。このオブジェクトの中に、ユーザ名やDMかどうかなどの情報が入っている。

returnで指定した内容がユーザのチャットに返信される。

基本的に、開始から始まり、質問相手が質問をやめるまで、「進行」のステップが繰り返さされる。

開始：　ウェルカムメッセージ
↓
進行：　相手を次のステップに導く質問や回答。
↓
（ユーザからの応答）
↓
進行：　相手を次のステップに導く質問や回答。