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

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

Posted at October 2,2013 1:23 AM
Tag:[DataAPI, MovableType]

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

本エントリーではJavaScript SDK APIのpublishEntries()を使った記事の再構築について解説します。

1.基本

publishEntries()は記事の再構築を行うためのAPIです。

publishEntries()を使って再構築するための簡単なサンプルを紹介します。

<script>
// API生成コード等は省略
 
$('#publish').click(function(){
    var ids = $('#ids').val();
    api.publishEntries({ids: ids}, function(response) {
        if (response.error) {
            // Handle error
            return;
        }
        if (response.status === 'Rebuilding') {
            if (response.restIds) {
                // 記事アーカイブの再構築
                $('#result').html('再構築中:' + response.restIds );
            } else {
                // インデックステンプレートの再構築
                $('#result').html('インデックステンプレートの再構築' );
            }
        } else if (response.status === 'Complete') {
            // 再構築完了
            $('#result').html('再構築完了' );
        }
});
</script>
 
<input type="text" id="ids" />
<input type="button" id="publish" value="再構築" />
<div id="result"></div>

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

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

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

2.パラメータ

publishEntries()に設定するパラメータは次のとおりです。idsは第1パラメータのハッシュとして設定します。

  • ids:記事ID(必須、複数設定する場合は「1,2,3」という風にカンマで区切る)
  • callback:コールバック処理(オプション)

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

3.レスポンス

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

記事アーカイブの再構築中

{"status":"Rebuilding","restIds":"1,3,58,2","startTime":"2013-10-01T20:50:49\u002b09:00"}

インデックステンプレートの再構築中

{"status":"Rebuilding","restIds":"","startTime":"2013-10-01T20:50:49\u002b09:00"}

再構築完了

{"status":"Complete","restIds":"","startTime":"2013-10-01T20:50:49\u002b09:00"}

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

status
再構築のステータス

restIds
再構築中のID

startTime
再構築開始時間

4.注意事項

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

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

{"error":{"message":"Unauthorized","code":401}}
関連記事
zenback
人気エントリー
トラックバックURL


コメントする
greeting

*必須

*必須(非表示)


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

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

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

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