Movable Type Data APIの使い方:uploadAsset()

Movable Type Data APIの使い方:uploadAsset()

Posted at October 4,2013 1:33 AM
Tag:[DataAPI, MovableType]

Movable Type 6から提供されるData APIの使い方を紹介します。

本エントリーではJavaScript SDK APIのuploadAsset()を使ったアイテムのアップロードについて解説します。

1.基本

uploadAsset()は、アイテムのアップロードを行うためのAPIです。

uploadAsset()を使ったアイテムのアップロードを行うための簡単なサンプルを紹介します。

<script>
// API生成コード等は省略
 
$('#upload').click(function(){
    var data = {
      file: document.getElementById("file").files[0], // File object
      path: "images",
      autoRenameIfExists: true,
      normalizeOrientation: true
    };
    api.uploadAsset(2, data, function(response) {
        if (response.error) {
            $('#result').html('エラー' );
            return;
        }
        $('#result').html('アップロード完了' );
    });
});
</script>
 
<input type="file" id="file" />
<input type="button" id="upload" value="アップロード" />
<div id="result"></div>

JavaScriptライブラリのインクルードやapiの生成については「Movable Type Data APIの使い方(JavaScript SDKを使ったオブジェクトの生成)」を参照してください。

また、エラーのハンドリングについては「Movable Type Data APIの使い方(エラーのハンドリング)」を参照してください。

なお、上記のサンプルでは結果表示処理でjQueryを利用しているので、jQueryのインクルードも行ってください。

2.パラメータ

uploadAsset()に設定するパラメータは次のとおりです。第2パラメータのdataはハッシュで設定します。

  • siteId:ブログID(必須)
  • data:アップロードするアイテムのデータ(必須)
  • callback:コールバック処理(オプション)

公式リファレンスでは第3パラメータのcallbackはオプションのようですが、エラーの判定を行うには必要な処理だと思います。

第2パラメータのdataの詳細は次のとおりです。

  • file:フォームのファイルオブジェクト
  • path:アップロード先のパス
  • autoRenameIfExists:同一ファイルが存在する場合、古いファイルをリネーム
  • normalizeOrientation:Exif情報を使って画像の向きを修正する

その他にもoverwrite、fileName、tempが使えるみたいです。

3.レスポンス

レスポンスとして次のようなJSONデータが非同期で返却されます(MT6 rc2版時点でのサンプル)。

{"filename":"hoge.png","url":"http://user-domain/images/hoge.png","mimeType":"image/png","label":"image","id":"2","description":null,"tags":[]}

データの意味は次のとおりです。

filename
アイテムのファイル名

url
アップロード先のURL

mimeType
MIMEタイプ

label
アイテムの名前

id
アイテムのID

description
アイテムの説明

tags
アイテムのタグ

autoRenameIfExistsにfalseを設定して、同一ファイルが存在する場合、次のようなエラーレスポンスが返却されます。

{"error":{"data":{"temp":"hgrz_vahWc","fileName":"hoge.png","path":"images"},"message":"A file named 'hoge.png' already exists.","code":409}}

4.注意事項

uploadAsset()を実行するには、authenticate()を使って認証しておく必要があります。

認証されていない状態でこのAPIを実行すると、次のレスポンスが返却されます。

{"error":{"message":"Unauthorized","code":401}}

また、アップロード権限がない場合は403エラーとなります。

関連記事
zenback
人気エントリー
トラックバックURL


コメントする
greeting

*必須

*必須(非表示)


ご質問のコメントの回答については、内容あるいは多忙の場合、1週間以上かかる場合があります。また、すべてのご質問にはお答えできない可能性があります。予めご了承ください。

太字イタリックアンダーラインハイパーリンク引用
[サインインしない場合はここにCAPTCHAを表示します]

コメント投稿後にScript Errorや500エラーが表示された場合は、すぐに再送信せず、ブラウザの「戻る」ボタンで一旦エントリーのページに戻り(プレビュー画面で投稿した場合は、投稿内容をマウスコピーしてからエントリーのページに戻り)、ブラウザをリロードして投稿コメントが反映されていることを確認してください。

コメント欄に(X)HTMLタグやMTタグを記述される場合、「<」は「&lt;」、「>」は「&gt;」と入力してください。例えば「<$MTBlogURL$>」は「&lt;$MTBlogURL$&gt;」となります(全て半角文字)