【Google Apps Script × Slack】歌詞Botを作ってみた

GASを触り始めると、成果がすぐ出るので楽しい毎日です。
あとは時限トリガーとSlackなどのチャットツールさえあれば、私の代わりに毎日自動かつ正確に*1働いてくれます。しめしめ。

私もこれくらい優秀な仕事人になりたかったけど、来世までは無理そう（遠い目）なので地道に自動化の術を学んで行きたいと思います。

そんなわけで本日は、毎度おなじみ隣IT様の「名言bot」を参考に「歌詞bot Slack ver.」を作ってみました。

本日のテーマ
準備
- Spreadsheet
コード
トリガー
送信サンプル
- Slack記法
【おまけ】Slackの設定変更のすすめ
参照
- 書籍
注釈

本日のテーマ

Google Apps Scriptでチャットワークの名言botを作る方法

準備

Spreadsheet

こんな感じ↓の表を作成します。

※スマホ等の小さめの画面では以下の表が見難いことがあります。その場合は、恐れ入りますがPC等で改めて内容をご確認いただければと思います…
<2019/05/24追記>
画像に差し替えました。クリックorタップで拡大します。
Phraseシートの画像

「歌詞Bot」とは言うものの、今のところ「歌詞」と「好きな詩・ことば」を混ぜた表です。
作成するメッセージはG列のisSong?のTRUE/FALSEで判定しています。

コード

V8に対応しました。

<2020/03/09追記>
2020年2月に公開されたV8ランタイム用の文法（いわゆるES6）に対応しました。

GitHub - yuricks7/GAS_Slack_KindWordsBot_V8: This repo is written for V8 Runtime of Google Apps Script.

動作は以下のコードと同じで、新キーワードへの置き換えと少々のリファクタリングのみ行っています。
よかったらこちらも合わせてご参照ください。

Slackクラス

SlackAppライブラリ（詳しくはこちら）を導入している前提の内容です。

コンストラクタ

/**
 * 投稿先の設定
 * ※あらかじめ使用するプロジェクトにSlackAppライブラリを導入しておくこと！
 *
 * @param {string} 投稿先のチャンネル名
 * @param {string} 投稿に表示するユーザー名
 */
var Slack = function(channelName, displayUserName) {
  this.channelName     = channelName;
  this.displayUserName = displayUserName;
}

メソッド

今のところpostメソッドだけですが、おいおい他のメソッドも追加していきます（たぶん）。

/**
 * メッセージをSlackに投稿する
 *
 * @param {string} 作成したSlackメッセージ
 */
Slack.prototype.post = function(message) {
  if (!message) {
    var message = '「メッセージが空欄」でーす';
  }
  
  var accessToken = PropertiesService
    .getScriptProperties().getProperty('SLACK_ACCESS_TOKEN');

 //SlackAppインスタンスの取得
  var slackApp = SlackApp.create(accessToken);

  slackApp.postMessage(
    this.channelName,
    message,
    {username: this.displayUserName}
  );
};

メイン・スクリプト

メイン

var targetRow～の部分で、2行目から最終行までの範囲からランダムに送信行を選択します。
こちらは元コードから拝借しました。

/**
 * 「'Phrase'」シートに入力した言葉をランダムでSlackに送信する
 */
function SendKindWordsBot() {
  var ss          = SpreadsheetApp.getActiveSpreadsheet();  
  var phraseSheet = ss.getSheetByName('Phrase');
  
  const FIRST_DATA_ROW = 2;
  var   lastRow        = phraseSheet.getLastRow(); 
  
  var targetRow = Math.floor(Math.random() * (lastRow - 1) + FIRST_DATA_ROW);
  var values = phraseSheet.getRange(targetRow, 1, 1, 10).getValues();
  
  var message = createLyricMessage(values[0]);

  var SlackBot = new Slack('00_kind-words-bot', '優しいことばBot');  
  SlackBot.post(message);
}

メッセージを作成

歌詞じゃないフレーズの場合は「作・編曲者」等の文言は要らないので、表のG列の値をもとに作成する内容を変えます。

/**
 * 行データから送信するメッセージを作成する
 *
 * @param {array} 送信対象の行データ
 * @return {string} 作成したメッセージ
 */
var createLyricMessage = function(rowValues) {  
  const BR = '\n';
  var   m  = '';
  if (rowValues[6] === true) {
    m = 'お元気ですか？' + BR
    m += 'ちょっとこれ読んで休憩しましょ！:shushing_face:' + BR
    m += '```' + BR
    m += rowValues[0] + BR
    m += '```'+ BR
    m += rowValues[1] + ' - ' + rowValues[2] + BR
    m += '>>> '
    m += '作詞：' + rowValues[3] + BR
    m += '作曲：' + rowValues[4] + BR
    m += '編曲：' + rowValues[5] + BR
    m += BR
    m += '▼Youtube' + BR
    m += rowValues[7];

    return m;
  }

  m = 'お元気ですか？' + BR;
  m += 'ちょっとこれ読んで休憩しましょ！:shushing_face:' + BR;
  m += '```' + BR;
  m += rowValues[0] + BR;
  m += '```'+ BR;
  m += rowValues[1] + ' - ' + rowValues[2] + BR;
  m += '>>> ';
  m += '執筆：' + rowValues[3] + BR;
  m += BR;
  m += '▼参考URL' + BR;
  m += rowValues[9];

  return m;
};

'```'や'>>> 'の部分については、詳しくは後述します。

トリガー

今のところは、トリガーの設定画面から時限トリガーで30分ごとにしています。

実行する関数	SendKindWordsBot
デプロイ時に実行	Header
イベントのソース	時間主導型
時間ベースのトリガー	分ベースのタイマー
時間の間隔	30分おき*2
エラー通知設定	1週間おき