ボット作成入門として最適なエコーボットをGoogle Apps ScriptとLINEを使って無料で構築する手順

はじめに

今ではSlackやLINE、Facebookメッセンジャー、その他色々なチャットアプリでボットが使えるようになりました。またボットの構築に必要な情報も積極的に公開されている印象で、ボット構築のハードルもかなり低くなっていると思います。そこで今回日常的に使っていて身近なLINE用のボットをGoogle Apps Scriptを使って構築してみたのでその手順をメモします。なお、この記事ではEcho（エコー）ボット、すなわちオウム返しボットの作成手順をメモします。Echoとは、こだま、反響という意味の英単語です。Linuxを使用していると良くechoコマンドを使用すると思いますが、同じ意味です。このEchoボットを構築して基本を理解できれば、色々な応用ができ簡易予約システムを担うようなボットの構築もできると思います。

できるようになること

まずはじめに、構築するEchoボットの動作を以下のGIF画像で説明します。見てわかるとおり、LINEでボットに対し適当なメッセージを送信すると、投稿した内容をそのまま返してきます。

前提

以下が前提となります。

• LINEアカウントは取得済とする
• Gmailアカウントも取得済とする

基本的な流れ

• LINE Developersでの準備（LINE Developersへの登録、アクセストークンの取得など）
• GoogleスプレッドシートでGoogle Apps Scriptをウェブアプリケーションとして公開する
• LINE DevelopersでウェブアプリケーションのURLをWebhook URLとして登録する
LINEのDeveloper画面で、作成したボットアカウントの実体となるサーバのURLを登録する。ここでは、Google Apps Scriptを使用します。

LINE Developersでの準備

LINEのボットを作成するためには、LINE Developersにて開発者として登録し、各種設定を行う必要があります。この作業自体は難しくなく簡単です。以下に作業手順をまとめているのでまだ済んでいない方はよければ参考にして頂ければと思います。ここでは以下のまとめの内容がすでに完了済であるとします。

GoogleスプレッドシートでGoogle Apps Scriptをウェブアプリケーションとして公開する

Googleスプレッドシートを準備する

自身のGmailアカウントでGoogle Driveにログインし、Googleスプレッドシートを新規作成します。ここでは、適当にline botという名前のスプレッドシートを作成します。また、さらにdataとerrorという名前のシートを作成します。つまり以下のようなスプレッドシートを作成します。

作成したGoogleスプレッドシートのメニュー上の「ツール」→「スクリプトエディタ」をクリックしてエディタを開きます。

ここからボットの実体となるコードを書いていきます。冒頭に載せたGIF画像のように、ユーザの投稿メッセージと全く同じ内容をそのまま返信するボットを作成します。Echoボットを作成することでボットを構築する基本的な流れが理解できると思います。

EchoボットのGoogle Apps Scriptコード

// 取得したアクセストークン
var CHANNEL_ACCESS_TOKEN = "YOUR ACCESS TOKEN";

function doPost(e) {
  
  var content = JSON.parse(e.postData.contents);
  var strContent = JSON.stringify(e);
  var events = content['events'];

  var reply_token = events[0].replyToken;          // 返信用トークン
  var posted_msg  = events[0].message.text;    // ユーザが投稿したメッセージ
  var user_id     = events[0].source.userId;        // 投稿したユーザのID
  var group_id    = events[0].source.groupId;    // 投稿されたグループのID (グループチャットの場合のみ存在し、1:1チャットの場合はなし)
   
  // ユーザへの返信内容
  var postData = {
    "replyToken": reply_token,
    "messages": [{
      "type": "text",
      "text": "ユーザの投稿メッセージ：" + posted_msg // ユーザの投稿メッセージをそのまま返信する
    }]
  };
  
 // LINE指定の返信用URL
  var url = 'https://api.line.me/v2/bot/message/reply';
  
  var options = {
    'method': 'post',
    'headers': {
      'Content-Type': 'application/json; charset=UTF-8',
      'Authorization': 'Bearer ' + CHANNEL_ACCESS_TOKEN,
    },
    'payload': JSON.stringify(postData),
  };
  
  try{
    // UrlFetchApp.fetchでuserへの返信内容を送信する
    UrlFetchApp.fetch(url, options);
    
    // LINEから受け取った内容dataシートに記録しておく
    var logText = "Content :" + strContent;
    saveLog(logText, "data");
    
  } catch (err) {
    // エラー発生時はerrorシートに保存
    var logText = "Error :" + err.message;
    saveLog(logText, "error");
  }
}

function saveLog(text,sheetname) {
  var spreadsheetId = "YOUR SPREADSHEET ID";
  var spreadsheet = SpreadsheetApp.openById(spreadsheetId);
  var sheet = spreadsheet.getSheetByName(sheetname);
  sheet.appendRow([new Date(),text]);
}

上記のうち、各自で変更が必要となる箇所は１行目のvar CHANNEL_ACCESS_TOKEN = "YOUR ACCESS TOKEN";と、var spreadsheetId = "YOUR SPREADSHEET ID";の２箇所のみです。LINEのアクセストークンは実際には以下のようになります。以下はダミーのトークンですが、かなり長いトークンです。これはLINE Developersで発行されるトークンです。

