A Movable Type and Melody plugin that provides access ranking data (filetype:json) from GA your blog.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
mt-static/plugins/AccessRankingGA
plugins/AccessRankingGA
templates
README.md

README.md

#About the AccessRankingGA plugin for Movable Type and Melody AccessRankingGA is a plugin for Movable Type and Melody provides accessranking data from Google Analytics(GA) Data.

AccessRankingGA プラグインは、Google Analyticsレポート情報からユニークビジター数データを取得し、JSONファイルを出力生成します。 jQueryオリジナルプラグインを使い、JSONデータをコンテンツ内にリスト表示させます。
簡単にGoogleAnalyticsデータを利用したアクセスランキングをMovable Typeに実装できrるようになります。

####更新履歴 下記参照

  • 2013/08/02 Movabletype 6 対応確認

####TODO ダッシュボードにレポートウィジット生成

##AccessRankingGAインストール・設定までの流れ 1. **インストール** [下記参照](#folder) * プラグインフォルダ($MT_HOME/plugin)にAccessRankingGAプラグインフォルダを追加。 * mt-staticフォルダにAccessRankingGAフォルダをアップロード。[mt-static/plugins/AccessRankingGA/] 2. **プラグイン設定** * プラグインページにて必要情報を設定。(ログインアカウント名、パスワード、レポートID、最大表示件数) [下記参照](#setting) 3. **デザインテンプレート編集・作成** * 新規インデックステンプレート作成 * ヘッダーテンプレート編集。ヘッダー部分にjQueryコードを追加。 [下記参照](#jquery) * ヘッダーテンプレート編集。ヘッダー部分にcssを追加。 [下記参照](#css) * フッターテンプレート編集。フッター部分に外部スクリプト(オリジナルプラグイン)読み込みコードを追加。 [下記参照](#jquery) * 新規でウィジットテンプレート作成。 [下記参照](#widget) * 作成したウィジットテンプレートをウィジットセットの任意の位置に追加。 4. **再構築** * インデックステンプレートを再構築することでアクセスランキングが任意の位置に表示されます。 5. **定期実行スケジュール設定** * 定期でのスケジュールタスク実行(\*1) を設定することで最新データからアクセスランキング表示が可能となります。 \*1:[下記参照](#schedule) ##追加されるテンプレートタグ ###span モディファイア **span属性で任意の期間から現在までのデータ取得を指定することができます。** レポート取得期間をspanモディファイアで任意の期間を指定することができます。 インデックステンプレートに新規ファイル作成し、その中にテンプレートタグを記述することで任意の期間のGoogle Analytics レポートJSONデータが生成されることになります。 3パターンの期間指定したインデックスファイルを作成することで(昨日、今週、月間)と期間別でのアクセスランキング表示も可能となります。(jQueryランキング表示プラグインもタブ形式で数パターンのアクセスランキングを表示できます。)

デフォルト:属性指定無しは、week(7日間集計)となります。
1週間集計でのJSONアクセスランキングデータを生成したい場合は

<mt:AccessRankingGA>

1ヶ月間集計でのJSONアクセスランキングデータを生成したい場合は

<mt:AccessRankingGA span="30">

昨日(1日)集計でのJSONアクセスランキングデータを生成したい場合は

<mt:AccessRankingGA span="1">
##プラグイン設定 AccessRankingGAでは、GoogleAnalyticsレポートからデータを取り出す際に詳細設定することができるようになっています。  **トップページをランキング表示から除外したい場合** 「トップページ除外」にチェックをつけてください。 **特定フォルダ、ファイル(アドレス)を除外したい場合** 特定のフォルダもしくは、ページ(アドレス)を除外したい場合は、フォルダ名(パス名)、ファイル名を「除外パスリスト」に入力ください。 **ワードマッチするパス、ファイルについては除外**したデータを出力できるようになります。 例:ページ分割を実装しているブログ記事 一つのエントリーで長文対応で複数ページにて分割している場合など、アドレス末尾が( -2.html もしくは -3.htmlなど)同ページがアクセスランキングにて表示されてします可能性が考えられます。 「除外パスリスト」に -2.html または、-3.html と入力することで除外したデータを表示することできるようになります。

to the top ##インデックステンプレート作成 JSONファイル出力用に新規インデックステンプレートを作成します。
出力ファイル名を期間毎にわかりやすく命名することを推奨します。
以下を参考にインデックスファイル新規作成ください。

  • 昨日(1日)集計でのJSONアクセスランキングファイル作成

    • テンプレート名: 昨日アクセスランキング
    • テンプレート記述: <mt:AccessRankingGA span="1">
    • 出力名:accssranking_dayago.json
    • 公開: 公開キュー経由
  • 1週間集計でのJSONアクセスランキング作成

    • テンプレート名: 週間アクセスランキング
    • テンプレート記述: <mt:AccessRankingGA>
    • 出力名:accssranking_week.json
    • 公開: 公開キュー経由
  • 月間集計でのJSONアクセスランキング作成

    • テンプレート名: 月間アクセスランキング
    • テンプレート記述: <mt:AccessRankingGA span="30">
    • 出力名:accssranking_month.json
    • 公開: 公開キュー経由

