POST account/update_profile_banner - バナー画像を更新する
公開日:
account/update_profile_banner(POSTメソッド)は、プロフィールのバナー画像を更新するエンドポイントです。画像の最適なサイズは、users/profile_bannerのエンドポイントで調べられます。
バナーとして保存される画像はPNGです。画像の範囲は、offset_left(左端から何px離すか)とoffset_top(上端から何px離すか)で起点となる座標を決めて、width(横幅)とheight(高さ)で、そこからの横幅と高さを指定します。これら4つのプロパティは4つセットで指定しなければいけません。全て省略すると、自動で調整されます。
- POST account/update_profile_banner
- Twitterの公式リファレンス(英語)。account/update_profile_bannerに関する説明があります。
リソース
エンドポイント
POST https://api.twitter.com/1.1/account/update_profile_banner.json条件
| 項目 | ユーザー認証 | アプリケーション認証 |
|---|---|---|
| 利用 | ● | × |
| パーミッション | Read and Write | - |
| レートリミット | あり(Twitterルールを適用) | - |
パラメータ
banner
画像の、生のバイナリデータを指定する。
width
指定例: 100
起点から、右方向に何ピクセル使用するのかを数値で指定する。
height
指定例: 100
起点から、下方向に何ピクセル使用するのかを数値で指定する。
offset_left
左端から、右方向に何ピクセル離れた座標を起点とするのかを数値で指定する。
offset_top
上端から、下方向に何ピクセル離れた座標を起点とするのかを数値で指定する。
レスポンス
アクセストークン(OAuth1.0)でリクエストをした場合の例です。
リクエストURL
https://api.twitter.com/1.1/account/update_profile_banner.jsonリクエストヘッダー
Authorization: OAuth oauth_consumer_key=:consumer_key,oauth_nonce=0.77192800+1484800381,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484800381,oauth_token=:access_token,oauth_version=1.0,oauth_signature=MNXzeBdvZeLxtu5P9TF8ii4exUs%3Dリクエストボディ
--s-y-n-c-e-r---------------3bc80681d1c0e7eb1b962b5eae6764cf
Content-Disposition: form-data; name="banner";
�PNG
IHDR��];��0PLTE���
x��a����������������L9<��ᝀ��Ӵ���ñۀMa��
--s-y-n-c-e-r---------------3bc80681d1c0e7eb1b962b5eae6764cf--レスポンスボディ (JSON)
取得できるJSONはありません。
レスポンスヘッダー
HTTP/1.1 100 Continue
HTTP/1.1 201 Created
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0
content-length: 0
content-security-policy: default-src 'self'; connect-src 'self'; font-src 'self' https://*.twimg.com https://twitter.com https://ton.twitter.com data:; frame-src 'self' https://*.twimg.com https://twitter.com https://ton.twitter.com; img-src 'self' https://*.twimg.com https://twitter.com https://ton.twitter.com data:; media-src 'self' https://*.twimg.com https://twitter.com https://ton.twitter.com; object-src 'none'; script-src 'self' https://*.twimg.com https://twitter.com https://ton.twitter.com; style-src 'self' https://*.twimg.com https://twitter.com https://ton.twitter.com; report-uri https://twitter.com/i/csp_report?a=OBZG6ZTJNRSWE2LSMQ%3D%3D%3D%3D%3D%3D&ro=false;
content-type: text/html;charset=utf-8
date: Thu, 19 Jan 2017 04:33:03 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Thu, 19 Jan 2017 04:33:03 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148480038267870973; Domain=.twitter.com; Path=/; Expires=Sat, 19-Jan-2019 04:33:03 UTC
status: 201 Created
strict-transport-security: max-age=631138519
vary: Origin
x-access-level: read-write
x-connection-hash: b4847b2b448876ccd06037971222a4f3
x-frame-options: SAMEORIGIN
x-rate-limit-limit: 30
x-rate-limit-remaining: 26
x-rate-limit-reset: 1484801152
x-response-time: 950
x-transaction: 00bb441f00b8fa3e
x-tsa-request-body-time: 2
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=blockデモ
account/update_profile_bannerのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(書込権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。
サンプルコード
account/update_profile_bannerのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$jsonという変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。
アクセストークン
PHP (OAuth1.0)
<?php
/**************************************************
[POST account/update_profile_banner]のお試しプログラム
認証方式: アクセストークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/post/account/update_profile_banner
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/POST/account/update_profile_banner/
**************************************************/
// 設定
$api_key = '' ; // APIキー
$api_secret = '' ; // APIシークレット
$access_token = '' ; // アクセストークン
$access_token_secret = '' ; // アクセストークンシークレット
$request_url = 'https://api.twitter.com/1.1/account/update_profile_banner.json' ; // エンドポイント
$request_method = 'POST' ;
// パラメータA (オプション)
$params_a = array(
"banner" => file_get_contents( "./image.png" ),
// "width" => "100",
// "height" => "100",
// "offset_left" => "0",
// "offset_top" => "0",
) ;
// キーを作成する (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' ,
) ;
// リクエストURLにより、メディアを指定するパラメータが違う
switch( $request_url ) {
case( 'https://api.twitter.com/1.1/account/update_profile_background_image.json' ) :
case( 'https://api.twitter.com/1.1/account/update_profile_image.json' ) :
$media_param = 'image' ;
break ;
case( 'https://api.twitter.com/1.1/account/update_profile_banner.json' ) :
$media_param = 'banner' ;
break ;
case( 'https://upload.twitter.com/1.1/media/upload.json' ) :
$media_param = ( isset($params_a['media']) && !empty($params_a['media']) ) ? 'media' : 'media_data' ;
break ;
}
// イメージデータの取得
$media_data = ( isset($params_a[ $media_param ]) && $params_a[ $media_param ] ) ? $params_a[ $media_param ] : '' ;
// 署名の材料から、メディアデータを除外する
if( isset( $params_a[ $media_param ] ) ) unset( $params_a[ $media_param ] ) ;
// バウンダリーの定義
$boundary = 's-y-n-c-e-r---------------' . md5( mt_rand() ) ;
// POSTフィールドの作成 (まずはメディアのパラメータ)
$request_body = '' ;
$request_body .= '--' . $boundary . "\r\n" ;
$request_body .= 'Content-Disposition: form-data; name="' . $media_param . '"; ' ;
// $request_body .= 'filename="' . time() . '"' ; // [filename]は指定不要なので、おサボり…
$request_body .= "\r\n" ;
// [Content-Type]と[Content-Transfer-Encoding]は指定不要なので、おサボり…
// $mimetype = 〜 //Mime/Typeを調べる処理
// $request_body .= "Content-Type: " . $mimetype . "\r\n" ;
// $request_body .= "Content-Transfer-Encoding: \r\n" ;
$request_body .= "\r\n" . $media_data . "\r\n" ;
// POSTフィールドの作成 (その他のオプションパラメータ)
foreach( $params_a as $key => $value ) {
$request_body .= '--' . $boundary . "\r\n" ;
$request_body .= 'Content-Disposition: form-data; name="' . $key . '"' . "\r\n\r\n" ;
$request_body .= $value . "\r\n" ;
}
// リクエストボディの作成
$request_body .= '--' . $boundary . '--' . "\r\n\r\n" ;
// リクエストヘッダーの作成
$request_header = "Content-Type: multipart/form-data; boundary=" . $boundary ;
// パラメータAとパラメータBを合成してパラメータCを作る → ×
// $params_c = array_merge( $params_a , $params_b ) ;
$params_c = $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 ,
'Content-Type: multipart/form-data; boundary= ' . $boundary ,
) ,
'content' => $request_body ,
) ,
) ;
// 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_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;">POST account/update_profile_banner</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 .= '<h3>ボディ</h3>' ;
$html .= '<p><textarea style="width:80%" rows="8">' . ( isset($context['http']['content']) ? $context['http']['content'] : "" ) . '</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/POST/account/update_profile_banner/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;