SYNCER

SYNCER

GET blocks/list - ブロックユーザーをオブジェクトで取得する

9件

公開日:

blocks/list(GETメソッド)は、認証ユーザー(アクセストークンの主)が、現在、ブロックしているユーザー一覧を、ユーザーオブジェクトで取得するためのエンドポイントです。

GET blocks/list
GET blocks/list
Twitterの公式リファレンス(英語)。blocks/listに関する説明があります。

リソース

エンドポイント

GET https://api.twitter.com/1.1/blocks/list.json

条件

項目ユーザー認証アプリケーション認証
利用×
パーミッションRead-
レートリミット15 / 15min-

パラメータ

include_entities

指定例: true

ツイートオブジェクト内のentitiesプロパティを含めるか否か。

skip_status

指定例: true

ユーザーオブジェクト内のstatusプロパティを除外するか否か。trueの場合は除外する、falseの場合は除外しない。

cursor

指定例: 599056298085224449

ページングをする際の取得開始位置を示すカーソルを指定する。カーソルは、リクエストした際のprevious_cursor(前ページ)、またはnext_cursor(次ページ)に含まれる。

レスポンス

アクセストークン(OAuth1.0)でリクエストをした場合の例です。

リクエストURL

https://api.twitter.com/1.1/blocks/list.json?include_entities=true&skip_status=false

リクエストヘッダー

Authorization: OAuth include_entities=true,oauth_consumer_key=:consumer_key,oauth_nonce=0.77095800+1484629543,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484629543,oauth_token=:access_token,oauth_version=1.0,skip_status=false,oauth_signature=PqMuT8VtJqm3TUHXATDBiPbaG84%3D

レスポンスボディ (JSON)

JSON

