14時04分31秒 [ソフト開発]
TwitterのAPIを使わずに任意のツイートを埋め込む方法
任意のツイートを埋め込むのにAPIは不要だった
拙作のフリーCGI「てがろぐ」に、任意のツイートを埋め込む機能を加えて欲しいという要望を以前から受けていました。
Twitter APIは、リクエストを送ればJSONでシンプルな情報を返してくるだけなので別に複雑さはなく簡単ではあるのですが、
Perlで記述しているCGIで、かつ、不特定多数に対して配布するフリーCGIなので、(どんなAPIでもですが)APIは利用しにくいのですよね。PHPほど簡単に他サーバにリクエストを投げてデータを受け取ったりできませんし。それ系のモジュールを読めば良いのですけども、CGI設置者のサーバに存在しないモジュールを必須にすると設置のハードルが上がってしまいますから。
というわけで後回しになっていたツイート埋め込み機能なのですが……、
つい最近、別にTwitterのAPIを使わなくてもURLだけで簡単に埋め込めるのだと知りまして、ツイート埋め込み機能をあっさり実装できました。
驚きです。
Twitter APIからJSON形式でデータを得るのが正攻法ですけども、ツイート本文をHTMLで得ておく必要がないなら、そんなことしなくてもツイートのURLさえ分かれば何でも埋め込める仕様だったのでした。
※Twitter側の仕様が変わらない限り、ですけども。(まあ、それは外部サービスを呼び出す以上、何でもそうですが。)
いろいろググって調べていたところで発見したブログ記事「【Twitter】埋め込み処理をAPIに投げずにローカルで行う」で知りました。感謝です。
Twitter APIを使ってツイートを埋め込む方法は少々面倒
Twitter APIにツイートのURLを送ると、ツイートの情報や埋め込み用のHTMLなどがJSON形式で返ってきます。
その中から「埋め込み用のHTML」を抜き出して表示に使えば、ツイートが埋め込めます。
ここで返ってくる埋め込み用のHTMLソースは、Twitter Publish で得られるHTMLと同じっぽいです。
スクリプトをPHPで書いていたら、APIにURLを送るのも、返ってきたJSONを解読するのも激しく簡単なので、短いコードだけで簡単に済みそうです。
どんなサーバ環境で実行されるか分からないフリーCGIをPerlで書いている場合には、ちょっと面倒だと思いますけども。(^_^;)
ただ、APIを利用する以上、リクエスト頻度には制限があるでしょうから、タイミングによっては反応が返ってこない場合もありそうす。(アクセス頻度が高い場合とか)
そういう問題を極力減らすためには、一度リクエストして返ってきたJSONデータを自サーバ側でキャッシュしておいて、次回以降はキャッシュから読むことで、APIの利用頻度を最小限にする手はありそうです。(最初はこの方法での実装を考えていました。)
が、まあ、何にしてもちょっと面倒ですね。
Twitter APIを使わなくても自力で最小限のHTMLを用意してウィジェットJavaScriptを読み込めば埋め込める
で、先のブログ記事で知った方法ですが、APIにリクエストを送ってデータをもらわなくても、以下の3点があれば任意のツイートを埋め込める仕様だったのでした。
- blockquote要素を1つ
<blockquote class="twitter-tweet">~</blockquote>
のように書く(中身にテキストはなくて良い) - その中にa要素を含めて、ツイート単独ページ(例)へのリンクを作る
- Twitter埋め込み用ウィジェットのJavaScriptを読み込む
これだけで、Twitter側のJavaScriptが、勝手にiframeを生成してblockquote要素をツイートに置き換えてくれるため、ツイートが埋め込まれます。
なので、最小限のソースは(たぶん)下記のような感じですね。
<blockquote class="twitter-tweet"> <a href="(埋め込みたいツイートのURL)"></a> </blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
最後ののTwitter側のJavaScript(widgets.js)は1度だけ読めば良いので、毎回出力する必要はありません。
▼APIを使わずにツイートを埋め込むデメリット
この方法を使うデメリットは、「ウィジェットJavaScriptが読めなかったら本文が読めない」ことでしょうかね。
API経由でツイートの本文も含めて取得していれば、Twitterっぽく埋め込めなくても(最悪でも)ツイートの本文は読めますから。
ただ、APIの仕様が変わったり反応がなかったりしたら結局は本文も表示できないわけですから、同じことな気はしますけども。
ツイート本文は(埋め込み完了までは)表示されないので、代わりの文字列を出力しておく
この方法だと、ツイート本文は(Twitter側のJavaScriptが処理してくれるまでは)読めないので、ツイートが埋め込まれるまでの待ち時間中には何も表示されません。
フリーCGIの機能として提供する場合、待ち時間に何も表示されないのもどうかと思いましたので、代わりに「(ツイート埋め込み処理中)」という文字列を表示するように出力させることにしました。
また、何らかの原因でJavaScriptが実行されなかった場合のために、ツイートへのURLを「tweet」という文字列でリンクにしてあります。それなら最悪でもユーザがクリックすれば当該ツイートを読めますから。
出力されるソースは以下のような感じです。
<blockquote class="twitter-tweet"> (ツイート埋め込み処理中) <a href="https://twitter.com/nishishi/status/1277915695032893440">tweet</a> </blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
blockquote要素の中に書いてあるテキストは(Twitter側のJavaScriptで)単純に置き換えられるようなので、どんな文字列を書いて置いても構わないようでした。(^_^;)
a要素の中身も同様に何でも良いので、例えばもっと分かりやすく「ツイートが埋め込まれなかったらここをクリック」みたいなラベルでリンクさせておいても良い気がします。
というわけで、TwitterのAPIを使わずに任意のツイートを埋め込む方法があった、という話でした。