本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>ユーザーガイド>IoTデバイスハブ>Google Analytics スマートモジュールを利用する

Google Analytics スマートモジュールを利用する

このページではGoogle Analyticsスマートモジュールを利用して、IoTデバイスハブで管理されている各デバイスのイベントデータを可視化する方法を紹介していきます。

事前準備

Google Analyticsスマートモジュールを利用するためには、Google AnalyticsのトラッキングIDが必要です。

トラッキングIDを取得していない方は、スタートガイドをご覧いただき、セットアップをすすめてください。その際、トラッキングの対象として「ウェブサイト」または「モバイルアプリ」を選択する箇所がありますので「モバイルアプリ」を選択してください。

Google AnalyticsのUser ID機能を利用する場合はこちらのドキュメントをご覧ください。

Google Analytics スマートモジュールを作成する

IoTデバイスハブのコントロールパネルにアクセスし、左メニューからスマートモジュールを選択してください。

「+新規」ボタンをクリックするとスマートモジュール一覧が表示されますので、Google Analyticsの「+追加」ボタンをクリックしてください。

スマートモジュールリスト

新規作成するスマートモジュールの設定画面が表示されますので以下の項目を入力してください。

  • モジュールID : 他のスマートモジュールと区別するためのIDを3文字以上で決めてください。(後から変更はできません)
  • 説明 : スマートモジュールの用途や役割の説明文を入力してください。
  • トラッキングID : Google Analytics で取得したトラッキングIDを入力してください。

「保存」ボタンをクリックすることでスマートモジュールが作成されます。

スマートモジュールリスト

設定を確認する

Google Analyticsのダッシュボードにアクセスしてください。
レポートタブをクリックして、左メニューの「リアルタイム」のセクション内にある「イベント」を選択してください。
正しく設定できている場合には現在稼動中のデバイスが送信しているイベント件数がリアルタイムに表示されます。

Google Analytics スマートモジュール

稼働中のデバイスが無い場合には、IoTデバイスハブのコントロールパネルからデバイスシミュレーターを起動してイベントを発行することができます。

イベントを定義する

デバイスのイベントデータはGoogle Analytics上でもイベントと呼ばれます。
Google Analyticsにおけるイベントは以下の情報を持っています。

項目説明
カテゴリ`device:XXXX` というフォーマットで、XXXXの部分にはイベントを送信したデバイスのデバイスクラス名が設定されます。
アクションデバイスが送信したイベントのイベントタイプが設定されます。
ユニークユーザーIoTデバイスハブ上のホームがユーザーとしてGoogle Analytics上に表示されます `home:XXXX` というフォーマットで、XXXXの部分にはホームIDが設定されます。
ラベル後述のマッピング設定で定義されたフィールドのラベルが表示されます。
後述のマッピング設定で定義されたフィールドの値が表示されます。

Google Analyticsのイベントについて、詳細なドキュメントはこちらをご覧ください。

ラベルと値のマッピングを設定する

Google Analyticsのイベントラベルと値の属性は、デバイスからのイベントデータをどのようにマッピングするのかを スマートモジュールで設定することができます。
例として以下のような `sensor` イベントがデバイスから発行されるサンプルを示します。

 {
  "eventType": "sensor",
  "eventData": {
   "category": "humidity",
   "measurement": 123
 }

このイベントデータのcategoryフィールドをラベルとし、measurementフィールドを値とする場合の設定を行っていきます。 IoTデバイスハブのコントロールパネルからGoogle Analyticsのスマートモジュールを開き、歯車のアイコンをクリックして設定画面を開きます。

Google Analytics スマートモジュール 設定画面

上の例にあるマッピングを行うには、イベントデータマッピングのセクションにて以下のように入力していきます。

項目設定する値
イベントタイプIDsensor
イベントラベルのフィールドcategory
イベント値のフィールドmeasurement

「保存」ボタンをクリックしマッピング設定を完了すると、Google Analytics側でイベントラベルと値を確認することができます。
Google Analyticsスマートモジュールでは、5つのマッピング設定が可能です。

マッピング設定を完了

制限事項

  • Google Analyticsでは、1セッションあたりのイベント送信数の上限があります。
  • セッションはユニークユーザーに紐づくものであり、IoTデバイスハブのhomeとユニークユーザーIDが紐付いているので、あるhomeに属しているデバイスが継続的にイベントデータを送信する場合は、1セッションで処理できるイベント数の上限を超えてしまう可能性があります。
  • セッションはある期間でhomeに属しているデバイスからのイベントデータの送信がなかった場合に終了となります。
  • デフォルトではセッションの有効期限が30分となっているので、セッションのタイムアウト値を短く設定することで10秒間隔での継続的なイベントデータ送信などが可能となります。
  • セッションのタイムアウトを設定する方法については、Google Analyticsのドキュメントをご覧ください。

推奨画面サイズ 1024×768 以上