Twitter 研究会2012-1-28 - Twitter APIの紹介

Copyright(c) Yusuke Yamamoto All rights reserved.

Twitter APIの紹介

2012/01/28

Twitter4J - 山本裕介


@yusukey

Java用Twitter APIライブラリ


Twitter APIの種類

Copyright(c) Yusuke Yamamoto All rights reserved. 5

Twi$er'API�

REST'API'

��API�

�#05*4��API�

Web��#��API�

� :'-%�1�(0'��:'Java,'Objec8ve9C'

"��# (�(0,'�5&�'Java,'Python,'PHP,'Ruby,'Objec8ve9C'

� :'Web��#'��:'HTML,'JavaScript'

Streamed'Tweets'

.5�5�#05+� ��#�#05+�

!�5#)�4'

Web'Intents�

@Anywhere�

��+/�4'

!�5#'

'�35'

��4#'

��2�#, �5�'

0�#'

��'

#24$'

��'

'�35)�4'


Twitter APIの基本


Twitter APIの基本• アプリケーションの登録と権限• OAuth認証

• 認証の種類


アプリケーション• Twitterにアクセスする単位

• ユーザーとは異なる• ユーザーはアプリケーションにアクセス権限を委譲する


アプリケーションの登録• https://dev.twitter.com/apps/new より

https://dev.twitter.com/apps/new

https://dev.twitter.com/apps/new


Application Type : 重要


アクセスタイプ

アクセスタイプ Read, Write, &Access direct messages

Read & Write Read only

タイムラインなどの取得 ○ ○ ○ツイート ○ ○ ×

ダイレクトメッセージ送信 ○ ○ ×ダイレクトメッセージ受信・削除 ○ × ×

デフォルト


OAuth


Sign in with Twitter


XAuth


REST API


REST API• REST: REpresentational State Transfer

• HTTPでAPI呼び出しGET /1/statuses/public_timeline.json HTTP/1.1Host: api.twitter.com

HTTP/1.1 200 OKDate: Tue, 08 Feb 2011 07:52:51 GMTServer: hiStatus: 200 OKContent-Type: application/json; charset=utf-8Vary: Accept-EncodingConnection: close

[{"source": "<a href=\"http://foursquare.com\" rel=\"nofollow\">foursquare<\/a>", "text": "I'm at IKEA 新三郷店 (新三郷ららシティ2-2-2, 三郷市) [pic]: http://4sq.com/eOHZdS", ... "user": { "description": "Javaエンジニア山本裕介。\r\n映画、アーチェリー、Java 好き\r\n#twitter4j #samurai", "name": "山本裕介", ...} }, ...]

リクエスト

レスポンスヘッダ

レスポンスボディ

16


Twitter のREST API• 全部で100近くのメソッド

• 20の「リソース」に分類されている

• リソース毎にパスが異なるTimelineリソース http://api.twitter.com/statuses/***.jsonUserリソース http://api.twitter.com/users/***.jsonDirect messageリソース http://api.twitter.com/direct_messages/***.json 等

http://api.twitter.com/statuses/***




http://api.twitter.com/users/***.json

http://api.twitter.com/users/***.json

http://api.twitter.com/direct_messages/***.json

http://api.twitter.com/direct_messages/***.json


検索API


検索 API• プル型‣ 最近のツイートを検索• https://twitter.com/#!/search-homeとほぼ同じ機能

19


検索 APIの呼び出し• エンドポイント(GET)

‣ http://search.twitter.com/search.json?q=****

• qパラメータq : 検索クエリ

・ #twtr_hackを含むツイート

q=#twtr_hack

・@yusukeyの#twtr_hackを含むツイート

q=#twtr_hack+from:yusukey

20


ページ処理ベストプラクティス

・rppは100まで、pageは15まで

最大1500件までしか取れない→max_idパラメータで回せばok

Twitter4Jを使った例21

