Slackで来るメンションをGoogle Apps Scriptで一覧化した

Google Apps Script（以下、GAS）でSlackに来ていた質問を一覧にするBotを作成した時の話です。
手順やコードは記事の後ろの方に載せています。
※約２年前に作成して以降、一切手を加えずに現在も毎日動いているBotなので現在は作り方が違うところや抜けなどあるかもしれません、ご承知おきください。

経緯

弊チームでは、サービスを一つ運用しており、そのオーナーとして関係各所から質問が沢山飛んできます。
これを、翌日朝にチーム内で質問を確認し、意見を合わせてから回答するようにしています。
その都度反応して、本来その日こなす筈だったタスクが遅れてしまう・予定が崩れてしまうのを避けるために、今日入ってきた仕事は明日やるという「マニャーナの法則」を取り入れています。
まだ色々と未成熟なため、人によって回答内容が変わったり、回答出来る人が偏ったりしないようにするためでもあります。チームの方針をその場で決められる場でもあります。

問題

上項の運用をする中で以下のような場合に確認が漏れてしまい、回答を催促されるという問題が度々発生していました。この問題を解決する為のBotです。

• そもそも質問が他のメッセージで埋まる・流れてしまう
• 回答後、しばらく経ってからスレッドの中で再度質問される

システム概要

チームへ来た質問を一覧に纏めてくれるBotです。

例

本稿では、以下の命名を例として記載しています。

質問を投稿するチャンネル：#question-channel
質問一覧を投稿するチャンネル：#question-list
特定の文言（ユーザーグループメンション）：@hoge-team
追加リアクション：:ashita-miru:
削除リアクション：:sumi:

機能一覧

1. 特定のチャンネルで（例#question-channel）投稿されたメッセージの中に特定の文言（例@hoge-team）が含まれている場合、投稿されたメッセージに指定のリアクション（例:ashita-miru:）を追加する。

2. メッセージに:sumi:リアクションを追加すると、Bot Userが追加していた:ashita-miru:リアクションを削除する。

3. 毎日10:25に特定のチャンネル（例#question-channel）で特定のリアクション（例:ashita-miru:）が付いているメッセージのリンクの一覧を、指定したチャンネル（例#question-list）に投稿する。

4. Botユーザーが#question-listに投稿した、メッセージリンクの一覧を毎日12:00-13:00の間に削除する。

アーキテクチャ

SlackとGASのみのシンプルな設計です。

Slack設定

Slack Botユーザーの設定については以下の記事をご参照ください。
投稿したいチャンネルと質問が来るチャンネルに作成したBotユーザーをメンバーとして追加する必要があります。

スコープ

今回Botユーザーに必要なスコープは下記の通りです。

Bot Token Scopes

• channels:history
• chat:write
• chat:write.customize
• reactions:read
• reactions:write

User Token Scopes

• search:read

Event Subscriptions

Event Subscriptionsを開く
Enable EventsをONに切り替え
Request URL に後項のGASプロジェクトの公開時に作成されるWebhook URLを入力
※エンドポイントはチャレンジ値で応答する必要があるため、Request URLの検証時のみ、doPost関数の戻り値は以下のようにしてください。

コード.gs

function doPost(e){
  return ContentService.createTextOutput(json.challenge);
}

GAS設定

注意事項

本稿でのGASはクラシック エディタを使用しています。

会社組織で管理されているGoogle Workspaceだと良くある事なのですが、組織管理のユーザーが作成したリソースは組織外からはアクセス出来ないように組織全体のポリシーで制限されている場合が多いです。
Slackからのアクセスは組織外からのアクセスに該当するため、匿名ユーザーを含む全員がアクセス可能な権限に変更しても組織全体のポリシーで弾かれてしまいます。

この制限を回避するために、フリーのGoogleアカウントを取得しています。

プロジェクト作成

ブラウザからGoogle Apps Scriptへアクセス
「新しいプロジェクト」ボタンをクリックして新しいプロジェクトを作成

コード実装

「コード.gs」に後項のコードを記載

保存

メニューバーの「無題のプロジェクト」から名前を変更
「ファイル」＞「保存」を選択し、プロジェクトを保存

