GET lists/subscribers/show - リストを購読しているかチェックする

GET lists/subscribers/show - リストを購読しているかチェックする

このページでは、Twitter Rest APIのエンドポイント、lists/subscribers/show(GETメソッド)について、説明しています。指定したユーザーが、リストを保存している購読者か、を確認するためのエンドポイントです。

概要

Twitterのリスト機能
Twitterのリスト機能

lists/subscribers/showは、指定したユーザーが、リストを保存している購読者か、を確認するためのエンドポイントです。保存している場合は、ユーザーオブジェクトが返ります。保存していない場合は、ステータスコードが404のエラーが返ります。公式ドキュメントでは、アプリケーション認証でも利用できる案内になっていますが、2015年8月現在、実際にリクエストするとエラーが返ります…。

リスト関連の用語

リストの用語一覧です。リストには「作成者」「メンバー」「購読者」の、3種類の立場があります。それらの用語を、こんがらないようにして下さい。

用語説明
ownerオーナー。リストの作成者。
memberメンバー。リストのタイムラインに表示されるユーザー。
subscribers加入者。リストを保存して、購読しているユーザー。

リクエスト方法

lists/subscribers/showのリクエスト概要を説明します。

エンドポイント

GET https://api.twitter.com/1.1/lists/subscribers/show.json

条件

ユーザー認証アプリケーション認証
対応
パーミッションRead Only-
レートリミット15 / 15min15 / 15min
ユーザー認証
アクセストークンを用いたリクエスト。ユーザー認証のため、プライベートなデータにアクセスできる。
アクセストークンの取得方法
アプリケーション認証
ベアラートークンを用いたリクエスト。パブリックなデータのみ、取得できる。
ベアラートークンの取得方法
パーミッション
アプリケーションに設定する権限。下記3種類がある。
Read Only … アカウントのデータを取得する
Read and Write … アカウントのデータを取得、更新する。
Read,Write and Access direct messages … データの取得、更新に加え、ダイレクトメッセージを取得する。
パーミッションの設定方法

パラメータ

下記のパラメータをオプションとして指定できます。

list_id
リストID。
例: 207539950
slug
リストのスラッグowner_screen_name、またはowner_idと併せて指定する必要がある。
例: developers
owner_screen_name
リストをスラッグ(slug)で指定する場合、オーナーを指定する必要がある。スクリーンネームで指定する場合は、このプロパティを利用する。
例: SyncerJP
owner_id
リストをスラッグ(slug)で指定する場合、オーナーを指定する必要がある。ユーザーIDで指定する場合は、このプロパティを利用する。
例: 2905085521
user_id
ユーザーID。
例: 1528352858
screen_name
スクリーンネーム。@は含めても含まなくてもどちらでもいい。
例: @arayutw
include_entities
ツイートオブジェクト内のentitiesプロパティを含めるか否か。
例: true
skip_status
ユーザーオブジェクト内のstatusプロパティを除外するか否か。trueの場合は除外する。
例: true

取得できるJSON

リクエスト成功時に取得できるJSONのサンプルです。私が、友人のSPYDER氏のリスト(ID: 212343934)を保存(購読)しているか否かを調べ、保存していた例です。このJSONには、ユーザーオブジェクトツイートオブジェクトが含まれます。

JSON

