Twitter API friendshipsの使い方
フレンド関連のAPI 【メソッド一覧】
| friendships/create | 指定ユーザを自分の friend (following) にする id, user_id, screen_name のいずれかの引数を必ず指定すること |
|---|---|
| friendships/destroy | 指定ユーザを自分の friend (following) から外す id, user_id, screen_name のいずれかの引数を必ず指定すること |
| friendships/exists | 指定した2ユーザの間の friend 関係を調べる |
| friendships/show | 指定した2ユーザの間の関係を詳細に調べる 調査対象となる「関係」はfollowing (follow しているかどうか) followed_by (follow されているかどうか) notifications_enabled (IM での購読対象にしているかどうか)の3つ |
friendships/createの使い方
URL: http://twitter.com/friendships/create/id.format
(format は xml, json のうちのいずれかを指定)
引数:
id=ユーザID または id=スクリーン名 (オプション)
friend にしたいユーザを指定する
例:
http://twitter.com/friendships/create/12345.json
ユーザID 12345 の人を friend にするリクエストを発行し、実行結果を JSON 形式で取得する
http://twitter.com/friendships/create/bob.xml
スクリーン名 bob の人を friend にするリクエストを発行し、実行結果を XML 形式で取得する
user_id=ユーザID (オプション)
指定した ID のユーザを friend にする
例:
http://twitter.com/friendships/create.xml?user_id=1401881
ユーザID 1401881 を friend にする
screen_name=スクリーン名 (オプション)
指定したスクリーン名のユーザを friend にする
例:
http://twitter.com/friendships/create.xml?screen_name=101010
スクリーン名 101010 を friend にする
(この場合、101010 はユーザIDではなく、スクリーン名であることに注意)
follow (オプション)
id引数で指定したユーザをfriendにすると同時に、そのユーザの発言を IM に送信するようにするかどうかを指定する
例:
http://twitter.com/friendships/create/bob.json?follow=true
スクリーン名 bob の人を friend にし、その発言を IM に送信するようにするリクエストを発行し、実行結果を JSON 形式で取得する
メソッド: POST
API制限: 適用対象外
ただし、一定時間辺りの実行回数上限が設定されている
1日辺り 1000回まで (API による実行以外に、Web での実行、モバイルでの実行もカウント対象)
上限に到達すると、それ以降は 403 エラーが返るようになる
friendships/destroyの使い方
URL: http://twitter.com/friendships/destroy/id.format
(format は xml, json のうちのいずれかを指定)
引数:
id=ユーザID または id=スクリーン名 (オプション)
friend から外したいユーザを指定する
例:
http://twitter.com/friendships/destroy/12345.json
ユーザID 12345 の人を friend から外すリクエストを発行し、実行結果を JSON 形式で取得する
http://twitter.com/friendships/destroy/bob.xml
スクリーン名 bob の人を friend から外すリクエストを発行し、実行結果を XML 形式で取得する
user_id=ユーザID (オプション)
指定した ID のユーザを friend から外す
例:
http://twitter.com/friendships/destroy.xml?user_id=1401881
ユーザID 1401881 を friend から外す
screen_name=スクリーン名 (オプション)
指定したスクリーン名のユーザを friend から外す
例:
http://twitter.com/friendships/destroy.xml?screen_name=101010
スクリーン名 101010 を friend から外す
(この場合、101010 はユーザIDではなく、スクリーン名であることに注意)
メソッド: POST または DELETE
API制限: 適用対象外
friendships/existsの使い方
URL: http://twitter.com/friendships/create/id.format
(format は xml, json のうちのいずれかを指定)
指定した2ユーザの間の friend 関係を調べる
URL: http://twitter.com/friendships/exists.format
(format は xml, json のうちのいずれかを指定)
引数:
user_a=調査対象のうち1人目のユーザID または スクリーン名 (必須)
user_b=調査対象のうち2人目のユーザID または スクリーン名 (必須)
例:
http://twitter.com/friendships/exists.xml?user_a=alice&user_b=bob
スクリーン名 alice の人と bob の人の間に friend 関係があるかどうか調べ、結果を XML 形式で取得する
メソッド: GET
API制限: 適用対象
friendships/exists API サンプル
私達AP_chanとtakapon_jpは友達ですか？ | 答えは・・・true
friendships/showの使い方
URL: http://twitter.com/friendships/show.format
(format は xml, json のうちのいずれかを指定)
引数:
以下の引数のうち、どちらか1つを指定する (認証なしで本APIを使う場合は必須。認証ありの場合はオプション)
source_id=調査対象のうち1人目のユーザID
source_screen_name=調査対象のうち1人目のスクリーン名
認証ありの場合、上記引数を省略した場合は、調査対象の「1人目のユーザ」は自分自身になる
以下の引数のうち、どちらか1つを指定する (必須)
target_id=調査対象のうち2人目のユーザID
target_screen_name=調査対象のうち2人目のスクリーン名
例:
http://twitter.com/friendships/show.xml?source_id=123&target_id=456
ユーザID 123 の人とユーザID 456 の人の間にどんな関係があるかどうか調べ、結果を XML 形式で取得する
http://twitter.com/friendships/show.xml?source_id=bob&target_id=jack
スクリーン名 bob の人とスクリーン名 jack の人の間にどんな関係があるかどうか調べ、結果を XML 形式で取得する
メソッド: GET
API制限: 適用対象