Zenn
💬

LINE Messaging API へのメッセージ を GAS で処理する

2023/08/21に公開
LINE
Tips
GAS
LINE Bot
tech

はじめに

何をするか

  • LINE Messaging API の webhookイベントを GAS で受け付けて処理したい
  • 今回は、処理日時とメッセージ送信者のUserID、メッセージ本文をスプレッドシートに記録する処理とする

前提

  • LINE Messaging API を作成済み
  • GAS をウェブアプリとしてデプロイ済み
  • Messaging API の webhook エンドポイントをGASのデプロイURLに設定済み

前提となる LINE bot の開設方法や、GASの設定は今後投稿予定です✌️

流れ

  1. GAS の doPost 関数で POST を受け付ける
  2. イベントの種類を判別し、必要な情報を取り出す
  3. スプレッドシートに記述する

スクリプト

const SPREAD_SHEET_ID = '{スプレッドシートのID}'
const SHEET_NAME = '{シート名}'

// 一行分のデータを受け取って、シート末尾に記録する
function addRecord(records = []) {
    const ss = SpreadsheetApp.openById(SPREAD_SHEET_ID); 
    const sheet = ss.getSheetByName(SHEET_NAME);
    // 最終行の一行下に追記
    const lastRow = sheet.getLastRow() + 1;
    const range = sheet.getRange(lastRow, 1, 1, records.length)
    range.setValues([records])
}

// POSTリクエストに対する処理
function doPost(e) {
  // データが空なら処理しない
  if (e == null || e.postData == null || e.postData.contents == null) return;

  // リクエストを受け取ってオブジェクト化
  const requestJSON = e.postData.contents;
  const requestObj = JSON.parse(requestJSON);

  // 以降は LINE Messaging API の仕様に準じた処理
  const events = requestObj.events;
  // events は配列で渡ってくるので、繰り返し処理する
  events.forEach((event) => {
    // メッセージイベントのみ受け付ける
    if (event.type !== 'message') return;
    const message = event.message;
    // テキスト入力のみ受け付ける
    if (message.type !== 'text') return;

    // 記録するデータを取得
    const datetime = new Date();
    const userId = event.source.userId;
    const text = message.text;

    const records = [datetime, userId, text];

    // スプレッドシートに記載
    addRecord(records);
  })
}

解説

基本的にはコメントにある通りですが、捕捉として解説します。

addRecord(records) 関数について

独自で定義する関数です。
デバッグ目的で多用するため、関数として定義しておくと便利です。
Range.setValues() は引数として二次元配列を受け取り、複数行のセルに記述する仕様なので注意してください。
今回はrecord 引数に一行分のデータとして一次元配列を受け取り、 setValues 実行時に二次元配列として渡すことにしています。

doPost(e) 関数について

GAS をウェブアプリとしてデプロイしている場合、公開URLにPOSTリクエストが発生した際に実行される関数です。e 引数はリクエストのイベント情報です。
e.postData.contents でリクエストのコンテンツを取得できます。JSONテキスト形式なので、 JSON.parse() でオブジェクト化してお来ます。
ウェブアプリとしてGASの詳細や e のデータ構造については下記リンクを参照してください。
ウェブアプリ  |  Apps Script  |  Google for Developers

Messaging API webhook の JSON について

requestJSON.events が今回取り扱うデータです。
Messaging API が POST する JSON の仕様については下記のリンクを参照してください。
Messaging APIリファレンス
上記リファレンスにもある通り、 events は配列として渡ってくるので注意します。

動作確認

定数の設定

スクリプト冒頭の定数定義箇所に下記文字列を記述しておきます。

  • SPREAD_SHEET_ID
    • データを記録したいスプレッドシートのURL末尾の文字列
    • スプレッドシートを開いた時のURL https://docs.google.com/spreadsheets/d/xxxxxxxxxx/edit#gid=0 の xxxxxxxxxx の部分
  • SHEET_NAME
    • データを記録したいシート名
    • スプレッドシート作成時の初期値は「シート1」

LINE でメッセージを送信

LINE bot (Messaging API）アカウントにメッセージを送信して、
指定したシートの末尾に情報が記述されれば成功です。

おわりに

不明点等あればコメントください！
前提となる LINE bot の開設方法や、GASの設定、トラブルシューティングは今後投稿予定です✌️

GitHubで編集を提案

Discussion