POST media/upload (APPEND) - 動画のアップロードを実行する

公開日: 2017/01/20

POSTメソッドのmedia/upload(APPEND)は、動画のアップロードする実行するエンドポイントです。動画は分割してアップロードすることができ、分割した分だけリクエストを実行する必要があります。このエンドポイントは、あらかじめmedia/upload(INIT)を実行して取得したメディアIDが必要です。また、このリクエストが完了したら、続いてmedia/upload(FINALIZE)のリクエストを行なう必要があります。

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

リソース

エンドポイント

POST https://upload.twitter.com/1.1/media/upload.json

条件

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

パラメータ

command

指定例: APPEND

コマンド。APPENDを指定すること。

INIT: 準備のリクエスト。
APPEND: 動画のアップロードのリクエスト。
FINALIZE: 完了のリクエスト。

media_id

指定例: 631455717191344128

INITのリクエストで取得したメディアID。

media

動画の、生のバイナリデータ。

media_data

動画の、base64エンコードしたデータ。

segment_index

動画データを分割してアップロードする場合、APPENDのリクエストを繰り返す。最初のリクエストには0を、次に1をと、リクエストの順に番号を増やしていく。1度のアップロードで済む場合は、0を指定しておく。

レスポンス

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

リクエストURL

https://upload.twitter.com/1.1/media/upload.json

リクエストヘッダー

Authorization: OAuth oauth_consumer_key=:consumer_key,oauth_nonce=0.35060200+1484952452,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484952452,oauth_token=:access_token,oauth_version=1.0,oauth_signature=KpHOQsQz6as38L87ETkt%2FxcpZus%3D

Content-Type: multipart/form-data; boundary= s-y-n-c-e-r---------------a85d3ec39f853888238f83de1f965a68

リクエストボディ

--s-y-n-c-e-r---------------a85d3ec39f853888238f83de1f965a68
Content-Disposition: form-data; name="media"; 

ftypmp42mp42mp41iso4�moovlmvhdԧ��ԧ��_��@*iods���O��)�������Ttrak\tkhdԧ��ԧ���@@��mdia mdhdԧ��ԧ��_��U�2hdlrvideVireo Eyes v2.4.3�minfvmhd$dinfdrefurl Vstbl�stsd�avc1@�HH
AVC Coding��,avcCB���gB��~x@�.��
�hʂrbtrt����
--s-y-n-c-e-r---------------a85d3ec39f853888238f83de1f965a68
Content-Disposition: form-data; name="command"

APPEND
--s-y-n-c-e-r---------------a85d3ec39f853888238f83de1f965a68
Content-Disposition: form-data; name="media_id"

822423730349449217
--s-y-n-c-e-r---------------a85d3ec39f853888238f83de1f965a68
Content-Disposition: form-data; name="segment_index"

0
--s-y-n-c-e-r---------------a85d3ec39f853888238f83de1f965a68--

レスポンスボディ (JSON)

取得できるJSONはありません。

レスポンスヘッダー

HTTP/1.1 100 Continue

HTTP/1.1 204 No Content
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: Fri, 20 Jan 2017 22:47:33 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Fri, 20 Jan 2017 22:47:32 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148495245258365793; Domain=.twitter.com; Path=/; Expires=Sun, 20-Jan-2019 22:47:32 UTC
status: 204 No Content
strict-transport-security: max-age=631138519
vary: Origin
x-access-level: read-write
x-connection-hash: d578704c337e281c2743fdb840f1b6c1
x-frame-options: SAMEORIGIN
x-mediaid: 822423730349449217
x-rate-limit-limit: 20000
x-rate-limit-remaining: 19983
x-rate-limit-reset: 1484954591
x-response-time: 518
x-segmentcount: 0
x-totalbytes: 0
x-transaction: 0026005800cbd989
x-tsa-request-body-time: 105
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block

デモ

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

サンプルコード

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

アクセストークン

PHP (OAuth1.0)

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

	[POST media/upload (APPEND)]のお試しプログラム

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

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

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

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

	// 動画アップロードの設定
	$media_id = "" ;	// INITのリクエストで取得したメディアID
	$movie_path = "./movie.mp4" ;	// 動画ファイルのパス
	$chunked_size = 51200 ;	// このサイズごとに分割してアップロードする

	// HTML用
	$html = '' ;

	// タイトル
	$html .= '<h1 style="text-align:center; border-bottom:1px solid #555; padding-bottom:12px; margin-bottom:48px; color:#D36015;">POST media/upload (APPEND)</h1>' ;

	// 動画ファイルのサイズ
	$movie_filesize = filesize( $movie_path ) ;

	// 動画ファイルを開く
	$movie_handle = fopen( $movie_path, "r" ) ;

	// 分割した分だけリクエストを繰り返す
	do {
		// ファイルを開けなければリクエストをしない
		if ( !$movie_handle ) {
			break ;
		}

		// 今回アップロードする分のデータを読み込む
		$movie_data = fread( $movie_handle, $chunked_size ) ;

		// データが読み込めなければリクエストをしない
		if ( !$movie_data ) {
			break ;
		}

		// パラメータA (オプション)
		$params_a = array(
			"command" => "APPEND" ,
			"media" => $movie_data ,
			"media_id" => $media_id ,
			"segment_index" => ( !isset($i) ? ($i = 0) : ++$i ) ,
		) ;

		// キーを作成する (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'] ) ;		// レスポンスヘッダー (検証に利用したい場合にどうぞ)

		// JSONをオブジェクトに変換 (処理する場合)
//		$obj = json_decode( $json ) ;

		// 見出し
		$html .= "<h2>" . ($i + 1) . "回目のリクエスト</h2>" ;

		// 検証用
		$html .= '<h3>取得したデータ</h3>' ;
		$html .= '<p>下記のデータを取得できました。</p>' ;
		$html .= 	'<h4>ボディ(JSON)</h4>' ;
		$html .= 	'<p><textarea style="width:80%" rows="8">' . $json . '</textarea></p>' ;
		$html .= 	'<h4>レスポンスヘッダー</h4>' ;
		$html .= 	'<p><textarea style="width:80%" rows="8">' . $header . '</textarea></p>' ;

		// 検証用
		$html .= '<h3>リクエストしたデータ</h3>' ;
		$html .= '<p>下記内容でリクエストをしました。</p>' ;
		$html .= 	'<h4>URL</h4>' ;
		$html .= 	'<p><textarea style="width:80%" rows="8">' . $context['http']['method'] . ' ' . $request_url . '</textarea></p>' ;
		$html .= 	'<h4>ヘッダー</h4>' ;
		$html .= 	'<p><textarea style="width:80%" rows="8">' . implode( "\r\n" , $context['http']['header'] ) . '</textarea></p>' ;
		$html .= 	'<h4>ボディ</h4>' ;
		$html .= 	'<p><textarea style="width:80%" rows="8">' . ( isset($context['http']['content']) ? $context['http']['content'] : "" ) . '</textarea></p>' ;

	} while ( ftell( $movie_handle ) < $movie_filesize ) ;

	// ファイルを閉じる
	fclose( $movie_handle ) ;

	// フッター
	$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/media/upload/APPEND/" target="_blank">SYNCER</a></small>' ;

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