上記ファイル作成後にインデックスファイルの再構築を実行後に公開ファイル名にアクセスし、実際にGoogleAnalyticsデータが取得出来ているか確認してください。 データ取得出来ていない場合は、システムログの確認とプラグイン設定項目を再確認してください。

##template/ フォルダ 下記の設定コードサンプルはtemplate/フォルダの中にheader追加コード、footer追加コード、ウィジットコードをmtmlファイルにしてあります。参照ください。

to the top ##jQueryプラグインコード設置
MTシステム側でGoogleAnalyticsレポートからデータを取得し、JSONファイルを生成します。生成されたJSONファイルをjQueryプラグインを使って読み込み、ブログ(HTMLページ)上に表示させます。

jQueryプラグイン設置は以下の手順で行ってください。
1.</body>後に以下のコードを外部スクリプトとして読み込むように設定します。

<script type="text/javascript" src="<$mt:StaticWebPath"$>jquery/jquery.min.js"></script>
<script type="text/javascript" src="<$mt:StaticWebPath"$>plugins/AccessRankingGA/js/jquery.rankingtab.js"></script>

$(document).ready( function() {
		$('.widget-accessranking > .widget-content').rankingtab({
			baseurl: '<$BlogURL$>accessranking_',
			trunc: 60
		});
});

jQuery rankingtab プラグイン設定

  • baseurl: jsonファイルが生成されるアドレスを指定します。
    (注: baseurlに設定するurlとインデックステンプレートに新規作成したjsonファイルの出力urlが一致している必要があります。)
  • trunk: 表示するタイトルを任意の文字数で区切ります。
##ウィジット作成例 下記のコードを参考に新規にウィジットテンプレート(アクセスランキング表示用)を作成します。作成後は、ウィジットセットに追加します。
<aside class="widget widget-accessranking">
<h3 class="widget-title">アクセスランキング</h3>
<div class="widget-content">
    <ul class="nav nav-tabs">
        <li class="active"><a href="#day">day</a></li>
        <li><a href="#week">week</a></li>
        <li><a href="#month">month</a></li>
    </ul><!--/ nav nav-tabs-->
    <div class="tab-content ranking-content"></div><!--/ranking-content -->
</div> <!-- /widge-content -->
</aside> <!-- /widget-accessranking -->

to the top ##ウィジットデザイン整形(CSS)

  1. ヘッダーにアクセスランキングウィジット用のCSSファイル読み込みコードを追加します。以下のコードを参考に。

to the top

##プラグインファイル構成
mt-plugin-AccessRankingGA/
├── README.md
├── mt-static
│   └── plugins
│       └── AccessRankingGA
│           ├── css
│           │   └── rankingtab.css
│           └── js
│               └── jquery.rankingtab.js
├── plugins
│   └── AccessRankingGA
│       ├── config.yaml
│       ├── lib
│       │   └── AccessRankingGA
│       │       ├── L10N
│       │       │   ├── en_us.pm
│       │       │   └── ja.pm
│       │       ├── L10N.pm
│       │       └── Plugin.pm
│       └── tmpl
│           └── config.tmpl
└── templates
    ├── added-html-footer.mtml
    ├── added-html-header.mtml
    └── widget-accessranking.mtml

12 directories, 12 files

to the top


####\*1: スケジュールタスクの実行 * cron等で定期で$MT_HOME/tools/run_periodic_tasksを実行する(linux or Unix) * タスク・スケジューラで$MT_HOME/tools/run_periodic_tasksを実行する(windows) * ログフィードを定期的に取得するようにする( フィードリーダ等で定期的に読み込むように設定する) * XML-RPCのAPI、mt.runPeriodicTasksを定期的に利用する
####更新履歴 * 2013/08/02 MovableType 6 対応確認済 * README編集 複数ファイル修正 * rankingtab.js ファイル変更修正 * サンプルwidget テンプレート、css . jquery.rankingtab 修正 * 2012/10/16 README編集 パージョン0.5リリース * GoogleAPI filter機能の変更により、アクセスできない不具合に対応。 * 機能アップグレード(トップページ、特定パス除外機能追加) * サンプルwidget テンプレート、css . jquery.rankingtab 修正 * 2012/9/01 README編集 パージョン0.4dリリース * 機能ダウングレード(除外機能削除) * apiエンドポイントv3へ変更 * dimention,metrics変更 * XML::Simple,JSON削除 * 2011/6/19 README編集 パージョン0.4リリース * 2011/6/18 README編集。バージョン別内部文字エンコード対応。 * 2011/5/25 READMEファイル修正、文字エンコード部分修正。

to the top