Web開発の最新情報を追うのに、Redditはうってつけです。私のように、r/nodeやr/javascriptなどのサブレディットをフォローしている方も多いでしょう。最近、JavaScriptの知識だけでZapierとRedditを連携させ、話題のReddit投稿をチームのチャンネルで共有する方法を見つけました。
この記事では、次の内容を解説します。
Slackボットのインテグレーションの作成方法
ZapierでSlackチャンネルにメッセージを投稿するトリガーとアクションのワークフローを作成する方法
Reddit APIキーを使い、ネイティブのRedditアクセストークンとリフレッシュトークンで投稿にアクセスする方法
匿名のJSONエンドポイントを使ってRedditの投稿にアクセスする方法
HTTPクライアントnode-fetchを使ってRedditの情報を取得するJavaScriptコードの作成方法(Node.jsバージョン10に対応。なお、すでにサポート終了しています)
Slackボットでできること
このチュートリアルではJavaScriptでSlackボットを作成する方法を紹介しますが、Zapierの機能豊富なAPIエコシステムを使えば、さまざまな情報ソースをSlackボットAPIに接続できます。このチュートリアルではJavaScriptを取り上げますが、Node.jsアプリケーションをクラウドでホストしている場合は、ZapierのHTTP Webhookを使ってSlackボットのNode.jsアプリケーションを作成することもできます。
ZapierとRedditを連携させ、注目のトピックを処理する
Zapierとは?
Zapierは、多数のプラットフォームを連携させ、ワークフローを構築できる自動化プラットフォームです。主に、Zapierマーケットプレイスで利用できるAPIやネイティブインテグレーションに使われますが、インテグレーションの各ポイントで生の入出力データを提供し、コードでワークフローの処理をカスタマイズできる点も大きな特長です。
SlackボットのインテグレーションにはZapierを使います。ZapierにはSlackとのネイティブインテグレーションがあるため、専用サーバーでボットをホストしたり、別のSlackボットインテグレーションを作成したりする必要はありません。
ZapierとSlackボットを連携させたら、次の手順に進みます。
インテグレーションの実行スケジュールを設定します。Zapierのタスクを定期的に起動して処理を開始するスケジュールを指定できます。
ZapierでカスタムJavaScriptコードのタスクを定義し、RedditのJSONエンドポイントから関心のあるトレンドトピックを取得します。
トレンドトピックを好みの形式に整え、Zapierに組み込まれているSlackボットのネイティブインテグレーションを通じてSlackチャンネルに送信します。
ZapierのワークフローUIでは、この一連の処理は次のようになります。
トリガー:Schedule by Zapierで毎週実行
まず、Zapierワークフローの定期スケジュールを設定します。今回は、毎週月曜日の午前8時(UTC)に実行するように設定しました。
Slackメッセージを自動化するには?
このSlackボットのチュートリアルでは、Zapierで時間を指定して起動するスケジュールを使います。ただし、Zapier APIプラットフォームには、Slackの自動化に利用できるトリガーがほかにも数多くあります。たとえば、Twitterでのメンション、Googleスプレッドシートの更新、Googleカレンダーの予定の更新、RSSフィードの更新などをSlackボットのJavaScript自動化に組み込めます。チームの脆弱性管理のために、Snykのセキュリティ通知を自動化することもできます。
アクション:Code by ZapierでJavaScriptを実行
時間ベースのトリガーを設定してワークフローを起動できるようになったので、次はタスクを実行するアクションを作成します。Zapierのインテグレーションでは、各タスクで処理したデータを次のアクションに渡すことができます。
アクションの種類としてRun JavaScript in Code by Zapierを選びます。Eventの設定でRun JavaScriptを選択します。初期設定は次のようになります。
次に、Set up actionの設定を展開し、Reddit APIエンドポイントからトレンドトピックの情報を取得するJavaScriptコードを追加します。
Reddit APIキーの使い方
Redditの最新情報を取得する方法はいくつかあります。ここでは、興味のあるRedditスレッドの更新情報を受け取る方法を2つ紹介します。
Reddit APIキーを使う方法(Redditユーザーアカウントの登録が必要)
一般公開されているReddit APIエンドポイントを使う方法
サブレディットやトレンド投稿の読み取りだけが必要な場合は、Reddit OAuth APIのワークフローを使わないシンプルな方法がおすすめです。Reddit APIへのアクセスに関するこの章の2つ目の方法に進んでください。
Reddit APIキーを登録する
まず、Reddit APIアプリケーション設定に移動し、画面下部のCreate an appボタンをクリックします。次に、APIのユースケースに関する情報を入力します。アプリケーションの種類をwebappに設定し、アクセストークンを処理するためのリダイレクトURIを指定してください。
するとClientIDとClientSecretが発行され、これらを使ってAPIを呼び出せるようになります。Reddit APIへの問い合わせ方法やReddit OAuthの手順がわからない場合は、Redditのスクレイピングに関する記事など、ほかの入門チュートリアルを参照してください。
Reddit APIのルールと遵守すべき条件を理解するため、必ずRedditのAPIアクセス規約を確認してください。
Reddit APIを使ったJavaScriptの例
ここでは、JavaScriptを使って興味のあるRedditスレッドを取得する方法を見ていきます。そのために、上記のClientIDとClientSecretの認証情報に加えて、refresh_tokenの値が必要です。この値は、Reddit OAuthの永続アクセストークンを作成する設定を選んだ場合に取得できます。
以下は、ネイティブのJavaScriptコードでサブレディットの投稿を取得するReddit APIキーの使用例です。コードスニペットを正しく動作させるには、以下のABCDを先ほどのReddit認証情報に置き換えてください。
このReddit APIのJavaScriptコードスニペットでは、refresh_tokenを使ってReddit APIに問い合わせ、access_tokenをリクエストします。Reddit APIのアクセストークンを取得したら、新しいHTTPリクエストを作成して、r/nodeサブレディットに投稿されたトレンド投稿を取得します。最後に、すべての投稿データをループ処理し、次のアクションに渡すメッセージ文字列を作成します。
先ほどのコードスニペットから、特に重要な点を2つ紹介します。
Redditのデータを問い合わせる正しい最新のAPIでは、params2で使われているtクエリパラメーターを使用します。ただし、古いチュートリアルやガイドでは、今もtimeを使うように書かれている場合があります。
もう一つ注目すべき点として、Zapierではサポートが終了したNode.jsランタイム(Node.js v10)上で古いバージョンのnode-fetchを使う必要があります。そのため、URLオブジェクトを直接使ってHTTPリクエストを実行できます。
js const url2 = new URL('https://oauth.reddit.com/r/node/top'); const res2 = await fetch(url2, settings2);
ほかのAPI操作については、Redditアカウント、履歴、サブレディットのモデレーションなどに関する利用可能なエンドポイントを網羅した、最新のReddit APIドキュメントを参照してください。
公開JSONエンドポイントを使ってRedditの情報を取得する
次のJavaScript Zapierアクションに進む前に、OAuthやほかのAPIキーによる認証を行わずにReddit APIに問い合わせる方法を簡単に紹介します。
Redditでは、サブレディットのスレッド情報をJSON形式で、次の公開認証不要エンドポイントから取得できます。
このサブレディットのTop投稿を取得し、次のクエリパラメーターを追加して期間を指定することもできます。
Redditから返されるJSONは、次のような形式です。
1json
2{
3 "kind": "Listing",
4 "data": {
5 "after": "t3_vuyxes",
6 "dist": 1,
7 "modhash": "6v201d03619751a685b19dcf05febbf88ed6d115afa5d16b78",
8 "geo_filter": "",
9 "children": [
10 {
11 "kind": "t3",
12 "data": {
13 "approved_at_utc": null,
14 "subreddit": "node",
15 "selftext": "",
16 "author_fullname": "t2_7eb9a4k5",
17 "saved": false,
18 "mod_reason_title": null,
19 "gilded": 0,
20 "clicked": false,
21 "title": "Deno in 2022",
22 "link_flair_richtext": [],
23 "subreddit_name_prefixed": "r/node",
24 "hidden": false,
25 "pwls": 6,
26 "link_flair_css_class": null,
27 "downs": 0,
28 "top_awarded_type": null,
29 "hide_score": false,
30 "name": "t3_vuyxes",
31 "quarantine": false,
32 "link_flair_text_color": "dark",
33 "upvote_ratio": 0.92,
34 "author_flair_background_color": null,
35 "subreddit_type": "public",
36 "ups": 745,
37 "total_awards_received": 0,
38 "media_embed": {},
39 "author_flair_template_id": null,
40 "is_original_content": false,
41 "user_reports": [],
42 "secure_media": null,
43 "is_reddit_media_domain": true,
44 "is_meta": false,
45 "category": null,
46 "secure_media_embed": {},
47 "link_flair_text": null,
48 "can_mod_post": false,
49 "score": 745,
50 "approved_by": null,
51 "is_created_from_ads_ui": false,
52 "author_premium": false,
53 "thumbnail": "",
54 "edited": false,
55 "author_flair_css_class": null,
56 "author_flair_richtext": [],
57 "gildings": {},
58 "content_categories": null,
59 "is_self": false,
60 "mod_note": null,
61 "created": 1657363081,
62 "link_flair_type": "text",
63 "wls": 6,
64 "removed_by_category": null,
65 "banned_by": null,
66 "author_flair_type": "text",
67 "domain": "i.redd.it",
68 "allow_live_comments": true,
69 "selftext_html": null,
70 "likes": null,
71 "suggested_sort": null,
72 "banned_at_utc": null,
73 "url_overridden_by_dest": "https://i.redd.it/hjv8r84ttia91.jpg",
74 "view_count": null,
75 "archived": false,
76 "no_follow": false,
77 "is_crosspostable": true,
78 "pinned": false,
79 "over_18": false,
80 "all_awardings": [],
81 "awarders": [],
82 "media_only": false,
83 "can_gild": true,
84 "spoiler": false,
85 "locked": false,
86 "author_flair_text": null,
87 "treatment_tags": [],
88 "visited": false,
89 "removed_by": null,
90 "num_reports": null,
91 "distinguished": null,
92 "subreddit_id": "t5_2reca",
93 "author_is_blocked": false,
94 "mod_reason_by": null,
95 "removal_reason": null,
96 "link_flair_background_color": "",
97 "id": "vuyxes",
98 "is_robot_indexable": true,
99 "report_reasons": null,
100 "author": "m_ax__",
101 "discussion_type": null,
102 "num_comments": 184,
103 "send_replies": true,
104 "whitelist_status": "all_ads",
105 "contest_mode": false,
106 "mod_reports": [],
107 "author_patreon_flair": false,
108 "author_flair_text_color": null,
109 "permalink": "/r/node/comments/vuyxes/deno_in_2022/",
110 "parent_whitelist_status": "all_ads",
111 "stickied": false,
112 "url": "https://i.redd.it/hjv8r84ttia91.jpg",
113 "subreddit_subscribers": 215851,
114 "created_utc": 1657363081,
115 "num_crossposts": 0,
116 "media": null,
117 "is_video": false
118 }
119 }
120 ],
121 "before": null
122 }
123}
ZapierアクションのJavaScriptレスポンスを整形する
RedditのJSONデータをどのように取得・整形した場合でも、次のSlackボットインテグレーションで利用できるように準備する必要があります。前のJavaScript Zapierアクション内でまとめて処理することも、専用のZapierアクションとして実行することもできます。後者なら、Redditのデータ形式が変わった場合にも再利用できます。
次のコードスニペットはシンプルです。inputData変数を使ってJavaScript Zapierアクションに入力を渡し、出力として返す方法を示しています。
配列形式は必須ではありませんが、これを使うと、配列内の各ペイロード(またはオブジェクトの値)に対して、後続のアクションを繰り返し実行するようZapierに指示できます。
参考までに、スクリーンショットを以下に示します。
Slackでチャンネルメッセージを送信する
いよいよ、SlackボットによるReddit自動化の最後のステップです。前の手順で処理したメッセージをSlackチャンネルに投稿します。
そのために、Zapierを汎用のインテグレーションアプリケーションとしてSlackに認証し、Slackチャンネルの一覧表示やメッセージの投稿などに必要な権限を付与してください。
新しいZapierアクションを追加し、ApplicationにSlackを選びます。Eventの入力欄ではSend Channel Messageを選択します。次に、Choose Accountオプションに進み、メッセージが自分のユーザープロフィールから送信されるよう、できれば自分のSlackアカウントを選びます。そうでない場合は、汎用ユーザーとしてSlackボックスのインテグレーションアカウントを使用できます。
この時点で、次のようになっているはずです。
次にSet up actionに進み、以下の情報を入力します。
設定は次のようになります。
最後に、このZapierワークフローを手動でテスト実行できます。実行結果は次のようになります。
Zapierワークフローを確認してテストを実行したら、Publish Zapボタンをクリックします。これでワークフローが有効になり、トリガーとして設定した定期スケジュールに基づく自動化が開始されます。
Slack APIをほかのAPIに接続する方法
Zapierを使えば、チャンネルメッセージの送信以外にもSlackボットAPIを構築できます。Zapierを活用したSlackボットのJavaScriptアイデアをいくつか紹介します。Googleスプレッドシートの行が更新されたときにSlackメッセージを送る、Googleカレンダーの予定が近づいたらSlackチャンネルに通知する、新しいTwitterのメンションをSlackで共有する、Googleカレンダーの予定やほかのアクティビティに合わせてSlackのステータスを更新する、といった自動化が可能です。
ZapierとRedditのインテグレーションが完成しました!
今回は、一般公開されているJSONエンドポイントまたはReddit OAuth APIキーを使って、Redditの注目ニュースをチャンネルメッセージとして自動送信するSlackボットの作成方法を紹介しました。
最後に、JavaScriptコードを使ったSlackボットのインテグレーションを構築する場合は、関連するJavaScriptセキュリティのベストプラクティスに従い、リスクを理解したうえで、セキュリティ上の問題によってビジネスを危険にさらさないようにしてください。