var CHANNEL_ACCESS_TOKEN = "xoLuqoHisy9Jy09gebJdzGvJvR0P6Pl+61L7aPclveqiKp9Aj2Kn3mh3S3ApBiC388iKYiN+kDdA0E5MiqPe2CHEygIiYlfrtPiNNyM2lU3o0JMifybbkg+yAcHms1LlEeS0mB8PSTBiLAXnylTLLodB09t89+1P+o1cDnyilPU=";

また、スプレッドシートのIDは、デバッグや記録用に使います。スプレッドシートのIDの確認方法は以下に載せているので必要な方は見てみてください。 スプレッドシートID、シートIDの確認方法

上記コードをメニューにある「ファイル」→「保存」で保存します。保存したら、後はこのコードをウェブアプリケーションとして導入して公開します。

スクリプトをウェブアプリケーションとして導入、公開する手順

「ウェブアプリケーションとして導入...」をクリックすると、以下のようにいくつか設定項目が表示されます。ここで変更が必要となるのは、最後の「アプリケーションにアクセスできるユーザー」の項目です。ボットがアクセスできるようにここを以下のように「全員（匿名ユーザを含む）」に変更しておきます。変更後に「導入」ボタンをクリックします。

すると、以下のように「承認が必要です」と表示されるので、「許可を確認」をクリックします。

「次の許可をリクエストしています」と表示されるので、「許可」をクリックします。

以下のように「このプロジェクトをウェブアプリケーションとして導入しました」と表示され、「現在のウェブアプリケーションのURL」という項目があります。このURLをLINE Developersの設定画面内のWebhook URLに指定します。

以上でGoogle Apps Scriptの作業は完了です。最後にコピーした「現在のウェブアプリケーションのURL」をLINE DevelopersでウェブアプリケーションのURLをWehhook URLとして登録します。

LINE DevelopersでウェブアプリケーションのURLをWebhook URLとして登録する

LINE Developersの設定については以下にまとめているので必要な方は見てみて下さい。

LINEボット作成に必要な準備まとめ（アクセストークン取得、Webhook設定）

LINEボットを作成するには、はじめにLINE Developersという開発者向けページで準備をする必要があります。ここではLINEボットを作成するために最低限必要となるアクセストークンの取得と、Webhookの設定までをメモします。

www.virment.com

LINEからdoPost関数で受け取るデータの中身について

//doPostに飛んでくるデータの中身
{
    "parameter": {},
    "contextPath": "",
    "contentLength": 247,
    "queryString": "",
    "parameters": {},
    "postData": {
        "type": "application/json",
        "length": 247,
        "contents": "{
                "events":[
                 {
                    "type":"message",
                    "replyToken":"ffffff",
                    "source":{
                        "userId":"uuuuuuuu",
                        "type":"user"
                        },
                    "timestamp":1535258116133,
                    "message":{
                        "type":"text",
                        "id":"8979739584",
                        "text":"てすと"
                    }
                 }]
            }",
        "name": "postData"
    }
}
}

例えば、今回のEchoボットでは、以下のようにe.postData.conetnsでcontentsを取り出し、さらにその中にあるeventsを取り出しています。

var content = JSON.parse(e.postData.contents);
var events = content['events'];

そして後はeventsの中に含まれるreplyTokenとmessage.textを以下で変数に保存しています。なお、eventsは配列となっており、以下ではevents[0]で最初の要素を取得しています。通常はボットを使用するユーザは１人ではなく、複数いるはずなのでevents配列には、実際には複数ユーザからのイベントがまとめて格納されます。よって、ここでevents[0]としているのはあくまでもテストとしてユーザが自分１人しかいない場合用です。もしボットを一般公開して使う場合など複数のユーザが想定される時は、events配列の全要素に対して繰り返し処理を実行する必要があります。

// Echoボットで必要となるデータ
var reply_token = events[0].replyToken;          // 返信用トークン
var posted_msg  = events[0].message.text;    // ユーザが投稿したメッセージ`

注意点

Google Apps Scriptを更新したのに反映されない

この作業を行わない限り、いくらスクリプトを編集しても全く反映されないので注意が必要です。

ボットのメッセージとして自動応答メッセージも一緒に返ってくる

これを無効化したい場合は、「編集」から以下のように「利用しない」にチェックを入れて「更新」をクリックします。

ちなみに、自動応答メッセージや友達追加時あいさつの内容は変更可能で、これはLINE@Mangaerから変更できます。以下がLINE@Mangaerのログイン画面になります。

LINE@で販促・ファンを獲得！無料アプリで簡単に始めるビジネス向けLINE

LINE@は無料アプリをダウンロードするだけで誰でも簡単に始められるLINEのビジネス向け広告宣伝サービスです。メッセージ配信によるメルマガのような使い方から、ホームページ作成、クーポンの配信、1対1のトークなど様々な機能をご用意

at.line.me

まとめ