GoogleAnalyticsのPV数を元にアクセスランキングを実装する方法

本チュートリアルでは、指定したコンテンツ定義の詳細ページのPV数を元に、過去1週間以内のアクセスランキングを表示する方法を説明します。

GoogleAnalytics(以下、GA)のPV数を元にアクセスランキングを作成するには以下の処理を実装する必要があります。

1. Kuroco管理画面からGAと連携する
2. カスタムディメンションを設定する
3. フロント側でGAの計測タグを埋め込む
4. コンテンツ定義にPV数を設定するための拡張項目を設定する
5. 取得したPV数をコンテンツのデータに設定する
6. アクセスランキング取得用にPV数の降順で10件取得する一覧APIを作成する

Kuroco管理画面からGAと連携する

GAとの連携はGoogle Analytics連携方法のページを参考に行って下さい。

また、上記の設定に加え「Google Analytics Reporting API」を有効にする必要があります。

カスタムディメンションを設定する

下記、いずれかのようにカスタムディメンションを設定してください。
閲覧されたコンテンツを特定するのに利用しますので送信する値はコンテンツID、もしくはslugとなります（どちらか一方で問題ありませんのでどちらを使用するかはフロントの構成に合わせて決めて下さい）。

slugを利用する場合のサンプル

フロント側でGAの計測タグを埋め込む

フロント側の設定はGoogle Analytics連携方法のフロントエンドでgoogle-analyticsの設定をするの項目を参考に行って下さい。

このチュートリアルでは、ランキング取得したい詳細ページのPV数のみ取得するので、page_viewイベントの送信をmountedに埋め込む形で実装します。

  'google-gtag': {
    id: 'UA-XXXXXXXXX',
    send_page_view: false
  },

if (process.client) {
    const slug = // ページのURLなどからslugを取得
    this.$gtag('event', 'page_view', {
        'dimension1': slug
    })
}

この段階でフロントの表示を確認し、正しくpageviewイベントの送信が行われていればGAコンソール上でセカンダリディメンションを指定することで、下記のようにPV数が確認出来ます。

コンテンツ定義にPV数を設定するための拡張項目を設定する

※項目の種別はカウンターを指定する必要があります。
※PV数をコンテンツに設定する際、ここで設定したslugを利用します。

取得したPV数をコンテンツのデータに設定する

取得したPV数をコンテンツデータに設定するため、下記のようなSmartyPluginを実行させるバッチ処理を作成します。

{*GAからPV数を取得してカウンターに設定*}
{googleanalytics var=result
update_column_slug="pv"
update_target_dimension="ga:dimension1"
updated_topics_ids='updated_topics_ids'
topics_group_id=1}{*topics_group_idは対象のコンテンツ定義IDを指定して下さい*}

{*カウンターデータの内容をコンテンツデータに反映*}
{assign_array var=ext_data values=''}
{assign var=ext_data.topics_ids values=$updated_topics_ids}
{batch module='topics' name='sync_counter' ext_data=$ext_data}

パラメータ詳細

googleanalyticsプラグインでは下記のパラメータが利用出来ます。

アクセスランキング取得用にPV数の降順で10件取得する一覧APIを作成する

PV数の降順で10件取得する為のAPI設定は下記となります。