GET users/suggestions/:slug - おすすめユーザーを取得する
公開日:
users/suggestions/:slug(GETメソッド)は、おすすめユーザーを取得するエンドポイントです。取得するには、サジェストのカテゴリを表すスラッグを指定します。
- GET users/suggestions/:slug
- Twitterの公式リファレンス(英語)。users/suggestions/:slugに関する説明があります。
リソース
エンドポイント
GET https://api.twitter.com/1.1/users/suggestions/:slug.json
条件
項目 | ユーザー認証 | アプリケーション認証 |
---|---|---|
利用 | ● | × |
パーミッション | Read | - |
レートリミット | 15 / 15min | - |
パラメータ
:slug
指定例: twitter
カテゴリを表すスラッグ。エンドポイントに含めること。
lang
指定例: ja
検索の対象となる地域の言語コード。
レスポンス
アクセストークン(OAuth1.0)でリクエストをした場合の例です。
リクエストURL
https://api.twitter.com/1.1/users/suggestions/%E3%83%86%E3%83%AC%E3%83%93%E3%82%BF%E3%83%AC%E3%83%B3%E3%83%88.json?lang=ja
リクエストヘッダー
Authorization: OAuth lang=ja,oauth_consumer_key=:consumer_key,oauth_nonce=0.69556000+1484739007,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484739007,oauth_token=:access_token,oauth_version=1.0,oauth_signature=D7t4wRT8eukjFjDK6Wg2H5fQ8gI%3D
レスポンスボディ (JSON)
JSON
{"users":[{"id":320638233,"id_str":"320638233","name":"\u30d9\u30c3\u30ad\u30fc\u266a\u266f","screen_name":"Becky_bekiko","location":"\u304b\u306a\u304c\u308f\u3051\u3093","description":"\u30d9\u30c3\u30ad\u30fc\u306a\u306e\u304b\u3082\u3057\u308c\u306a\u3044\uff01","url":"https:\/\/t.co\/tzdy9guOJ4","entities":{"url":{"urls":[{"url":"https:\/\/t.co\/tzdy9guOJ4","expanded_url":"http:\/\/www.becky-music.jp","display_url":"becky-music.jp","indices":[0,23]}]},"description":{"urls":[]}},"protected":false,"followers_count":2104834,"friends_count":1,"listed_count":8961,"created_at":"Mon Jun 20 08:07:02 +0000 2011","favourites_count":50,"utc_offset":32400,"time_zone":"Tokyo","geo_enabled":false,"verified":true,"statuses_count":13178,"lang":"ja","contributors_enabled":false,"is_translator":false,"is_translation_enabled":true,"profile_background_color":"C0DEED","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/280130003\/twitter-pick-__.jpeg","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/280130003\/twitter-pick-__.jpeg","profile_background_tile":true,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/625851457544138752\/KrWPOuRh_normal.jpg","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/625851457544138752\/KrWPOuRh_normal.jpg","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/320638233\/1438948481","profile_link_color":"0084B4","profile_sidebar_border_color":"C0DEED","profile_sidebar_fill_color":"DDEEF6","profile_text_color":"333333","profile_use_background_image":true,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"follow_request_sent":false,"notifications":false},{"id":313682511,"id_str":"313682511","name":"\u5409\u9ad8\u7531\u91cc\u5b50","screen_name":"ystk_yrk","location":"\u6771\u4eac","description":"\u5409\u9ad8\u7531\u91cc\u5b50\u306a\u308f\u3051\u3067\u3059\n\u304c\n\u7a81\u7136Twitter\u306f\u3058\u3081\u307e\u3059\n\u304c\n\u307d\u3064\u3089\u307d\u3064\u3089\n\u8a00\u8449\n\u3053\u307c\u3057\u3066\u3044\u304f\u3068\u601d\u3044\u307e\u3059\n\u304c\n\u6df1\u3044\u610f\u5473\u306f\u3042\u308a\u307e\u305b\u3093","url":"http:\/\/t.co\/mWUP9MSC7m","entities":{"url":{"urls":[{"url":"http:\/\/t.co\/mWUP9MSC7m","expanded_url":"http:\/\/artist.amuse.co.jp\/artist\/yoshitaka_yuriko\/","display_url":"artist.amuse.co.jp\/artist\/yoshita\u2026","indices":[0,22]}]},"description":{"urls":[]}},"protected":false,"followers_count":2772147,"friends_count":0,"listed_count":12632,"created_at":"Thu Jun 09 01:46:35 +0000 2011","favourites_count":0,"utc_offset":-36000,"time_zone":"Hawaii","geo_enabled":false,"verified":true,"statuses_count":1496,"lang":"ja","contributors_enabled":false,"is_translator":false,"is_translation_enabled":false,"profile_background_color":"1A1B1F","profile_background_image_url":"http:\/\/abs.twimg.com\/images\/themes\/theme9\/bg.gif","profile_background_image_url_https":"https:\/\/abs.twimg.com\/images\/themes\/theme9\/bg.gif","profile_background_tile":false,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/519776354670100481\/XNu9mW6E_normal.png","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/519776354670100481\/XNu9mW6E_normal.png","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/313682511\/1428212704","profile_link_color":"2FC2EF","profile_sidebar_border_color":"181A1E","profile_sidebar_fill_color":"252429","profile_text_color":"666666","profile_use_background_image":true,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"follow_request_sent":false,"notifications":false},{"id":181839142,"id_str":"181839142","name":"\u9ed2\u6728\u30e1\u30a4\u30b5","screen_name":"Meisa_Kuroki","location":"","description":"\u9ed2\u6728\u30e1\u30a4\u30b5\u3067\u3059\u3002\u6642\u3005\u3064\u3076\u3084\u304d\u307e\u3059\u3002","url":"https:\/\/t.co\/AQYpO9ogdf","entities":{"url":{"urls":[{"url":"https:\/\/t.co\/AQYpO9ogdf","expanded_url":"http:\/\/www.sweetpower.jp\/","display_url":"sweetpower.jp","indices":[0,23]}]},"description":{"urls":[]}},"protected":false,"followers_count":635675,"friends_count":6,"listed_count":4198,"created_at":"Mon Aug 23 05:03:45 +0000 2010","favourites_count":12,"utc_offset":32400,"time_zone":"Tokyo","geo_enabled":true,"verified":true,"statuses_count":2344,"lang":"ja","contributors_enabled":false,"is_translator":false,"is_translation_enabled":false,"profile_background_color":"343536","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/145552605\/bg_black.jpg","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/145552605\/bg_black.jpg","profile_background_tile":true,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/749244200936361985\/RD8ia2kZ_normal.jpg","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/749244200936361985\/RD8ia2kZ_normal.jpg","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/181839142\/1457112681","profile_link_color":"0084B4","profile_sidebar_border_color":"C0DEED","profile_sidebar_fill_color":"DDEEF6","profile_text_color":"333333","profile_use_background_image":true,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"follow_request_sent":false,"notifications":false}],"size":3,"slug":"\u30c6\u30ec\u30d3\u30bf\u30ec\u30f3\u30c8","name":"\u30c6\u30ec\u30d3\u30bf\u30ec\u30f3\u30c8"}
レスポンスヘッダー
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: 28237
content-type: application/json;charset=utf-8
date: Wed, 18 Jan 2017 11:30:08 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Wed, 18 Jan 2017 11:30:08 GMT
pragma: no-cache
server: tsa_m
set-cookie: guest_id=v1%3A148473900776372389; Domain=.twitter.com; Path=/; Expires=Fri, 18-Jan-2019 11:30:08 UTC
status: 200 OK
strict-transport-security: max-age=631138519
x-access-level: read
x-connection-hash: cd77dc08c5d2f69e7cfec90456f5d4d6
x-content-type-options: nosniff
x-frame-options: SAMEORIGIN
x-rate-limit-limit: 15
x-rate-limit-remaining: 14
x-rate-limit-reset: 1484739907
x-response-time: 376
x-transaction: 001eb8b60038d4d0
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block
デモ
users/suggestions/:slugのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(読取権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。
サンプルコード
users/suggestions/:slugのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$json
という変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。
アクセストークン
PHP (OAuth1.0)
<?php
/**************************************************
[GET users/suggestions/:slug]のお試しプログラム
認証方式: アクセストークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/get/users/suggestions/slug
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/GET/users/suggestions/slug/
**************************************************/
// 設定
$api_key = '' ; // APIキー
$api_secret = '' ; // APIシークレット
$access_token = '' ; // アクセストークン
$access_token_secret = '' ; // アクセストークンシークレット
$request_url = 'https://api.twitter.com/1.1/users/suggestions/twitter.json' ; // エンドポイント
$request_method = 'GET' ;
// パラメータA (オプション)
$params_a = array(
// "lang" => "ja",
) ;
// キーを作成する (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 users/suggestions/:slug</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/users/suggestions/slug/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;