プロパティ設定

※トークンがハードコードで問題無い場合、本設定は不要です。
「ファイル」＞「プロジェクトのプロパティ」を選択し、ウィンドウを開く

「スクリプトのプロパティ」タブを開く
作成したSlack Botユーザーの「OAuth Token」を任意のプロパティ名で追加
「保存」ボタンをクリック

プロジェクトの公開

「公開」＞「ウェブアプリケーションとして導入」を選択し、ウィンドウを開く

「Who has access to the app（アプリケーションにアクセスできるユーザー）」は
「Anyone, even anonymous（全員｛匿名ユーザー含む｝）」を選択し、「Deploy」クリック

承認を求められるので「許可を確認」をクリック
Googleアカウントへのアクセスリクエストに「許可」をクリック
Current web app URLとして、作成されたWebhook URLが表示されるので、Slack BotユーザーのEvent SubscriptionsのRequest URLに設定

トリガー設定

GASダッシュボード画面（プロジェクト編集画面から画面左上の青い右矢印のアイコンをクリックして遷移）を開く
作成したプロジェクトの三点リーダーをクリックし、「トリガー」を選択

「＋　トリガーを追加」ボタンをクリック

以下の設定でトリガーを２つ追加

※毎日実行できる日付ベースのトリガーは正確な時間指定ができず、指定した時刻のどこかで関数が実行されます。
※特定の日時を指定し、一度のみ実行するトリガーは時分単位まで指定できます。

実行する関数	イベントのソース	時間ベースのトリガーのタイプ	時刻
setTrigger	時間主導型	日付ベースのタイマー	postQuestionListの実行時間に被らない時間帯
deleteQuestionList	時間主導型	日付ベースのタイマー	postQuestionListの実行時間より後の投稿を消したい時間帯

コード

コード.gs

function postRequest(url){
  var method = 'post';
  var payload = {};
  var params = {
    'method': method,
    'payload': payload
  };
  var response = UrlFetchApp.fetch(url, params);
  return response;
}

function addReaction(item){
  var token = PropertiesService.getScriptProperties().getProperty('SLACK_ACCESS_TOKEN');
  var reaction_emoji = 'ashita-miru';

  //var url = 'https://slack.com/api/reactions.add?token=xoxb-xxxxxxxxxxx-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxx&channel=ABCD01234&timestamp=1234567890.012345&name=ashita-miru'
  var url = 'https://slack.com/api/reactions.add?' + 'token=' + token + '&channel=' + item.channel + '&timestamp=' + item.ts + '&name=' + reaction_emoji;
  return postRequest(url);
}

function removeReaction(item){
  var token = PropertiesService.getScriptProperties().getProperty('SLACK_ACCESS_TOKEN');
  var reaction_emoji = 'ashita-miru';

  //var url = 'https://slack.com/api/reactions.remove?token=xoxb-xxxxxxxxxxx-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxx&channel=ABCD01234&timestamp=1234567890.012345&name=ashita-miru'
  var url = 'https://slack.com/api/reactions.remove?' + 'token=' + token + '&channel=' + item.channel + '&timestamp=' + item.ts + '&name=' + reaction_emoji;
  return postRequest(url);
}

function searchMessages(query){
  //OAuth Scope「search:read」のみBot Token Scopesではないため、トークンが異なる
  //var token = PropertiesService.getScriptProperties().getProperty('SLACK_USER_ACCESS_TOKEN');
  //FIXME:何故か設定したGASのプロパティから読み出せ無かった為一旦ハードコード
  var token = 'xoxp-xxxxxxxxxx-xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';

  //var url = https://slack.com/api/search.messages?token=xoxp-xxxxxxxxxx-xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&query=in%3A%23question-channel%20has%3A%3Aashita-miru%3A&pretty=1
  var url = 'https://slack.com/api/search.messages?' + 'token=' + token + '&query=' + query + '&pretty=1';
  return postRequest(url);
}

