SYNCER

SYNCER

POST collections/update - コレクションの設定を更新する

9件

公開日:

collections/update(POSTメソッド)は、コレクションの名前などの設定を更新するエンドポイントです。省略したパラメータは、空の文字列が指定された扱いになる点にご注意下さい。

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

リソース

エンドポイント

POST https://api.twitter.com/1.1/collections/update.json

条件

項目ユーザー認証アプリケーション認証
利用×
パーミッションRead and Write-
レートリミットあり(Twitterルールを適用)-

パラメータ

id

指定例: custom-539487832448843776

対象のコレクションID。

name

指定例: Favorite Tweets

コレクションの名称。

description

指定例: 私の好きなツイートを集めてみました。

コレクションの詳細。160文字まで。

url

指定例: https://syncer.jp/

コレクションの関連URL。

レスポンス

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

リクエストURL

https://api.twitter.com/1.1/collections/update.json

リクエストヘッダー

Authorization: OAuth description=%E7%A7%81%E3%81%AE%E5%A5%BD%E3%81%8D%E3%81%AA%E3%83%84%E3%82%A4%E3%83%BC%E3%83%88%E3%82%92%E9%9B%86%E3%82%81%E3%81%A6%E3%81%BF%E3%81%BE%E3%81%97%E3%81%9F%E3%80%82,id=custom-821991848667287552,name=Favorite+Tweets,oauth_consumer_key=:consumer_key,oauth_nonce=0.57348100+1484824279,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484824279,oauth_token=:access_token,oauth_version=1.0,url=https%3A%2F%2Fsyncer.jp%2F,oauth_signature=WejkUQhLxr7KmJbH5FafbVe55vk%3D

リクエストボディ

id=custom-821991848667287552&name=Favorite+Tweets&description=%E7%A7%81%E3%81%AE%E5%A5%BD%E3%81%8D%E3%81%AA%E3%83%84%E3%82%A4%E3%83%BC%E3%83%88%E3%82%92%E9%9B%86%E3%82%81%E3%81%A6%E3%81%BF%E3%81%BE%E3%81%97%E3%81%9F%E3%80%82&url=https%3A%2F%2Fsyncer.jp%2F

レスポンスボディ (JSON)

JSON

{"objects":{"users":{"1528352858":{"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":"https:\/\/syncer.jp\/","display_url":"syncer.jp","indices":[0,23]}]},"description":{"urls":[{"url":"https:\/\/t.co\/OAIDbACF3N","expanded_url":"https:\/\/forum.syncer.jp\/","display_url":"forum.syncer.jp","indices":[26,49]}]}},"protected":false,"followers_count":1418,"friends_count":562,"listed_count":113,"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":34830,"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,"has_extended_profile":false,"default_profile":false,"default_profile_image":false,"following":false,"follow_request_sent":false,"notifications":false,"translator_type":"regular"}},"timelines":{"custom-821991848667287552":{"name":"Favorite Tweets","user_id":"1528352858","collection_url":"https:\/\/twitter.com\/arayutw\/timelines\/821991848667287552","custom_timeline_url":"https:\/\/twitter.com\/arayutw\/timelines\/821991848667287552","description":"\u79c1\u306e\u597d\u304d\u306a\u30c4\u30a4\u30fc\u30c8\u3092\u96c6\u3081\u3066\u307f\u307e\u3057\u305f\u3002","url":"https:\/\/syncer.jp\/","visibility":"public","timeline_order":"curation_reverse_chron","collection_type":"user","custom_timeline_type":"user"}}},"response":{"timeline_id":"custom-821991848667287552"}}

レスポンスヘッダー

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: 2579
content-type: application/json;charset=utf-8
date: Thu, 19 Jan 2017 11:11:19 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Thu, 19 Jan 2017 11:11:19 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148482427964305599; Domain=.twitter.com; Path=/; Expires=Sat, 19-Jan-2019 11:11:19 UTC
status: 200 OK
strict-transport-security: max-age=631138519
x-access-level: read-write
x-connection-hash: bcae2ed6f329379f8073da4034775eb5
x-content-type-options: nosniff
x-frame-options: SAMEORIGIN
x-response-time: 223
x-transaction: 00a9c0c800953a3b
x-tsa-request-body-time: 0
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block

デモ

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

id

name

description

url

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

/

サンプルコード

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

アクセストークン

PHP (OAuth1.0)

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

	[POST collections/update]のお試しプログラム

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

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

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

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

	// パラメータA (オプション)
	$params_a = array(
		"id" => "custom-539487832448843776",
		"name" => "Favorite Tweets",
//		"description" => "私の好きなツイートを集めてみました。",
//		"url" => "https://syncer.jp/",
	) ;

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

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