{"id":1528352858,"id_str":"1528352858","name":"\u3042\u3089\u3086","screen_name":"arayutw","location":"Japan","description":"\u8db3\u7acb\u533a\u5728\u4f4f\u3001\u30a6\u30a7\u30d6\u5236\u4f5c\u304c\u5927\u597d\u304d\u3067\u3059\u3002","url":"http:\/\/t.co\/ScEV7AVZSN","entities":{"url":{"urls":[{"url":"http:\/\/t.co\/ScEV7AVZSN","expanded_url":"http:\/\/syncer.jp","display_url":"syncer.jp","indices":[0,22]}]},"description":{"urls":[]}},"protected":false,"followers_count":804,"friends_count":517,"listed_count":45,"created_at":"Tue Jun 18 17:28:51 +0000 2013","favourites_count":2024,"utc_offset":32400,"time_zone":"Tokyo","geo_enabled":true,"verified":false,"statuses_count":9731,"lang":"ja","status":{"created_at":"Wed Aug 12 07:47:02 +0000 2015","id":631371297029623809,"id_str":"631371297029623809","text":"\u5b9a\u3043\u671f\u304f\u3068\u3055\u3093","source":"\u003ca href=\"http:\/\/twitter.com\" rel=\"nofollow\"\u003eTwitter Web Client\u003c\/a\u003e","truncated":false,"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,"retweet_count":0,"favorite_count":0,"entities":{"hashtags":[],"symbols":[],"user_mentions":[],"urls":[]},"favorited":false,"retweeted":false,"lang":"ja"},"contributors_enabled":false,"is_translator":false,"is_translation_enabled":true,"profile_background_color":"292F33","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/631043341841371136\/qYPuEGQK.png","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/631043341841371136\/qYPuEGQK.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_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/1528352858\/1439290452","profile_link_color":"D36015","profile_sidebar_border_color":"F2E195","profile_sidebar_fill_color":"FFF7CC","profile_text_color":"0C3E53","profile_use_background_image":true,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"follow_request_sent":false,"notifications":false}

プログラムのテスト

手軽にlists/subscribers/showのエンドポイントを試したい人のために、コンソールを用意しました。オプションパラメータを調整して、リクエストを試すことができます。アプリケーション認証(application)とユーザー認証(user)、2種類の認証を試せますが、ユーザー認証のご利用には、あなたのアカウントを利用することになります。ご利用後はお手数ですが、アプリケーション連携を解除して下さい。

include_entities
skip_status
認証方法

アプリケーション連携の解除は、下記ページから行なって下さい。アプリケーションが、あなたの操作(デモの確認)なしで、データにアクセスすることはありません。

サンプルプログラム

lists/subscribers/showのエンドポイントを利用するためのサンプルプログラムを用意しました。各種トークンの情報をセットしてから、PHPで起動してみて下さいね。リクエストが成功すると、$jsonという変数に、目的のデータが代入されます。後は、このデータを整形するなり、保存するなり、活用して下さい。

ベアラートークン

PHP

<?php
/**************************************************

	[GET lists/subscribers/show]のお試しプログラム

	認証方式: ベアラートークン

	配布: SYNCER
	公式ドキュメント: https://dev.twitter.com/rest/reference/get/lists/subscribers/show
	日本語解説ページ: https://syncer.jp/twitter-api-matome/get/lists/subscribers-show

**************************************************/

	// 設定
	$bearer_token = '' ;	// ベアラートークン
	$request_url = 'https://api.twitter.com/1.1/lists/subscribers/show.json' ;		// エンドポイント

	// パラメータ
	$params = array(
		'list_id' => '207539950' ,		// リストID (どちらか必須)
		'slug' => 'developers' ,		// スラッグ (どちらか必須)
//		'owner_screen_name' => 'SyncerJP' ,		// オーナーのスクリーンネーム 
//		'owner_id' => '2905085521' ,		// オーナーのユーザーID 
		'user_id' => '1528352858' ,		// ユーザーID (どちらか必須)
		'screen_name' => '@arayutw' ,		// スクリーンネーム (どちらか必須)
//		'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;">lists/subscribers/show</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/twitter-api-matome/get/lists/subscribers-show" target="_blank">SYNCER</a></small>' ;

	// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
	echo $html ;

?>

アクセストークン

PHP

<?php
/**************************************************

	[GET lists/subscribers/show]のお試しプログラム

	認証方式: アクセストークン

	配布: SYNCER
	公式ドキュメント: https://dev.twitter.com/rest/reference/get/lists/subscribers/show
	日本語解説ページ: https://syncer.jp/twitter-api-matome/get/lists/subscribers-show

**************************************************/

	// 設定
	$api_key = '' ;		// APIキー
	$api_secret = '' ;		// APIシークレット
	$access_token = '' ;		// アクセストークン
	$access_token_secret = '' ;		// アクセストークンシークレット
	$request_url = 'https://api.twitter.com/1.1/lists/subscribers/show.json' ;		// エンドポイント
	$request_method = 'GET' ;

	// パラメータA (オプション)
	$params_a = array(
		'list_id' => '207539950' ,		// リストID (どちらか必須)
		'slug' => 'developers' ,		// スラッグ (どちらか必須)
//		'owner_screen_name' => 'SyncerJP' ,		// オーナーのスクリーンネーム 
//		'owner_id' => '2905085521' ,		// オーナーのユーザーID 
		'user_id' => '1528352858' ,		// ユーザーID (どちらか必須)
		'screen_name' => '@arayutw' ,		// スクリーンネーム (どちらか必須)
//		'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;">lists/subscribers/show</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/twitter-api-matome/get/lists/subscribers-show" target="_blank">SYNCER</a></small>' ;

	// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
	echo $html ;

?>

ダウンロード

サンプルプログラムをこちらからダウンロードできます。素敵なウェブサービスができたら、ぜひ、教えて下さい。

ファイル一覧

SYNCER0046081
get--lists--subscribers-show-00.php Download
get--lists--subscribers-show-01.php Download

ファイル名をクリックすると内容を確認できます。「Download Zip」をクリックするとファイル一式をダウンロードできます。

Download Zip