function postMessage(massage){
  var token = PropertiesService.getScriptProperties().getProperty('SLACK_ACCESS_TOKEN');
  //投稿できるのはアプリを追加したチャンネルとDMのみ
  const CHANNEL_ID = 'IJKL56789';

  //URL等がメッセージに含まれている場合エンコードしないとpost時にエラーになる
  var encode_massage = encodeURIComponent(massage);
  //var url = https://slack.com/api/chat.postMessage?token=xoxb-xxxxxxxxxxx-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxx&channel=IJKL56789&text=testmassage&pretty=1
  var url = 'https://slack.com/api/chat.postMessage?' + 'token=' + token + '&channel=' + CHANNEL_ID + '&text=' + encode_massage + '&pretty=1';
  return postRequest(url);
}

function deleteMassage(channel,ts){
  var token = PropertiesService.getScriptProperties().getProperty('SLACK_ACCESS_TOKEN');

  //var url = https://slack.com/api/chat.delete?token=xoxb-xxxxxxxxxxx-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxx&channel=IJKL56789&ts=1234567890.012345&pretty=1
  var url = 'https://slack.com/api/chat.delete?' + 'token=' + token + '&channel=' + channel +'&ts=' + ts + '&pretty=1';
  return postRequest(url);
}

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

//Slack Botユーザーが参加しているチャンネルで何らかのイベントが発生した時、Webhook経由で実行される関数
function doPost(e){
  const CHANNEL_ID = 'ABCD01234';
  const GROUP_ID = 'EFGH56789';
  const DETECTION_STRING = GROUP_ID;
  try {
    var json = JSON.parse(e.postData.getDataAsString());
    var event = json.event;

    //投稿されたメッセージ内に検知文字列が含まれていた場合に明日確認する旨のリアクションを追加する
    if (event.type === 'message') {//イベントがメッセージの投稿であるか
      if (event.channel === CHANNEL_ID) {//該当チャンネルであるか
        if (event.text.indexOf(DETECTION_STRING) >= 0) {//文字列が見つからなかったら-1
          var response = addReaction(event);
        }
      }
    }

    //確認した旨のリアクションが追加された時、メッセージに付けていた明日確認する旨のリアクションを削除する
    const DETECTION_REACTION_SUMI = 'sumi';
    const DETECTION_REACTION_KAKUNINZUMI = 'kakuninzumi';
    if (event.type === 'reaction_added') {//イベントがリアクションの追加であるか
      if (event.item.channel === CHANNEL_ID) {//該当チャンネルであるか
        if (event.reaction.indexOf(DETECTION_REACTION_SUMI) >= 0) {//リアクションが見つからなかったら-1
          var response = removeReaction(event.item);
        } else if (event.reaction.indexOf(DETECTION_REACTION_KAKUNINZUMI) >= 0) {//リアクションが見つからなかったら-1
          var response = removeReaction(event.item);
        }
      }
    }
    return response.getResponseCode();
//    return ContentService.createTextOutput(json.challenge);//Event SubscriptionsにRequest URLを検証させるときだけ必要
  } catch (ex) {
    Logger.log('エラー発生');//直接実行用
    console.log('エラー発生');//トリガー用
  }
}

//GASのトリガーで実行される関数
//質問一覧を投稿する
function postQuestionList(){
  try {
    //var query = 'in:#question-list has::ashita-miru:';
    var query = 'in%3A%23question-list%20has%3A%3Aashita-miru%3A';
    var response = searchMessages(query);

    var json = JSON.parse(response.getContentText());
    var messages = json.messages.matches;

    var massage_link = '';
    for (let i = 0; i < messages.length; i++) {
      let link = json.messages.matches[i].permalink;
      massage_link += link + '\n';
    }

    const GROUP_ID = 'EFGH56789';
    if (messages.length === 0) {
      post_massage = '全未回答メッセージ確認完了！\nやることリストから1つ消えました！';
    } else {
      post_massage = '<!subteam^'+GROUP_ID+'> 未回答の質問一覧はこちら！\n' + '```' + massage_link + '```';
    }

    return postMessage(post_massage);
  } catch (ex) {
    Logger.log('エラー発生');//直接実行用
    console.log('エラー発生');//トリガー用
  }
}