{"users":[{"id":783214,"id_str":"783214","name":"Twitter","screen_name":"Twitter","location":"San Francisco, CA","description":"Your official source for news, updates, and tips from Twitter, Inc. Need help? Visit https:\/\/t.co\/jTMg7YsLw5.","url":"https:\/\/t.co\/gN5JJwhQy7","entities":{"url":{"urls":[{"url":"https:\/\/t.co\/gN5JJwhQy7","expanded_url":"https:\/\/blog.twitter.com\/","display_url":"blog.twitter.com","indices":[0,23]}]},"description":{"urls":[{"url":"https:\/\/t.co\/jTMg7YsLw5","expanded_url":"https:\/\/support.twitter.com","display_url":"support.twitter.com","indices":[85,108]}]}},"protected":false,"followers_count":58539503,"friends_count":153,"listed_count":90507,"created_at":"Tue Feb 20 14:35:54 +0000 2007","favourites_count":3097,"utc_offset":-28800,"time_zone":"Pacific Time (US & Canada)","geo_enabled":true,"verified":true,"statuses_count":3772,"lang":"en","status":{"created_at":"Mon Jan 16 23:55:58 +0000 2017","id":821143992419000320,"id_str":"821143992419000320","text":"@MissAlexxMack Believe in the dream. Share the dream. Live the dream.","truncated":false,"entities":{"hashtags":[],"symbols":[],"user_mentions":[{"screen_name":"MissAlexxMack","name":"Alexx Mack","id":125515820,"id_str":"125515820","indices":[0,14]}],"urls":[]},"source":"\u003ca href=\"http:\/\/twitter.com\" rel=\"nofollow\"\u003eTwitter Web Client\u003c\/a\u003e","in_reply_to_status_id":821097139212152834,"in_reply_to_status_id_str":"821097139212152834","in_reply_to_user_id":125515820,"in_reply_to_user_id_str":"125515820","in_reply_to_screen_name":"MissAlexxMack","geo":null,"coordinates":null,"place":null,"contributors":null,"is_quote_status":false,"retweet_count":4,"favorite_count":9,"favorited":false,"retweeted":false,"lang":"en"},"contributors_enabled":false,"is_translator":false,"is_translation_enabled":false,"profile_background_color":"ACDED6","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/657090062\/l1uqey5sy82r9ijhke1i.png","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/657090062\/l1uqey5sy82r9ijhke1i.png","profile_background_tile":true,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/767879603977191425\/29zfZY6I_normal.jpg","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/767879603977191425\/29zfZY6I_normal.jpg","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/783214\/1484581893","profile_link_color":"226699","profile_sidebar_border_color":"FFFFFF","profile_sidebar_fill_color":"F6F6F6","profile_text_color":"333333","profile_use_background_image":true,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"live_following":false,"follow_request_sent":false,"notifications":false,"muting":false,"blocking":true,"blocked_by":false,"translator_type":"regular"},{"id":2905085521,"id_str":"2905085521","name":"SYNCER","screen_name":"SyncerJP","location":"Tokyo","description":"\u30d6\u30ed\u30b0\u300cSYNCER\u300d\u306e\u30a2\u30ab\u30a6\u30f3\u30c8\u3067\u3059\u3002\u8a18\u4e8b\u306b\u8a00\u53ca\u3057\u3066\u304f\u308c\u305f\u30c4\u30a4\u30fc\u30c8\u3092\u304a\u6c17\u306b\u5165\u308a\u767b\u9332\u3057\u305f\u308a\u3057\u307e\u3059\u3002 \u6700\u7d42\u66f4\u65b0\u65e5:2015\/05\/22","url":"https:\/\/t.co\/J5bOOK7ugS","entities":{"url":{"urls":[{"url":"https:\/\/t.co\/J5bOOK7ugS","expanded_url":"https:\/\/syncer.jp","display_url":"syncer.jp","indices":[0,23]}]},"description":{"urls":[]}},"protected":false,"followers_count":265,"friends_count":2,"listed_count":10,"created_at":"Thu Nov 20 11:17:51 +0000 2014","favourites_count":1621,"utc_offset":32400,"time_zone":"Tokyo","geo_enabled":true,"verified":false,"statuses_count":640,"lang":"ja","status":{"created_at":"Sun Jan 15 11:34:48 +0000 2017","id":820595085309931521,"id_str":"820595085309931521","text":"\u30c8\u30ec\u30f3\u30c9\u30ef\u30fc\u30c9\u3068\u30ea\u30c4\u30a4\u30fc\u30c8\u30e9\u30f3\u30ad\u30f3\u30b0\u306f\u3001\u3044\u3061\u3044\u3061\u8a18\u4e8b\u3092\u898b\u306a\u304f\u3066\u3082\u4e0b\u8a18\u306e\u30a2\u30ab\u30a6\u30f3\u30c8\u30671\u65e51\u56de\u3001\u767a\u8868\u3057\u3066\u3044\u304d\u307e\u3059\u3002\u3088\u308d\u3057\u3051\u308c\u3070\u30bf\u30a4\u30e0\u30e9\u30a4\u30f3\u3092\u8997\u3044\u3066\u307f\u3066\u4e0b\u3055\u3044\u306d\ud83d\ude00\n\nhttps:\/\/t.co\/uHGhz8Ed26","truncated":false,"entities":{"hashtags":[],"symbols":[],"user_mentions":[],"urls":[{"url":"https:\/\/t.co\/uHGhz8Ed26","expanded_url":"https:\/\/twitter.com\/syncer_sns","display_url":"twitter.com\/syncer_sns","indices":[80,103]}]},"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":1,"favorite_count":0,"favorited":false,"retweeted":true,"possibly_sensitive":false,"lang":"ja"},"contributors_enabled":false,"is_translator":false,"is_translation_enabled":false,"profile_background_color":"000000","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/600501255656448000\/1qe0CVbE.png","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/600501255656448000\/1qe0CVbE.png","profile_background_tile":true,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/604130129762074624\/5c0Rku36_normal.jpg","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/604130129762074624\/5c0Rku36_normal.jpg","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/2905085521\/1432005636","profile_link_color":"D36015","profile_sidebar_border_color":"C6E2EE","profile_sidebar_fill_color":"DAECF4","profile_text_color":"663B12","profile_use_background_image":true,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"live_following":false,"follow_request_sent":false,"notifications":false,"muting":false,"blocking":true,"blocked_by":false,"translator_type":"none"}],"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: 6256
content-type: application/json;charset=utf-8
date: Tue, 17 Jan 2017 05:05:43 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Tue, 17 Jan 2017 05:05:43 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148462954391159852; Domain=.twitter.com; Path=/; Expires=Thu, 17-Jan-2019 05:05:43 UTC
status: 200 OK
strict-transport-security: max-age=631138519
x-access-level: read
x-connection-hash: 68e80ac33a94a6533187dda4d16b7ba9
x-content-type-options: nosniff
x-frame-options: SAMEORIGIN
x-rate-limit-limit: 15
x-rate-limit-remaining: 13
x-rate-limit-reset: 1484630393
x-response-time: 136
x-transaction: 0014393300cf4edc
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block

デモ

blocks/listのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(読取権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。

include_entities

/

skip_status

/

cursor

認証方法 (ユーザー認証のみ)

/

サンプルコード

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

アクセストークン

PHP (OAuth1.0)

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

	[GET blocks/list]のお試しプログラム

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

	配布: SYNCER
	公式ドキュメント: https://dev.twitter.com/rest/reference/get/blocks/list
	日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/GET/blocks/list/

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

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

	// パラメータA (オプション)
	$params_a = array(
//		"include_entities" => "true",
//		"skip_status" => "true",
//		"cursor" => "599056298085224449",
	) ;

	// キーを作成する (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 blocks/list</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/blocks/list/" target="_blank">SYNCER</a></small>' ;

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