TwitterAPI.js

【2010-06-17 追記】
従来と同じ使い方のまま OAuth に対応した、TwitterAPI2.js を公開しました。

下記、TwitAPI.js に対するラッパになります。
詳細は、TwitterAPI2.js を参照して下さい。
【2010-06-12 追記】OAuth 対応版を公開しました
まだ完成度は低いですが、基本的な動作は可能になったので公開しました。インターフェースなどが変更になっていますが、基本的な使用感は変わりません。
TwitAPI.js

現状の TwitterAPI.js は 2010-06-30 2010-08-31 をもって利用できなくなります。
Twitter の BASIC 認証による API 提供が、6月末に終了することが正式発表され、BASIC 認証を利用している現状の TwitterAPI.js はそれと同時に利用できなくなります。TwitterAPI.js の OAuth への対応も検討していますが、現時点での予定は未定です。
従って、これから新しく何かを作成するのに、TwitterAPI.js を選択するのはお勧めしません。Twitter 公式の JavaScript ライブラリ @anywhere も、開発者向けに公開されているので、あわせてご検討下さい。
【追記】
BASIC 認証が不要な API については、7 月以降も TwitterAPI.js でそのまま利用可能な可能性もありますが、現時点では不明です。
【追記】
移行期限を 8 月 16 日まで延長し、8 月 31 日にかけて段階的に終了することがアナウンスされました。

»Download

»Download (Ver 0.9.2)

概要

Twitter の API を JavaScript から簡単に使うためのライブラリです。 上部の Download リンクより、js ファイルをダウンロードして読み込む事で様々なメソッドが利用可能になります。

<script type="text/javascript" src="js/twitterapi_x.x.x.js"></script>

特徴

  • Pure JS 実装なのでサーバサイドが不要
  • クロスドメイン対策を内部に隠蔽
  • API に存在するメソッドをそのまま JavaScript のメソッドとして実装
  • コールバック関数として、関数オブジェクトをそのまま渡せる
  • 外部の JS ライブラリに依存していない
  • 非圧縮で 7KB と軽めの実装
  • ブラウザによる BASIC 認証で動作する
  • 利用ページのエンコードが UTF-8 でない事による文字化けを回避 (Ver 0.9.3~)
  • POST メソッド使用時のコールバック関数にも一部対応 (Ver 0.9.3~)
  • 入力済みの BASIC 認証の再ログインを一部サポート (Ver 0.9.3~)

バージョン

まだ枯れているとは言い難いので、現在のバージョンは 0.9.4 です。 不具合がありましたら、コメントなどでお知らせ下さい。

サンプル

TwitterAPI.js を使うと、例えば以下のような事が出来ます。 以下のサンプルを最初に動作させた時は、ブラウザによる BASIC 認証のダイアログが立ち上がるので、Twitter のアカウントで認証して下さい。

≪Twitter で発言する≫

<script type="text/javascript">
  function post(f) {
    var status = f.status.value;
    TwitterAPI.statuses.update(status);
  }
</script>
:
<form>
<input type="text" name="status" style="width:300px" /><input type="button" onclick="post(this.form);" value="UPDATE" />
</form>

≪特定のユーザのタイムラインを取得する≫

<script type="text/javascript">
  function callback(arr) {
    var str = '';
    for (var i=0; i<arr.length; i++) {
      var obj = arr[i];
      str += obj.user.screen_name + ':' + obj.text + '<br />';
    }
    document.getElementById('result').innerHTML = str;
  }
  function getTl() {
    var id = document.getElementById('id').value;
    var param = 'count=10';
    TwitterAPI.statuses.user_timeline(callback, id, param);
  }
</script>
:
<form>
ID <input type="text" id="id" /><input type="button" onclick="getTl();" value="GET TL" />
<div id="result" style="height: 200px; overflow: auto; border: 1px solid #999; background: #ffe;"></div>
</form>
ID 

ここに結果が表示される

API ドキュメント

基本的には本家の API ドキュメントの記述をほぼそのまま使用する事が出来ます。
TwitterAPI.js を使用する場合の基本的な書き方は以下のような形です。

TwitterAPI.MethodName(callback, id, params);

このように書くと、MethodName に該当する同一名の API が実行され、callback で指定した関数に、結果の JSON オブジェクトが渡されます。
Twitter API については、日本語訳を公開して下さっている方がいるので参考にして下さい。
Twitter API 仕様書 (勝手に日本語訳シリーズ)

