TweepyをTwitter API v2経由で利用する

秘密鍵・接続情報を格納して読み取る

JSONで読み取る場合

各種キー情報をtwitter_key.jsonファイルにjson形式で保存します。

{
  "consumer_key": "xxxxxxxxx",
  "consumer_secret": "xxxxxxxxx",
  "bearer_token": "xxxxxxxxxxxx",
  "access_token": "xxxxxxxxx",
  "access_token_secret": "xxxxxxxxxxxxxx"
}

twitter_key.json

アプリファイルで、jsonファイルを読み込みます。

import tweepy
import json

with open('twitter_key.json') as f:
    twitter_keys = json.load(f)

app.py

configモジュールを用いて読み取る場合

config.pyという名称のpythonファイルを作成します。

API_KEY = "xxxxxxxxx"
API_KEY_SECRET = "xxxxxxxxxx"
BEARER_TOKEN = "xxxxxxxxxx"
ACCESS_TOKEN = "xxxxxxxx"
ACCESS_TOKEN_SECRET =  "xxxxxxxxxxxxxx"

PATH = "xxxxxxxxxxxxxxxxx"

config.py

PATHはpythonモジュールのファイルパスを指定しておきますが、特に記述しなくてもOK。

アプリファイル内でtweepyライブラリとconfigモジュールをインポート。

import tweepy
import config

app.py

Clientクラスからインスタンスを作成

tweepyの提供するClientクラスから、インスタンスを生成します。

Clientクラスから生成することで、接続認証済のインスタンスを得ることができます。

キー情報から認証済インスタンスを作成

各種認証情報を引数にとり、clientインスタンスを作成します。

基本的な”App”での利用の場合、Twitter API v2の場合にはBearer Tokenによる認証のみで足ります。

client = tweepy.Client(twitter_keys['bearer_token'])

Twitter API v2の利用の場合、通常はBearer TokenのみでOK

以下はすべての認証情報を読み込ませる場合。

JSONファイルからキー情報を格納する場合は下記。

client = tweepy.Client(bearer_token=twitter_keys['bearer_token'],
                        consumer_key=twitter_keys['consumer_key'],
                        consumer_secret=twitter_keys['consumer_secret'],
                        access_token=twitter_keys['access_token'],
                        access_token_secret=twitter_keys['access_token_secret'])

JSONファイルからキー情報を格納する場合

configライブラリでconfig.pyに格納したキー情報を用いる場合は下記。

client = tweepy.Client(bearer_token=config.BEARER_TOKEN,
                        consumer_key=config.API_KEY,
                        consumer_secret=config.API_KEY_SECRET,
                        access_token=config.ACCESS_TOKEN,
                        access_token_secret=config.ACCESS_TOKEN_SECRET)

configライブラリを用いる場合

これで生成したclientに対して、さまざまなAPI操作が可能となりました。

Twitter API v2の機能”Recent Search”を実行

Twitter API v2の機能である、Recent Search（直近7日間から該当するツイートを取得）を呼び出してみます。

Tweepy公式Docsを見ると、Recent Searchはさまざまな引数を取ることができますが、必須となっている引数はquery（指定検索ワード）のみです。

ここでは、queryとmax_results（呼び出し上限数の指定）を引数に指定して、実行します。

max_resultsの値は10以上、100以下である必要があります。max_resultsを指定しない場合のデフォルト値は10です。

client.search_recent_tweets(query="SEOコンサルティング", max_results=20)

返ってきたclientの内容を出力すると、Response(data=…)というResponseオブジェクトが返ってくるのが分かります。

Responseオブジェクト

Responseオブジェクトのもつ属性

Responseオブジェクトは、以下の属性を持ちます。

data
includes
errors
meta

Response — tweepy 4.12.1 documentation

先程のRecent Searchを行った場合で成功した場合だと、返ってきたResponseオブジェクトはdata属性とmeta属性を含んでいることが、clientの内容から分かりました。

data属性は返ってきたデータの中身、meta属性ではそのデータ群のメタ属性（最新のツイートid, 合計取得数）などを持っています。

data属性の中身

clientを介してRecent Searchを呼び出したときの実行結果を変数に格納し、data属性の中身を見てみます。

recent_tweets = client_sample.search_recent_tweets(query="SEOコンサルティング", max_results=20)
print(recent_tweets.data)

すると、以下のようにそれぞれ1つの中身がid属性とtext属性をもつリストが返ってきました。

[<Tweet id=1xxxxxxx text='tweet contents 1'>, <Tweet id=1yyyyyyyyy text='@someone tweet contents 2 ……]

ツイートの中身だけ抽出して出力する

返ってきたリストで一番最初のツイートの、コンテンツ中身だけを取り出してみます。

recent_tweets.data[0].text

これで中身が取り出せたので、for文でid情報とtext情報をかんたんに整形して出力してみます。

for recent_tweet in recent_tweets.data:
    id, text = recent_tweet.id, recent_tweet.text
    print(f"{id} || {text}\n")

これで簡易的なツイート検索分析ができるようになりました。

もっと本格的な分析がしたい場合には、CSVに吐き出したりpandasを用いて分析するのが良いでしょう。

Tweepy公式ドキュメントの実装サンプルを参考にする

公式Tweepyドキュメントには、API v1.1 と API v2 それぞれにおける、いくつかの実装サンプルが用意されています。

場所が分かりにくいのですが、META > Examples にありました。

Examples - tweepy 4.12.1 documentation

import tweepy # Your app's API/consumer key and secret can be found under the Consumer Keys # section of the Keys and Tokens tab of your app, under the # Twitter Developer Portal Projects & Apps page at # https://developer.twitter.com/en/portal/projects-and-apps consumer_key = "" consumer_secret = "" # Your account's (the