POST account/settings - アカウント設定を更新する
公開日:
account/settings(POSTメソッド)は、アカウントの設定を更新するエンドポイントです。
- POST account/settings
- Twitterの公式リファレンス(英語)。account/settingsに関する説明があります。
リソース
エンドポイント
POST https://api.twitter.com/1.1/account/settings.json
条件
項目 | ユーザー認証 | アプリケーション認証 |
---|---|---|
利用 | ● | × |
パーミッション | Read and Write | - |
レートリミット | あり(Twitterルールを適用) | - |
パラメータ
sleep_time_enabled
指定例: true
スリープ設定を有効にするか否か。有効にした場合、start_sleep_time、end_sleep_timeで指定した睡眠時間の間は、プッシュ通知が無効になる。
start_sleep_time
指定例: 22
睡眠開始時間を2桁の時間(00〜23)で指定する。
end_sleep_time
指定例: 08
睡眠終了時間を2桁の時間(00〜23)で指定する。
time_zone
指定例: Asia/Tokyo
タイムゾーン。
trend_location_woeid
指定例: 1118370
トレンドの対象地域。WOEIDで指定する。
lang
指定例: ja
使用言語を、言語コードで指定する。
レスポンス
アクセストークン(OAuth1.0)でリクエストをした場合の例です。
リクエストURL
https://api.twitter.com/1.1/account/settings.json
リクエストヘッダー
Authorization: OAuth end_sleep_time=08,lang=ja,oauth_consumer_key=:consumer_key,oauth_nonce=0.74909300+1484790204,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484790204,oauth_token=:access_token,oauth_version=1.0,sleep_time_enabled=true,start_sleep_time=22,time_zone=Asia%2FTokyo,oauth_signature=RPLkRVCXP0G6ei0RrLrKL1dGd%2Fg%3D
リクエストボディ
sleep_time_enabled=true&start_sleep_time=22&end_sleep_time=08&time_zone=Asia%2FTokyo&lang=ja
レスポンスボディ (JSON)
JSON
{"time_zone":{"name":"Asia\/Tokyo","utc_offset":32400,"tzinfo_name":"Asia\/Tokyo"},"protected":false,"screen_name":"arayutw","always_use_https":true,"use_cookie_personalization":true,"sleep_time":{"enabled":true,"end_time":8,"start_time":22},"geo_enabled":true,"language":"ja","discoverable_by_email":false,"discoverable_by_mobile_phone":false,"display_sensitive_media":true,"allow_contributor_request":"all","allow_dms_from":"following","allow_dm_groups_from":"following","translator_type":"regular","trend_location":[{"name":"\u6771\u4eac","countryCode":"JP","url":"http:\/\/where.yahooapis.com\/v1\/place\/1118370","woeid":1118370,"placeType":{"name":"Town","code":7},"parentid":23424856,"country":"Japan"}]}
レスポンスヘッダー
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: 711
content-type: application/json;charset=utf-8
date: Thu, 19 Jan 2017 01:43:24 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Thu, 19 Jan 2017 01:43:24 GMT
pragma: no-cache
server: tsa_m
set-cookie: guest_id=v1%3A148479020487628928; Domain=.twitter.com; Path=/; Expires=Sat, 19-Jan-2019 01:43:24 UTC
status: 200 OK
strict-transport-security: max-age=631138519
x-access-level: read-write
x-connection-hash: 4e39c05f7e5cc814ebc4d6f55e380090
x-content-type-options: nosniff
x-frame-options: SAMEORIGIN
x-response-time: 174
x-transaction: 0000b5b80048729b
x-tsa-request-body-time: 0
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block
デモ
account/settingsのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(書込権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。
サンプルコード
account/settingsのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$json
という変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。
アクセストークン
PHP (OAuth1.0)
<?php
/**************************************************
[POST account/settings]のお試しプログラム
認証方式: アクセストークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/post/account/settings
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/POST/account/settings/
**************************************************/
// 設定
$api_key = '' ; // APIキー
$api_secret = '' ; // APIシークレット
$access_token = '' ; // アクセストークン
$access_token_secret = '' ; // アクセストークンシークレット
$request_url = 'https://api.twitter.com/1.1/account/settings.json' ; // エンドポイント
$request_method = 'POST' ;
// パラメータA (オプション)
$params_a = array(
// "sleep_time_enabled" => "true",
// "start_sleep_time" => "22",
// "end_sleep_time" => "08",
// "time_zone" => "Asia/Tokyo",
// "trend_location_woeid" => "1118370",
// "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の末尾に追加 (POSTの場合は不要)
// if ( $params_a ) {
// $request_url .= '?' . http_build_query( $params_a ) ;
// }
// オプションがある場合、コンテキストにPOSTフィールドを作成する
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'] ) ) {
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/settings</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/settings/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;