例えば、サンプルで使用した特定のユーザのタイムラインを取得するメソッドですが、Twitter API だと、以下のような URL です。

http://twitter.com/statuses/user_timeline/id.format?param

これに対応したメソッドは、以下のようになります。(format は json で固定)

TwitterAPI.statuses.user_timeline(callback, id, param)

このように、ほぼ全ての API はそれと同名の専用のメソッドが用意されています。
従って、TwitterAPI.js で使えるメソッドのドキュメントとしては、Twitter API のドキュメントをそのまま参照して下さい。
また、callback に何も指定しなければ、実行結果はそのまま捨てられ、id、param を設定しても無効な API の場合、それらの値は無視されます。

ただし、一部のメソッドには例外があります。以下ではその例外について説明します。

追加されたメソッド

TwitterAPI.users.own(callback, id, param);    // Ver 0.9.2~ 

元々の API には、ユーザデータを取得する http://twitter.com/users/show/id.format という API があり、id を指定しない事で自分自身のデータを取得する事が期待されるのですが、実際には id を指定しないとエラーになってしまいます。
そのため、TwitterAPI.js では、認証されたユーザ自身のデータを取得するためのメソッドを追加しました。

TwitterAPI.relogin();    // Ver 0.9.3~ 

通常、BASIC 認証による認証情報はブラウザ内に保持され、ブラウザを完全に終了するまで任意に書き換えられません。つまり一度ログインするとログアウト出来ないのが普通です。
そのブラウザの動作に対して、あえて偽情報を送り込む事で再認証のためのダイアログを発生させ、再ログインを実現するためのメソッドです。
ただ、セキュリティ的な制限から IE7 では動作しない事を確認しています。恐らく、IE8 でも同様です。
今後のアップデートにより、Firefox や Chrome でも使用出来なくなる可能性があるので、利用には注意を払って下さい。

名前が異なるメソッド

JavaScript の命名ルールの問題から、Twitter API と同じ名称を使用する事が出来なかったものがいくつかあります。
下記の API については別名のメソッドを呼び出して下さい。

// http://twitter.com/direct_messages.format
TwitterAPI.direct_messages.show(func, id, param);

// http://twitter.com/direct_messages/new.format
TwitterAPI.direct_messages.create(user, text);

// http://twitter.com/favorites.format
TwitterAPI.favorites.show(func, id, param);

// http://blocks/blocking.format
TwitterAPI.blocks.blocking.show(func, id, param);

動作が特殊なメソッド

以下のメソッドについては、情報の取得ではなく情報の送信 (POST) を行うためのメソッドであり、JavaScript の技術的制約から、結果を受け取る事が出来ません。
情報の送信にあたっては特別な処理を行うため、メソッドの呼び出し方も専用のものになっています。
また、実行結果を受け取る事は出来ませんが、Ver 0.9.3 より、任意のコールバック関数を実行出来るようになりました。POST 処理完了のタイミングで、コールバック関数が呼び出されます。
ただし、コールバック関数が有効に機能するのは IE 以外のブラウザです。その点には留意して利用して下さい。

TwitterAPI.statuses.update(status, func);
TwitterAPI.direct_messages.create(user, text, func);
TwitterAPI.account.update_location(location, func);

コールバック関数が対応ブラウザでしか動作しない事と、指定できる引数が固定されている点が他のメソッドと大きく異なりますが、その動作については同名の Twitter API と同じ動作をします。
動作の詳細については、API ドキュメントを参照して下さい。

さらに、以下のメソッドについては呼び出し方は他と同様であるものの、やはり情報の送信 (POST) を行うため、結果をコールバック関数で受け取る事が出来ません。
結果自体を受け取る事は出来ませんが、コールバック関数を指定した場合、対応ブラウザでは POST 処理完了時に呼び出されます。

friendships.create(func, id, param);
friendships.destroy(func, id, param);
favorites.create(func, id, param);
favorites.destroy(func, id, param);
blocks.create(func, id, param);
blocks.destroy(func, id, param);

除外したメソッド

以下のメソッドについては、使用頻度が低いと思われる事から実装を見送りました。
どうしても必要であれば、ソースを参照の上で、任意に追加して下さい。メソッドの追加自体は、JavaScript の文法を理解していればシンプルに出来るかと思います。

  • trends 系メソッド
  • saved_searches 系メソッド
  • oauth 系メソッド
  • report_spam 系メソッド

