POST media/upload (INIT) - 動画のアップロードの準備をする
公開日:
POSTメソッドのmedia/upload(INIT)は、動画をアップロードする準備を行なうエンドポイントです。このリクエストでTwitter側に、これからアップロードする予定の動画ファイルのサイズを知らせます。返り値で得たメディアIDを利用して、次はmedia/upload(APPEND)にリクエストを行ないます。
- POST media/upload (INIT)
- Twitterの公式リファレンス(英語)。media/uploadに関する説明があります。
リソース
エンドポイント
POST https://upload.twitter.com/1.1/media/upload.json
条件
項目 | ユーザー認証 | アプリケーション認証 |
---|---|---|
利用 | ● | × |
パーミッション | Read and Write | - |
レートリミット | あり(Twitterルールを適用) | - |
パラメータ
command
指定例: INIT
コマンド。INIT
を指定すること。
- INIT
- 準備のリクエスト。
- APPEND
- 動画のアップロードのリクエスト。
- FINALIZE
- 完了のリクエスト。
media_type
指定例: video/mp4
動画のMIME TYPE。
total_bytes
指定例: 1048
動画の総サイズ。
PHP (動画のサイズを取得)
<?php
$size = filesize( "./movie.mp4" ) ;
additional_owners
指定例: 1528352858,2905085521
基本的にアップロードしたユーザー以外は、メディアIDを取り扱えない。しかし、この値にユーザーIDを指定することで、そのユーザーもメディアIDを取り扱えるようになる。複数指定する場合はカンマ(,
)で区切る。
レスポンス
アクセストークン(OAuth1.0)でリクエストをした場合の例です。
リクエストURL
https://upload.twitter.com/1.1/media/upload.json
リクエストヘッダー
Authorization: OAuth command=INIT,media_type=video%2Fmp4,oauth_consumer_key=:consumer_key,oauth_nonce=0.67365200+1484916071,oauth_signature_method=HMAC-SHA1,oauth_timestamp=1484916071,oauth_token=:access_token,oauth_version=1.0,total_bytes=97587,oauth_signature=swJ3tVozjcW8Z3BMdJbZlKNLCLk%3D
リクエストボディ
command=INIT&media_type=video%2Fmp4&total_bytes=97587
レスポンスボディ (JSON)
JSON
{"media_id":822423730349449217,"media_id_string":"822423730349449217","expires_after_secs":86399}
レスポンスヘッダー
HTTP/1.1 202 Accepted
cache-control: no-cache, no-store, must-revalidate, pre-check=0, post-check=0
content-disposition: attachment; filename=json.json
content-length: 97
content-type: application/json;charset=utf-8
date: Fri, 20 Jan 2017 12:41:11 GMT
expires: Tue, 31 Mar 1981 05:00:00 GMT
last-modified: Fri, 20 Jan 2017 12:41:11 GMT
pragma: no-cache
server: tsa_m
set-cookie: lang=ja; Path=/
set-cookie: guest_id=v1%3A148491607185556637; Domain=.twitter.com; Path=/; Expires=Sun, 20-Jan-2019 12:41:11 UTC
status: 202 Accepted
strict-transport-security: max-age=631138519
vary: Origin
x-access-level: read-write
x-connection-hash: adc79b7d7e146eea0207be59bd24e5ec
x-frame-options: SAMEORIGIN
x-mediaid: 822423730349449217
x-rate-limit-limit: 200
x-rate-limit-remaining: 195
x-rate-limit-reset: 1484919207
x-response-time: 123
x-transaction: 008d9d20009f3049
x-tsa-request-body-time: 0
x-twitter-response-tags: BouncerCompliant
x-xss-protection: 1; mode=block
デモ
media/uploadのリクエストを試すことができます。ユーザー認証のデモを試す場合は、アプリケーション(書込権限)の連携を許可する必要があります。利用後、お手数ですが連携の解除をお願いします。連携を解除し忘れたとしても、当アプリケーションが許可なくデータにアクセスすることはありません。
サンプルコード
media/uploadのエンドポイントを利用するためのサンプルプログラムです。各種トークンの情報をセットしてからPHPで起動して下さい。リクエストに成功すると、$json
という変数に目的のデータが代入されます。このデータを整形するなり保存するなり、活用して下さい。
アクセストークン
PHP (OAuth1.0)
<?php
/**************************************************
[POST media/upload (INIT)]のお試しプログラム
認証方式: アクセストークン
配布: SYNCER
公式ドキュメント: https://dev.twitter.com/rest/reference/post/media/upload
日本語解説ページ: https://syncer.jp/Web/API/Twitter/REST_API/POST/media/upload/INIT/
**************************************************/
// 設定
$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' ;
// パラメータA (オプション)
$params_a = array(
"command" => "INIT",
"media_type" => "video/mp4",
"total_bytes" => filesize( "./movie.mp4" ),
// "additional_owners" => "1528352858,2905085521",
) ;
// キーを作成する (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 media/upload (INIT)</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/media/upload/INIT/" target="_blank">SYNCER</a></small>' ;
// 出力 (本稼働時はHTMLのヘッダー、フッターを付けよう)
echo $html ;