POST account/update_profile_image - アイコン画像を更新する
公開日:
account/update_profile_image(POSTメソッド)は、プロフィールのアイコン画像を更新するエンドポイントです。画像はJPG、PNG、GIF形式で700kb未満、400px以下のサイズを指定できます。
- POST account/update_profile_image
- Twitterの公式リファレンス(英語)。account/update_profile_imageに関する説明があります。
リソース
エンドポイント
POST https://api.twitter.com/1.1/account/update_profile_image.json
条件
項目 | ユーザー認証 | アプリケーション認証 |
---|---|---|
利用 | ● | × |
パーミッション | Read and Write | - |
レートリミット | あり(Twitterルールを適用) | - |
パラメータ
image
画像の、生のバイナリデータ、またはbase64エンコードで指定する。
include_entities
指定例: true
返り値のJSONの、ツイートオブジェクト内のentitiesプロパティを含めるか否か。
skip_status
指定例: true
返り値のJSONの、ユーザーオブジェクト内のstatusプロパティを除外するか否か。true
の場合は除外する、false
の場合は除外しない。
レスポンス
アクセストークン(OAuth1.0)でリクエストをした場合の例です。
リクエストURL
https://api.twitter.com/1.1/account/update_profile_image.json
リクエストヘッダー
Authorization: OAuth oauth_consumer_key=:consumer_key,oauth_nonce=0.12952700+1484801111,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484801111,oauth_token=:access_token,oauth_version=1.0,oauth_signature=c6HXUTwziPK%2BPrcMx8sqDcL7reU%3D
リクエストボディ
--s-y-n-c-e-r---------------6cae55be457de138a80f1a790955ae51
Content-Disposition: form-data; name="image";
�PNG
IHDRddG<efYiTXtXML:com.adobe.xm
--s-y-n-c-e-r---------------6cae55be457de138a80f1a790955ae51
Content-Disposition: form-data; name="include_entities"
true
--s-y-n-c-e-r---------------6cae55be457de138a80f1a790955ae51
Content-Disposition: form-data; name="skip_status"
false
--s-y-n-c-e-r---------------6cae55be457de138a80f1a790955ae51--
レスポンスボディ (JSON)
JSON
{"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":null,"indices":[0,23]}]},"description":{"urls":[]}},"protected":false,"followers_count":1417,"friends_count":563,"listed_count":114,"created_at":"Tue Jun 18 17:28:51 +0000 2013","favourites_count":4457,"utc_offset":32400,"time_zone":"Asia\/Tokyo","geo_enabled":true,"verified":false,"statuses_count":34826,"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\/821911941396328448\/VjorK4J1.jpg","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/821911941396328448\/VjorK4J1.jpg","profile_background_tile":false,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/821941553774010370\/5M2umxbl_normal.jpg","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/821941553774010370\/5M2umxbl_normal.jpg","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/1528352858\/1484800383","profile_link_color":"D36015","profile_sidebar_border_color":"F2E195","profile_sidebar_fill_color":"FFF7CC","profile_text_color":"0C3E53","profile_use_background_image":true,"default_profile":false,"default_profile_image":false,"following":null,"follow_request_sent":null,"notifications":null,"translator_type":"regular"}
レスポンスヘッダー
HTTP/1.1 100 Continue
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: 1746
content-type: application/json;charset=utf-8
date: Thu, 19 Jan 2017 04:45:12 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Thu, 19 Jan 2017 04:45:12 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148480111200708021; Domain=.twitter.com; Path=/; Expires=Sat, 19-Jan-2019 04:45:12 UTC
status: 200 OK
strict-transport-security: max-age=631138519
vary: Origin
x-access-level: read-write
x-connection-hash: 09cf687b290e40d91f78f672095c2983
x-frame-options: SAMEORIGIN
x-response-time: 768
x-transaction: 00941022005b1ff8
x-tsa-request-body-time: 2
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block
デモ
account/update_profile_imageのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(書込権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。
サンプルコード
account/update_profile_imageのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$json
という変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。
アクセストークン
PHP (OAuth1.0)
<?php
/**************************************************
[POST account/update_profile_image]のお試しプログラム
認証方式: アクセストークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/post/account/update_profile_image
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/POST/account/update_profile_image/
**************************************************/
// 設定
$api_key = '' ; // APIキー
$api_secret = '' ; // APIシークレット
$access_token = '' ; // アクセストークン
$access_token_secret = '' ; // アクセストークンシークレット
$request_url = 'https://api.twitter.com/1.1/account/update_profile_image.json' ; // エンドポイント
$request_method = 'POST' ;
// パラメータA (オプション)
$params_a = array(
"image" => file_get_contents( "./image.png" ),
// "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' ,
) ;
// リクエスト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_image</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_image/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;