動作条件・制限事項・ライセンス

下記のブラウザで動作確認しています。
IE6 / IE7 / Firefox2 (~Ver 0.9.2) / Firefox3 / Firefox3.5 / Firefox3.6 / Chrome (Ver 0.9.3~)
未確認ですが、IE8 / Safari / Opera あたりでもそのまま動作すると思われます。

情報を送信するメソッドを使用する場合、JavaScript を実行している HTML が UTF-8 で書かれていないと、日本語が文字化けします。
POST メソッド使用時、元のページのエンコードにかかわらず、UTF-8 に変換して送信されるため、日本語の文字化けは発生しません。(Ver 0.9.3~)
※Chrome を除く。Chrome ではスクリプトで生成した iframe の文字コードが元の charset を引き継ぐ使用となっているためです(その他のブラウザはデフォルトで UTF-8)。charset を指定して iframe を生成する方法が分からないため、現状で対応出来ていません。

ライセンスは MIT License (日本版 wikipedia の項) で公開します。

更新履歴

Ver.0.9.4 [2010-01-26]
Firefox 3.6 に対応
エスケープの不具合を修正
Ver.0.9.3 [2009-11-02]
全面書き直し (コード最適化により機能増・容量減を達成)
API を最新に追随 Twitter API Documentation
search 系のメソッドを追加
TwitterAPI.relogin を追加
Ver.0.9.2 [2009-05-03]
TwitterAPI.users.own を追加
Ver.0.9.1 [2009-04-13]
TwitterAPI.friends.ids を追加
TwitterAPI.followers.ids
数値の ID を渡した時の不具合を修正
POST で実行しないといけない API を一部 GET で実行していた不具合を修正
Ver.0.9.0 [2009-03-19]
初公開

