自動収集
v1.2.0以降、自動収集機能を提供しています。インスタンスを作成するconfigで自動収集したいイベントを有効にするだけで、SDKがミニアプリの一部の行動を自動的に収集します。現在、主に次のイベントの自動収集に対応しています:
現在対応している自動収集データは次のとおりです:
- ミニアプリの初期化。ユーザーの1回の利用につき1回だけトリガーされます
- ミニアプリの起動。起動と、バックグラウンドからフォアグラウンドへの復帰を含みます
- ミニアプリのバックグラウンドへの移行。今回のアクセス(起動からバックグラウンドへの移行まで)の時間を記録します
- ミニアプリのページ表示またはフォアグラウンドへの切り替え。ページのパスと参照元パスを自動的に記録します
- ミニアプリの転送・シェア。転送時のページを自動的に記録します
- ミニアプリのページのアンロード。ページのアンロード時にトリガーされ、自動的に記録します(3.2.0以上のバージョンで対応)
- ミニアプリのページのお気に入り登録。ページがお気に入りに登録されたときにトリガーされ、自動的に記録します(3.2.0以上のバージョンで対応)
- ミニアプリのページ要素のクリック。ページ要素がクリックされたときにトリガーされ、自動的に記録します(3.2.0以上のバージョンで対応)
以下では、各データの収集方法について詳しく説明します
1. 自動収集イベントの有効化
configでは、パラメータautoTrack内の各要素が自動収集イベントごとのオン/オフを表します。trueに設定すると自動収集が有効になります:
var config = {
appid: "YOU-APP-ID",
server_url: "https://youserverurl.com",
autoTrack: {
appLaunch: true, // ta_mp_launchを自動収集
appShow: true, // ta_mp_showを自動収集
appHide: true, // ta_mp_hideを自動収集
pageShow: true, // ta_mp_viewを自動収集
pageShare: true, // ta_mp_shareを自動収集
pageLeave: true,// ta_page_leaveを自動収集
mpFavorite: true,// ta_add_favoriteを自動収集
mpClick: true,// ta_mp_clickを自動収集
properties: { // 自動収集のカスタムプロパティ
staticKey: 'staticValue'
},
callback: (eventType:any) => { // 自動収集のコールバック
if (eventType === 'appShow') {
return { appShowKey: 'appShowValue' };
} else if (eventType === 'appHide') {
return { appHideKey: 'appHideValue' };
} else {
return {};
}
}
}
};
appLaunch:ミニアプリの初期化を自動収集appShow:ミニアプリの起動、またはバックグラウンドからフォアグラウンドへの移行を自動収集appHide:ミニアプリのフォアグラウンドからバックグラウンドへの移行を自動収集pageShow:ミニアプリのページ表示またはフォアグラウンドへの切り替えを自動収集pageShare:ミニアプリの転送・シェアを自動収集pageLeave:ミニアプリのページのアンロードを自動収集mpFavorite:ページのお気に入り登録を自動収集mpClick:ページ要素のクリックを自動収集properties:自動収集のカスタムプロパティ(appShow/appHideに対応)callback:自動収集のコールバック(appShow/appHideに対応)
プラットフォームごとに実行環境や構造が異なるため、対応している自動収集イベントも異なります。対応一覧は次のとおりです:
| プラットフォーム | appLaunch | appShow | appHide | pageShow | pageShare | pageLeave | mpFavorite | mpClick |
|---|---|---|---|---|---|---|---|---|
| ミニアプリ | √ | √ | √ | √ | √ | √ | √ | √ |
| ミニゲーム | √ | √ | √ |
2. 自動収集イベントの詳細
2.1 ミニアプリの初期化
ミニアプリの初期化は、ミニアプリが初めて開かれたとき、またはユーザーがプロセスを終了してから再び開いたときにトリガーされます。プロセスのライフサイクル内で1回だけトリガーされます。イベントの詳細は次のとおりです:
-
イベント名:ta_mp_launch
-
自動収集プロパティ:
#scene:シーン値。WeChatが提供するシーン値から取得します#start_reason:アプリの起動元。内容はJSON文字列で、getLaunchOptionsSyncインターフェースから取得したパラメータです
ミニアプリの初期化イベントを使うと、1日あたりのユーザーの使用回数や1人あたりの使用回数を計算できます。シーン値でグループ化して、シーン値ごとのユーザーの利用状況を確認することもできます。
2.2 ミニアプリの起動
ミニアプリの起動は、ミニアプリが起動されたとき、またはミニアプリがバックグラウンドからフォアグラウンドに戻ったときにトリガーされます。イベントの詳細は次のとおりです:
-
イベント名:ta_mp_show
-
自動収集プロパティ:
#scene:シーン値。WeChatが提供するシーン値から取得します#url_path:ページパス。ミニアプリの起動時に表示されたページのパスです#start_reason:アプリの起動元。内容はJSON文字列で、getLaunchOptionsSyncインターフェースから取得したパラメータです
ミニアプリの起動は、フォアグラウンドとバックグラウンドの切り替えの影響を受ける(件数が多い)ため、直接の分析にはあまり適していません。ただし、行動フローの中でユーザーの1回の利用を示すことができ、ユーザーの行動フローの最初の行動として使えます
2.3 ミニアプリの非表示
ミニアプリの非表示は、ミニアプリがバックグラウンドに移行したときにトリガーされ、今回の利用時間を記録します。イベントの詳細は次のとおりです:
-
イベント名:ta_mp_hide
-
自動収集プロパティ:
#scene:シーン値。WeChatが提供するシーン値から取得します#duration:数値型。今回の起動(ta_mp_show)から非表示になるまでの継続時間を表します
ミニアプリの非表示イベントは利用時間(単位は秒)を記録するため、ユーザーの総利用時間や1人あたりの利用時間を直接計算できます。初期化回数で割って1回あたりの利用時間を計算することもできます。
2.4 ミニアプリのページビュー
ミニアプリのページビューは、ミニアプリのページが開かれたとき、またはミニアプリがバックグラウンドからフォアグラウンドに戻ってページが表示されたときにトリガーされ、ページのパスとアクセスの参照元パスを記録します。イベントの詳細は次のとおりです:
-
イベント名:ta_mp_view
-
自動収集プロパティ:
#scene:シーン値。WeChatが提供するシーン値から取得します#url_path:ページパス。表示されたページのパスです#referrer:参照元パス。表示されたページの前のページのパス、つまり遷移前のパスです。ミニアプリの起動時に表示されたトップページの場合、値は「直接打开」になります
ミニアプリのページビューイベントを使うと、各ページのpv、uvや、ユーザーがミニアプリを利用した経路を計算できます。
2.5 ミニアプリのページの転送・シェア
ミニアプリのページの転送・シェアは、転送ボタンがクリックされたとき(右上のナビゲーションバーの転送ボタンと、ページ内の転送ボタンを含む)にトリガーされます。イベントの詳細は次のとおりです:
-
イベント名:ta_mp_share
-
自動収集プロパティ:
#scene:シーン値。WeChatが提供するシーン値から取得します#url_path:ページパス。転送時のページパスです
ミニアプリのページの転送・シェアイベントは、ページのシェア率の分析に適しており、ページの転送の最適化に役立ちます。
2.6 ミニアプリのページのアンロード
ミニアプリのページがアンロードされたとき(他のページに移動したときなど)にトリガーされます。イベントの詳細は次のとおりです:
-
イベント名:ta_page_leave
-
自動収集プロパティ:
#duration:ページの滞在時間#url_path:ページパス。ページのアンロード時のパスです
2.7 ミニアプリのページのお気に入り登録
ミニアプリのページがお気に入りに登録されたときにトリガーされます。イベントの詳細は次のとおりです:
- イベント名:ta_add_favorite
- 自動収集プロパティ:
#url_path:ページパス。ページのアンロード時のパスです
2.8 ミニアプリのページ要素のクリック
ミニアプリのページ要素がクリックされたときにトリガーされます。イベントの詳細は次のとおりです:
-
イベント名:ta_mp_click
-
自動収集プロパティ:
#element_id:要素ID#element_type:要素タイプ#element_content:要素の内容#element_name:要素名

