GET lists/subscribers - リストの購読者を取得する
公開日:
lists/subscribers(GETメソッド)は、対象のリストを保存して、購読者になっているユーザーの一覧を取得するエンドポイントです。
- GET lists/subscribers
- Twitterの公式リファレンス(英語)。lists/subscribersに関する説明があります。
リソース
エンドポイント
GET https://api.twitter.com/1.1/lists/subscribers.json
条件
項目 | ユーザー認証 | アプリケーション認証 |
---|---|---|
利用 | ● | ● |
パーミッション | Read | - |
レートリミット | 180 / 15min | 15 / 15min |
パラメータ
list_id
指定例: 198828364
対象のリストの、リストID。
slug
指定例: developers
対象のリストの、スラッグ。owner_screen_name、またはowner_idと併せて指定する必要がある。
owner_screen_name
指定例: arayutw
リストのオーナー(作成者)の、スクリーンネーム。slugでリストを指定する場合に必要。
owner_id
指定例: 1528352858
リストのオーナー(作成者)の、ユーザーID。slugでリストを指定する場合に必要。
count
指定例: 10
結果の数。1
〜5000
の間で指定する。
cursor
指定例: 599056298085224449
ページングをする際の取得開始位置を示すカーソルを指定する。カーソルは、リクエストした際のprevious_cursor
(前ページ)、またはnext_cursor
(次ページ)に含まれる。
include_entities
指定例: true
ツイートオブジェクト内のentitiesプロパティを含めるか否か。
skip_status
指定例: true
ユーザーオブジェクト内のstatusプロパティを除外するか否か。true
の場合は除外する、false
の場合は除外しない。
レスポンス
アクセストークン(OAuth1.0)でリクエストをした場合の例です。
リクエストURL
https://api.twitter.com/1.1/lists/subscribers.json?list_id=198828364&count=3&include_entities=true&skip_status=false
リクエストヘッダー
Authorization: OAuth count=3,include_entities=true,list_id=198828364,oauth_consumer_key=:consumer_key,oauth_nonce=0.70234700+1484713812,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484713812,oauth_token=:access_token,oauth_version=1.0,skip_status=false,oauth_signature=hzdciahQVgmjRHSvNpMx7fWwZHE%3D
レスポンスボディ (JSON)
JSON
{"users":[{"id":1528352858,"id_str":"1528352858","name":"\u3042\u3089\u3086","screen_name":"arayutw","location":"\u6771\u4eac\u90fd\u8db3\u7acb\u533a","description":"SYNCER\u3068\u3044\u3046\u30b5\u30a4\u30c8\u3092\u904b\u7528\u3057\u3066\u3044\u307e\u3059\u3002\u63b2\u793a\u677f\u2192 https:\/\/t.co\/OAIDbACF3N","url":"https:\/\/t.co\/lW3GYq8sQl","entities":{"url":{"urls":[{"url":"https:\/\/t.co\/lW3GYq8sQl","expanded_url":"https:\/\/syncer.jp\/","display_url":"syncer.jp","indices":[0,23]}]},"description":{"urls":[{"url":"https:\/\/t.co\/OAIDbACF3N","expanded_url":"https:\/\/forum.syncer.jp\/","display_url":"forum.syncer.jp","indices":[26,49]}]}},"protected":false,"followers_count":1418,"friends_count":564,"listed_count":114,"created_at":"Tue Jun 18 17:28:51 +0000 2013","favourites_count":4455,"utc_offset":32400,"time_zone":"Asia\/Tokyo","geo_enabled":true,"verified":false,"statuses_count":34815,"lang":"ja","status":{"created_at":"Wed Jan 18 02:04:36 +0000 2017","id":821538753608986624,"id_str":"821538753608986624","text":"RT @SyncerJP: \u5730\u7344\u3081\u3050\u308a\u306e\u7d39\u4ecb\u8a18\u4e8b\u3067\u3059\uff01\n\n\u304b\u307e\u3069\u5730\u7344@\u5225\u5e9c\u5730\u7344\u3081\u3050\u308a-\u30e6\u30cb\u30fc\u30af\u306a\u30aa\u30d6\u30b8\u30a7\u3068\u8272\u3068\u308a\u3069\u308a\u306e\u6e29\u6cc9\u3092\u697d\u3057\u3082\u3046\uff01\nhttps:\/\/t.co\/osLZs3s3I4","truncated":false,"entities":{"hashtags":[],"symbols":[],"user_mentions":[{"screen_name":"SyncerJP","name":"SYNCER","id":2905085521,"id_str":"2905085521","indices":[3,12]}],"urls":[{"url":"https:\/\/t.co\/osLZs3s3I4","expanded_url":"https:\/\/syncer.jp\/Travel\/Oita\/Kamado-jigoku\/","display_url":"syncer.jp\/Travel\/Oita\/Ka\u2026","indices":[68,91]}]},"source":"\u003ca href=\"http:\/\/twitter.com\" rel=\"nofollow\"\u003eTwitter Web Client\u003c\/a\u003e","in_reply_to_status_id":null,"in_reply_to_status_id_str":null,"in_reply_to_user_id":null,"in_reply_to_user_id_str":null,"in_reply_to_screen_name":null,"geo":null,"coordinates":null,"place":null,"contributors":null,"retweeted_status":{"created_at":"Wed Jan 18 02:01:59 +0000 2017","id":821538093844992000,"id_str":"821538093844992000","text":"\u5730\u7344\u3081\u3050\u308a\u306e\u7d39\u4ecb\u8a18\u4e8b\u3067\u3059\uff01\n\n\u304b\u307e\u3069\u5730\u7344@\u5225\u5e9c\u5730\u7344\u3081\u3050\u308a-\u30e6\u30cb\u30fc\u30af\u306a\u30aa\u30d6\u30b8\u30a7\u3068\u8272\u3068\u308a\u3069\u308a\u306e\u6e29\u6cc9\u3092\u697d\u3057\u3082\u3046\uff01\nhttps:\/\/t.co\/osLZs3s3I4","truncated":false,"entities":{"hashtags":[],"symbols":[],"user_mentions":[],"urls":[{"url":"https:\/\/t.co\/osLZs3s3I4","expanded_url":"https:\/\/syncer.jp\/Travel\/Oita\/Kamado-jigoku\/","display_url":"syncer.jp\/Travel\/Oita\/Ka\u2026","indices":[54,77]}]},"source":"\u003ca href=\"http:\/\/twitter.com\" rel=\"nofollow\"\u003eTwitter Web Client\u003c\/a\u003e","in_reply_to_status_id":null,"in_reply_to_status_id_str":null,"in_reply_to_user_id":null,"in_reply_to_user_id_str":null,"in_reply_to_screen_name":null,"geo":null,"coordinates":null,"place":null,"contributors":null,"is_quote_status":false,"retweet_count":2,"favorite_count":2,"favorited":false,"retweeted":true,"possibly_sensitive":false,"lang":"ja"},"is_quote_status":false,"retweet_count":2,"favorite_count":0,"favorited":false,"retweeted":true,"possibly_sensitive":false,"lang":"ja"},"contributors_enabled":false,"is_translator":false,"is_translation_enabled":true,"profile_background_color":"2660A1","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/632205394824183808\/FIL3S4z4.png","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/632205394824183808\/FIL3S4z4.png","profile_background_tile":false,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/631038167416619008\/7xfGAEwp_normal.png","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/631038167416619008\/7xfGAEwp_normal.png","profile_link_color":"D36015","profile_sidebar_border_color":"F2E195","profile_sidebar_fill_color":"FFF7CC","profile_text_color":"0C3E53","profile_use_background_image":false,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"follow_request_sent":false,"notifications":false,"translator_type":"regular"}],"next_cursor":0,"next_cursor_str":"0","previous_cursor":0,"previous_cursor_str":"0"}
レスポンスヘッダー
HTTP/1.1 200 OK
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0
content-disposition: attachment; filename=json.json
content-length: 4408
content-type: application/json;charset=utf-8
date: Wed, 18 Jan 2017 04:30:12 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Wed, 18 Jan 2017 04:30:12 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148471381276457689; Domain=.twitter.com; Path=/; Expires=Fri, 18-Jan-2019 04:30:12 UTC
status: 200 OK
strict-transport-security: max-age=631138519
x-access-level: read
x-connection-hash: cf5e56f97298c70e3d4b0d0d55d62a3b
x-content-type-options: nosniff
x-frame-options: SAMEORIGIN
x-rate-limit-limit: 180
x-rate-limit-remaining: 179
x-rate-limit-reset: 1484714712
x-response-time: 167
x-transaction: 00ec66e50032a45b
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block
デモ
lists/subscribersのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(読取権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。
サンプルコード
lists/subscribersのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$json
という変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。
ベアラートークン
PHP (OAuth2.0)
<?php
/**************************************************
[GET lists/subscribers]のお試しプログラム
認証方式: ベアラートークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/get/lists/subscribers
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/GET/lists/subscribers/
**************************************************/
// 設定
$bearer_token = '' ; // ベアラートークン
$request_url = 'https://api.twitter.com/1.1/lists/subscribers.json' ; // エンドポイント
// パラメータ (オプション)
$params = array(
"list_id" => "198828364",
// "slug" => "developers",
// "owner_screen_name" => "arayutw",
// "owner_id" => "1528352858",
// "count" => "10",
// "cursor" => "599056298085224449",
// "include_entities" => "true",
// "skip_status" => "true",
) ;
// パラメータがある場合
if( $params ) {
$request_url .= '?' . http_build_query( $params ) ;
}
// リクエスト用のコンテキスト
$context = array(
'http' => array(
'method' => 'GET' , // リクエストメソッド
'header' => array( // ヘッダー
'Authorization: Bearer ' . $bearer_token ,
) ,
) ,
) ;
// cURLを使ってリクエスト
$curl = curl_init() ;
curl_setopt( $curl , CURLOPT_URL , $request_url ) ;
curl_setopt( $curl , CURLOPT_HEADER, 1 ) ;
curl_setopt( $curl , CURLOPT_CUSTOMREQUEST , $context['http']['method'] ) ; // メソッド
curl_setopt( $curl , CURLOPT_SSL_VERIFYPEER , false ) ; // 証明書の検証を行わない
curl_setopt( $curl , CURLOPT_RETURNTRANSFER , true ) ; // curl_execの結果を文字列で返す
curl_setopt( $curl , CURLOPT_HTTPHEADER , $context['http']['header'] ) ; // ヘッダー
curl_setopt( $curl , CURLOPT_TIMEOUT , 5 ) ; // タイムアウトの秒数
$res1 = curl_exec( $curl ) ;
$res2 = curl_getinfo( $curl ) ;
curl_close( $curl ) ;
// 取得したデータ
$json = substr( $res1, $res2['header_size'] ) ; // 取得したデータ(JSONなど)
$header = substr( $res1, 0, $res2['header_size'] ) ; // レスポンスヘッダー (検証に利用したい場合にどうぞ)
// [cURL]ではなく、[file_get_contents()]を使うには下記の通りです…
// $json = @file_get_contents( $request_url , false , stream_context_create( $context ) ) ;
// JSONをオブジェクトに変換 (処理をする場合)
// $obj = json_decode( $json ) ;
// HTML用
$html = '' ;
// タイトル
$html .= '<h1 style="text-align:center; border-bottom:1px solid #555; padding-bottom:12px; margin-bottom:48px; color:#D36015;">GET lists/subscribers</h1>' ;
// 検証用
$html .= '<h2>取得したデータ</h2>' ;
$html .= '<p>下記のデータを取得できました。</p>' ;
$html .= '<h3>ボディ(JSON)</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $json . '</textarea></p>' ;
$html .= '<h3>レスポンスヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $header . '</textarea></p>' ;
// 検証用
$html .= '<h2>リクエストしたデータ</h2>' ;
$html .= '<p>下記内容でリクエストをしました。</p>' ;
$html .= '<h3>URL</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $context['http']['method'] . ' ' . $request_url . '</textarea></p>' ;
$html .= '<h3>ヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . implode( "\r\n" , $context['http']['header'] ) . '</textarea></p>' ;
// フッター
$html .= '<small style="display:block; border-top:1px solid #555; padding-top:12px; margin-top:72px; text-align:center; font-weight:700;">プログラムの説明: <a href="https://syncer.jp/Web/API/Twitter/REST_API/GET/lists/subscribers/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;
アクセストークン
PHP (OAuth1.0)
<?php
/**************************************************
[GET lists/subscribers]のお試しプログラム
認証方式: アクセストークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/get/lists/subscribers
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/GET/lists/subscribers/
**************************************************/
// 設定
$api_key = '' ; // APIキー
$api_secret = '' ; // APIシークレット
$access_token = '' ; // アクセストークン
$access_token_secret = '' ; // アクセストークンシークレット
$request_url = 'https://api.twitter.com/1.1/lists/subscribers.json' ; // エンドポイント
$request_method = 'GET' ;
// パラメータA (オプション)
$params_a = array(
"list_id" => "198828364",
// "slug" => "developers",
// "owner_screen_name" => "arayutw",
// "owner_id" => "1528352858",
// "count" => "10",
// "cursor" => "599056298085224449",
// "include_entities" => "true",
// "skip_status" => "true",
) ;
// キーを作成する (URLエンコードする)
$signature_key = rawurlencode( $api_secret ) . '&' . rawurlencode( $access_token_secret ) ;
// パラメータB (署名の材料用)
$params_b = array(
'oauth_token' => $access_token ,
'oauth_consumer_key' => $api_key ,
'oauth_signature_method' => 'HMAC-SHA1' ,
'oauth_timestamp' => time() ,
'oauth_nonce' => microtime() ,
'oauth_version' => '1.0' ,
) ;
// パラメータAとパラメータBを合成してパラメータCを作る
$params_c = array_merge( $params_a , $params_b ) ;
// 連想配列をアルファベット順に並び替える
ksort( $params_c ) ;
// パラメータの連想配列を[キー=値&キー=値...]の文字列に変換する
$request_params = http_build_query( $params_c , '' , '&' ) ;
// 一部の文字列をフォロー
$request_params = str_replace( array( '+' , '%7E' ) , array( '%20' , '~' ) , $request_params ) ;
// 変換した文字列をURLエンコードする
$request_params = rawurlencode( $request_params ) ;
// リクエストメソッドをURLエンコードする
// ここでは、URL末尾の[?]以下は付けないこと
$encoded_request_method = rawurlencode( $request_method ) ;
// リクエストURLをURLエンコードする
$encoded_request_url = rawurlencode( $request_url ) ;
// リクエストメソッド、リクエストURL、パラメータを[&]で繋ぐ
$signature_data = $encoded_request_method . '&' . $encoded_request_url . '&' . $request_params ;
// キー[$signature_key]とデータ[$signature_data]を利用して、HMAC-SHA1方式のハッシュ値に変換する
$hash = hash_hmac( 'sha1' , $signature_data , $signature_key , TRUE ) ;
// base64エンコードして、署名[$signature]が完成する
$signature = base64_encode( $hash ) ;
// パラメータの連想配列、[$params]に、作成した署名を加える
$params_c['oauth_signature'] = $signature ;
// パラメータの連想配列を[キー=値,キー=値,...]の文字列に変換する
$header_params = http_build_query( $params_c , '' , ',' ) ;
// リクエスト用のコンテキスト
$context = array(
'http' => array(
'method' => $request_method , // リクエストメソッド
'header' => array( // ヘッダー
'Authorization: OAuth ' . $header_params ,
) ,
) ,
) ;
// パラメータがある場合、URLの末尾に追加
if( $params_a ) {
$request_url .= '?' . http_build_query( $params_a ) ;
}
// オプションがある場合、コンテキストにPOSTフィールドを作成する (GETの場合は不要)
// if( $params_a ) {
// $context['http']['content'] = http_build_query( $params_a ) ;
// }
// cURLを使ってリクエスト
$curl = curl_init() ;
curl_setopt( $curl, CURLOPT_URL , $request_url ) ;
curl_setopt( $curl, CURLOPT_HEADER, 1 ) ;
curl_setopt( $curl, CURLOPT_CUSTOMREQUEST , $context['http']['method'] ) ; // メソッド
curl_setopt( $curl, CURLOPT_SSL_VERIFYPEER , false ) ; // 証明書の検証を行わない
curl_setopt( $curl, CURLOPT_RETURNTRANSFER , true ) ; // curl_execの結果を文字列で返す
curl_setopt( $curl, CURLOPT_HTTPHEADER , $context['http']['header'] ) ; // ヘッダー
// if( isset( $context['http']['content'] ) && !empty( $context['http']['content'] ) ) { // GETの場合は不要
// curl_setopt( $curl , CURLOPT_POSTFIELDS , $context['http']['content'] ) ; // リクエストボディ
// }
curl_setopt( $curl , CURLOPT_TIMEOUT , 5 ) ; // タイムアウトの秒数
$res1 = curl_exec( $curl ) ;
$res2 = curl_getinfo( $curl ) ;
curl_close( $curl ) ;
// 取得したデータ
$json = substr( $res1, $res2['header_size'] ) ; // 取得したデータ(JSONなど)
$header = substr( $res1, 0, $res2['header_size'] ) ; // レスポンスヘッダー (検証に利用したい場合にどうぞ)
// [cURL]ではなく、[file_get_contents()]を使うには下記の通りです…
// $json = file_get_contents( $request_url , false , stream_context_create( $context ) ) ;
// JSONをオブジェクトに変換
$obj = json_decode( $json ) ;
// HTML用
$html = '' ;
// タイトル
$html .= '<h1 style="text-align:center; border-bottom:1px solid #555; padding-bottom:12px; margin-bottom:48px; color:#D36015;">GET lists/subscribers</h1>' ;
// エラー判定
if( !$json || !$obj ) {
$html .= '<h2>エラー内容</h2>' ;
$html .= '<p>データを取得することができませんでした…。設定を見直して下さい。</p>' ;
}
// 検証用
$html .= '<h2>取得したデータ</h2>' ;
$html .= '<p>下記のデータを取得できました。</p>' ;
$html .= '<h3>ボディ(JSON)</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $json . '</textarea></p>' ;
$html .= '<h3>レスポンスヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $header . '</textarea></p>' ;
// 検証用
$html .= '<h2>リクエストしたデータ</h2>' ;
$html .= '<p>下記内容でリクエストをしました。</p>' ;
$html .= '<h3>URL</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . $context['http']['method'] . ' ' . $request_url . '</textarea></p>' ;
$html .= '<h3>ヘッダー</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . implode( "\r\n" , $context['http']['header'] ) . '</textarea></p>' ;
// フッター
$html .= '<small style="display:block; border-top:1px solid #555; padding-top:12px; margin-top:72px; text-align:center; font-weight:700;">プログラムの説明: <a href="https://syncer.jp/Web/API/Twitter/REST_API/GET/lists/subscribers/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;