開発

【Part1】Twitter検索APIを使ってみよう Postmanを使ってノーコードで検索結果を取得

作成日: 2021年8月6日


初めに

この記事は、TwitterAPIでツイート検索結果を取得するまでの記録です。 Twitterの開発者アカウントの取得と、プロジェクト作成は済んでいる前提とします。

次のような方におすすめです。

  • Twitter APIを使うため、まず初めにサンプルコードを試したけどうまくいかなくて挫折した
  • APIを試し打ちしながら少しずつ理解したい

検索関連の2つのエンドポイントが存在する

Twitterには検索機能があり、当然APIにも検索用のエンドポイントが用意されています。エンドポイントは2つ存在します。

1. 最近の検索(recent)

1週間以内に投稿されたツイートを検索できる。

2. フルアーカイブ検索(all)

2006年3月まで遡ってツイートを検索できる。学術研究プロジェクトとして承認を受けたアカウントのみ利用可能なエンドポイントで、申請し認められなければ利用できない様です。

フルアーカイブ検索は利用要件が厳しいため、今回は「最近の検索(recent)」を使います。

Postmanを使って試してみよう

postman

それほどお急ぎでなければ、いきなりコーディングして試す前にノーコードでAPIを試せるツール「Postman」で理解を深めることを推奨します。

Postmanアカウント作成

Postmanのアカウントをお持ちで無い方はアカウントを作成します。

Twitter API v2 Postmanコレクションをワークスペースに追加

PostmanでTwitterAPIを試すためのTwitter API v2 PostmanというものがTwitterによって用意されていますのでこれを使います。コレクションはPostmanにおけるライブラリ的な存在です。

追加方法

Twitter API v2 Postmanを開き、Run in Postmanボタンをクリックすると、Postman上でTwitterAPIが使用可能になります。 成功すると、Collectionsタブに「Twitter API v2」というコレクションが追加されます。

リクエスト認証設定(ベアラートークン)

検索リクエストにあたっては、OAuth 2.0 Bearer Tokenでの認証が必要となります。 Postmanを使うことで、認証周りの処理をノーコードで実現できます。

Twitterベアラートークンの取得

TwitterDeveloperポータル https://developer.twitter.com/en/portal/projects-and-apps にアクセスし、ProjectAppのベアラートークンを取得しておいてください。

Postman上の手順

  1. 今回使うエンドポイント「最近の検索(recent)」に対応するフォルダに移動(Twitter API v2 > Search Tweets > Recent search)
  2. Authタブを選択
  3. Typeのセレクトボックスから「Bearer Token」を選択
  4. Tokenの欄にベアラートークンをコピペ
  5. Save(ctlr + S)

以上でリクエスト認証設定は完了です。

リクエストのパラメーター設定

Twitter検索APIではパラメーターとして様々な項目が指定できますが、まずは必要最小限「Query(検索語句)」だけでリクエストしてみます。

先程の「Auth」タブから「Params」タブに切り替えると、テーブルが表示されます。 この一番上の行のqueryのVALUEに検索したいキーワードを入力します。

postman-params

リクエストしてみよう

ここまでの設定を行なった上で、Sendボタンを押すとリクエスト実行できます。

成功するとレスポンスが表示されます。ツイートの「id」と「text」が取得できているかと思います。

これで必要最低限、TwitterAPIでツイート検索結果を取得することができました。

いいね・リツイート数を取得してみよう

先程のparamsタブに「query」以外のパラメーターがあることにお気づきでしょうか?

この中から「tweet.fields」という行にチェックを入れてください。

そしてVALUEにpublic_metricsと入力してください。

postman-params-public-metrics

入力後Sendボタンを押すと、新たにpublic_metricsという値が取得できているかと思います。 この内部にいいね数(like_count)やリツイート数(retweet_count)など詳細情報が入っています。

これでいいね・リツイート数を取得することができました。

他にも試してみたいという方はTwitter公式のAPIドキュメントに目を通しつつ、Postmanで実行してみましょう。

まとめ

やったこと

Twitter APIを使ってツイートを検索しツイート本文やいいね・リツイート数などを取得する。

わかったこと

ノーコードでAPIを試したい時はPostmanが便利。

次やること

APIの理解を深め、コードに落とし込む(近日公開予定)