//GASのトリガーで実行される関数
//投稿した質問一覧を削除する
function deleteQuestionList(){
  try {
    //Botユーザー名がスペース区切り「@question list」だとsearch.messagesのqueryで検索文字が@question + listになってしまったので、Botユーザー名を「@question-list」へ変更した
    //追記：実はスペース区切りでもアンダースコアにすると検索ができた
    //var query = 'in:#question-list from:@question_list after:yesterday';
    var query = 'in%3A%23question-list%20from%3A%40question_list%20after%3Ayesterday';
    
    //https://slack.com/api/search.messages?token=xoxp-xxxxxxxxxx-xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&query=in%3A%23question-list%20from%3A%40question-list%20after%3Ayesterday&pretty=1
    var response = searchMessages(query);

    var json = JSON.parse(response.getContentText());
    var messages = json.messages.matches;
    
    for (let i = 0; i < messages.length; i++) {
      let channel_id = json.messages.matches[i].channel.id;
      let ts = json.messages.matches[i].ts;
      var response = deleteMassage(channel_id,ts);
    }
    return response;
  } catch (ex) {
    Logger.log('エラー発生');//直接実行用
    console.log('エラー発生');//トリガー用
  }
}

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

//トリガーを削除する
function deleteTrigger(targetHandlerFunction){
  var triggers = ScriptApp.getProjectTriggers();//現在のプロジェクトで設定済みのすべてのトリガーを取得
  for (let trigger of triggers) {
    //トリガーに設定されている関数とtargetHandlerFunctionが一致する場合にトリガーを削除
    if (trigger.getHandlerFunction() === targetHandlerFunction) {
      ScriptApp.deleteTrigger(trigger);
    }
  }
}

//GASのトリガーで実行される関数
//トリガーを設定する
function setTrigger(){
  const TRIGGER_FUNCTION = 'postQuestionList';
  var targetDate = new Date();

  //毎日トリガーが増え続けないよう、古いトリガーを削除
  deleteTrigger(TRIGGER_FUNCTION);

  //TRIGGER_FUNCTIONを10:25に実行するトリガーを設定
  targetDate.setHours(10);
  targetDate.setMinutes(25);
  ScriptApp.newTrigger(TRIGGER_FUNCTION).timeBased().at(targetDate).create();
}

Q&A

• なんでGASにしたの？
  • 無料でサクッと組めたのが良かったからです。
  • 内部関係者からの質問だけなので、突然動かなくなっても最悪手動で確認すれば良く、深刻な問題にはならないためです。
• どうして毎日、投稿したメッセージリンクの一覧を削除しているの？
  • 通常のやり取りで使用しているチャンネルなので、Botのメッセージによって通常のメッセージが埋まるのを避けるためです。
• どうして直接postQuestionList関数をトリガーで設定せずにsetTrigger関数内で設定しているの？
  • 手順内に記載の通り、日付ベースのトリガーは正確な時間指定ができません。
  • postQuestionList関数は、毎日10:25分丁度に動かしたかったので、「毎日一度のみpostQuestionList関数を実行するトリガー」を設定するトリガーをsetTrigger関数で設定しています。
• GASが動かなくなった事はある？
  • 稼働させてから一度もGASが動作しない事はありませんでした。
  • ただし、２～３ヵ月に１日くらいの頻度で、既にリアクション削除済みのメッセージも取得してきたりします。これはBotだからとかではなく、手動でSlack内検索を行っても同じ結果が返ってくるのでSlackの検索APIの問題だと思われます。（想像ですが、キャッシュが残っているとかでしょうか？）

参考

Slack API

API Event Types
message event
message.channels event

reaction_added event

reactions.add
reactions.remove

search.messages

chat.postMessage
chat.delete

GAS Reference

Class UrlFetchApp
Class HTTPResponse

記事

SlackでリアクションBotをつくろう！（GAS）-Qiita
GASでログ出力する2つの方法(Logger.logとconsole.log)の紹介と使い分け
Google Apps script(GAS)でLine bot開発中にハマったこと
【LINE Botの作り方】Messaging API × GAS(Google Apps Script)でおうむ返しボットを作成する | TAKEIHO
Slack APIでメッセージの検索をしてみた（search.messages）
GASのトリガーによるプログラムの自動実行 #2