26 thoughts on “TwitterAPI.js

  1. こんにちは。TwitterAPIを利用させていただいているのですが、GoogleChorome(V3.0195)の時のみ文字化けしてしまいます。
    (FF3 Opera9.2.3は問題なしです。)
    ただ、この記事にある上記サンプルでTeitterに投稿しても文字化けしないようです。
    私のコードに問題ありなのかとも思うのですが、ただ
    twitter_com=”本日は晴天なり。123456″;
    TwitterAPI.statuses.update(twitter_com);
    で化けてしまうので頭を抱えています。
    使用バージョンは0.9.3です。
    何か解決のヒントとかあるでしょうか?

  2. 動作報告、ありがとうございます。

    コードを作成している、ページ (HTML) 自体の文字コードは何になっているでしょうか?
    Ver 0.9.3 より、「利用ページのエンコードが UTF-8 でない事による文字化けを回避」するように機能追加されているはずなのですが、それが Chrome では上手く動いていないという事かも知れません。

    UTF-8 以外の文字コードを使用している場合、試しに UTF-8 で HTML を保存して再度試してみてください。
    これで文字化けが解消した場合は、上記の原因で間違いありません。

    これが原因だとすると 現状の Ver 0.9.3 は Chrome 非対応という状態になります。色々と動作確認しないと実現可能かは分からないのですが、今後のバージョンにて対応できないか検討したいと思います。

    それまでの間は、HTML を UTF-8 にするなどで対応して頂くようお願いします。

  3. Otchyさん。さっそくのご返事ありがとうございました。UTF-8で保存しましたらChomeでもうまくいきました。(当然FF3でもOKでした)

    ありがとうございます!

  4. お役に立てて良かったです。
    明らかなバグなどあれば、是非フィードバックをお願いします。

  5. ◆はてブへの回答
    > XMLHttpRequest を使えば、(IE でも、IE 以外でも)結果を受け取れるし、コールバックも呼べると思うんだけど

    XHR を使った POST では、セキュリティ上、同一ドメインに対する POST しか出来ないため、Twitter API を JavaScript から叩くにはプロキシを必要とします。
    TwitterAPI.js は Pure JS 実装を信条としているので、別のアプローチからクロスドメインを解決しており、その制限として POST でのコールバックが難しくなっています。

  6. Ver 0.9.3 を利用させて頂いております。
    74行目のpost function中、value値のエスケープ処理を行っている箇所は、以下の誤記では無いかと思うのですが、いかがでしょうか。

    var val=vals[n]
    .replace(/&/g,’&’)
    .replace(/”/g,’"’)
    .replace(//g,’>’);

  7. ver 0.9.3 を利用させて頂いております。

    20行目のFirefoxチェックのワンライナー(/a/[-1]==’a’)ですが、Firefox 3.6からは利用出来なくなっているようです。
    ご参考まで。

  8. ご指摘ありがとうございます。
    このチェックは POST メソッド利用時のコールバックを実装している部分で使用しています。
    ~Fx3.5 では iframe の onunload イベント処理の実装が他のブラウザと異なっていたため、その差異を吸収するためのものです。
    Fx3.6 については未検証のため、検証後に対応方法を検討します。

  9. 以前、文字コードの件でアドバイスいただきました。その際はありがとうございました。前にkiyoharaさんも書かれていますが、FireFox3.6ですとPOSTされないようです。多くのブラウザ・バージョンに対応されるのは大変かと思いますが、ご検討いただければと思います。よろしくお願いいたします。

  10. > kiyohara さん
    エスケープのご指摘もありがとうございました。
    コメントが当初、スパムに誤判定されてしまっていて確認が遅れました。

    > まささん
    ご報告ありがとうございます。
    内容を確認して、対応を検討します。

  11. Otchyさん
    FireFox3.6への対応確認しました。ありがとうございました!

  12. ご確認いただきありがとうございました。

  13. 自分の環境ではChromeでの文字化けがこれで解決しました!
    formタグを書き込むところでaccept-charset=”UTF-8″と付け加えました。

  14. ピンバック: notes plastiques
  15. >aont さん
    ご連絡ありがとうございました!
    次バージョンで TwitterAPI.js にも取り込まさせてもらおうかと思います。

  16. こんにちは、こちらのライブラリ便利で、使わせてもらっています。
    6月末でbasic認証が終了とことなのですが、こちらのscriptは影響ありますでしょうか。
    http://bit.ly/bVaZNH

  17. 残念ながら、TwitterAPI.js は認証機構に BASIC 認証を使用しているため、BASIC 認証終了後は動作しなくなってしまいます。
    OAuth 認証を使用する形への修正も検討していますが、現段階では対応が未定です。

    Twitter 公式の JavaScript ライブラリ @Anywhere が発表されていますので、そちらの利用も検討してみて下さい。

  18. ご丁寧なお返事ありがとうございます!
    参考になりました!@Anywhere検討してみます。

  19. はじめまして。こちらのライブラリ使わしていただいています。ありがとうございます。
    「BASIC 認証終了後は動作しなくなってしまいます。」とのことですが、投稿ではなくjsonを取得するだけの場合も使えなくなってしまうのでしょうか?

  20. たしかに、発表されているのは BASIC 認証の廃止であって、認証が不要な API であれば、従来通り利用可能かも知れません。

    利用が推奨されている、OAuth 認証の場合も認証用のコードが付与される点以外は、既存の API 呼び出しと同様の方法で使用することになっています。
    つまり、API として利用する URL 自体には変更がないので、認証不要な API であれば 7 月以降もそのまま使える事が期待できそうです。
    いま個人的な事情で、事前に詳細を調べる余裕がないので、その時になってみないと分からないですが…。

  21. なるほど。お忙しいところご返信ありがとうございました。

  22. はじめまして。
    すみません。教えて下さい。
    HPにハッシュタグを出力したいのですがうまくいきません。

    param=”q=#sony_alpha”;
    TwitterAPI.search(callback, “”, param);
    .
    .
    .
    search:function(f,i,p){var t=TwitterAPI;t.get(t.cm(‘search’),f,p);},

    エラーにはならないのですが値が取れてこない状態です。
    function callback(arr) {
    var s = arr.length;
    }
    でsはundefinedが返ってきます。

    また、URLエンコードを
    param=”q=&23sony_alpha”;
    としても不可で、同じ結果でした。

    twitterapi_0.9.4.js
    を使用しています。

    ハッシュタグの取得方法、よろしければご教授願います。

  23. BASIC 認証の廃止に伴い、TwitterAPI.js は TwitAPI.js に移行しました。
    TwitterAPI.js については、今後、積極的な対応はしていかない予定ですので、TwitAPI.js の利用を検討してみて下さい。
    TwitAPI.js に関する問題については、TwitAPI.js のページでお尋ね頂ければ、対応を検討します。

コメントを残す

メールアドレスが公開されることはありません。