Query query = new Query(term); query.rpp(100);do { QueryResult qr = twitter.search(query); tweets = qr.getTweets(); for (Tweet tweet : tweets) { // ... } if (tweets.size() != 0) { query.setMaxId(tweets.get(tweets.size() - 1).getId() - 1); }} while (tweets.size() != 0);


ストリーミングAPI


ストリーミングAPI• ツイート、DMなどを受信し続けられる

• レートリミットがない• 利用出来る場面ではREST APIより優先的に利用

• 技術• 普通のHTTP

• レスポンスに終わりがない• cometでもWebSocketでもない


デモ$ wget --output-document=- --user=*** --password=*** https://stream.twitter.com/1/statuses/sample.json

https://stream.twitter.com/1/statuses/sample.json





ストリーミングAPIの種類• Streamed Tweets

• パブリックタイムラインを取得

• User Stream

• 単一ユーザーのタイムライン、イベントを取得

• Site Stream

• 複数ユーザーのタイムライン、イベントを取得


sample• パブリックなツイートのうち1%を取得

• エンドポイント(GET)

‣ https://stream.twitter.com/1/statuses/sample.json

• パラメータ‣ なし• レスポンス‣ statusオブジェクトのjson (REST APIと同じ)

http://search.twitter.com/search.json?q=****



sample• 使いどころ• ツイート分析‣ 言語

‣ クライアント

‣ 流行の固有名詞抽出

• 等々


FAQ

• sample.jsonを複数接続すれば・・・・

• 同じツイートが返るので無意味。１%以上はとれない


filter• 指定した条件のツイートを取得• エンドポイント(POST)

‣ https://stream.twitter.com/1/statuses/filter.json

• パラメータ‣ follow, track, locations

• レスポンス‣ statusオブジェクトのjson (REST APIと同じ)




User Stream• 単一ユーザーのタイムライン、イベントを取得

• 目的: デスクトップの通知ツールなど

• タイムラインのツイート、DM、fav / follow等を受信

• プロテクトアカウントのツイートも受信可能• 要OAuth( or XAuth)


Site Stream(beta)• 複数ユーザーのタイムライン、イベントを取得

• 目的: Twitter連携するサービスなど

• タイムラインのツイート、DM、fav / follow等を受信

• プロテクトアカウントのツイートも受信可能• 要OAuth


Site Streamのコネクション管理• 接続時に指定できるユーザーは100人まで

• 事前にOAuth認証しておく必要がある

• コントロールストリームでユーザーの追加、削除可能

• 1コネクションで最大1000人まで受信可能


コントロールストリーム• Site Stream接続時にコントロール用エンドポイントが返る

• RESTでコントロール用エンドポイントを操作

https://dev.twitter.com/docs/streaming-api/control-streams

{"control": { "control_uri":"/2b/site/c/1_1_54e345d655ee3e8d"}}

https://sitestream.twitter.com/2b/site/c/1_1_54e345d655ee3e8d"



https://sitestream.twitter.com/2b/site/c/1_1_54e345d655ee3e8df359a

https://sitestream.twitter.com/2b/site/c/1_1_54e345d655ee3e8df359a


ベストプラクティス• とにかく使う• 参照系はレートリミット回避のためできるかぎりREST

APIよりもStreaming APIを利用

• gzipを使う

• 帯域を節約

• 接続ネットワークを確認• 3G接続での利用は推奨されない。接続が切られることも


FAQ• ストリーミングAPIはJavaScriptから使える？

• 使えない。サーバサイドの仕組みが必要

• 1%以上のツイートにアクセスしたい

• http://gnip.com/

• firehoseは？

• 一般に提供はされていない

http://gnip.com

http://gnip.com


Webサイト向けAPI


Web Intents• リンクで簡単にTwitterと連携

http://bit.ly/web-intents

<script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script>

<a href="http://twitter.com/intent/retweet?tweet_id=163049746431348736">リツイート</a>



http://platform.twitter.com/widgets.js




http://twitter.com/intent/retweet?tweet_id=163049746431348736





@Anywhere• JavaScriptでサーバサイドなしにTwitterと連携


@Anywhere

@yusukey をフォローしましょう<script type="text/javascript"> twttr.anywhere(function (T) { T.hovercards({expanded:true}); });</script>

http://bit.ly/hover-cards




Twitterボタン


ウィジェット


情報源•Twitter development talk-ja

•dev.twitter.com - Discussions

http://bit.ly/tdt-ja

https://dev.twitter.com/discussions

http://bit.ly/twtr_devjp

http://bit.ly/twtr_devjp




@twj_dev

@twitterapi


Twitter API ポケットリファレンス

• 好評発売中！

http://amzn.to/iUeXjm44

http://bit.ly/wls_twtr

http://bit.ly/wls_twtr

Twitter 研究会2012-1-28 - Twitter APIの紹介

Technology

Transcript of Twitter 研究会2012-1-28 - Twitter APIの紹介