applican

マイページに戻る

FirebaseAnalytics

google社が提供するウェブ解析ツール（FirebaseAnalytics）にデータを送りFirebaseAnalytics上でデータを閲覧するための機能です。

【対応ランタイムバージョン】

ランタイムのバージョン毎に最適化したサンプルをダウンロードしてご使用ください。

メソッド

init

メソッド説明

init(successCallback, errorCallback)

Firebase Analytics の初期化を行います。

パラメータ

successCallback : Function 初期化が完了した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

applican.firebaseAnalytics.init(function() {
  console.log("success: init()");
});

setMinimumSessionInterval

メソッド説明

setMinimumSessionInterval(Number interval, successCallback, errorCallback)

最小セッション間隔を設定します。

パラメータ

interval : Number インターバルを指定します。
初期値は1800000ミリ秒。
単位はミリ秒で指定します。
successCallback : Function 最小セッション間隔が設定完了した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

// 間隔を 30 秒に設定
applican.firebaseAnalytics.setMinimumSessionInterval(30000, function() {
  console.log("success: setMinimumSessionInterval()");
  }, function(error) {
    switch(error.code) {
    case applican.firebaseAnalytics.ERROR_NOT_INITIALIZED:
      break;
    case applican.firebaseAnalytics.ERROR_INVALID_ARGUMENTS:
      break;
    }
  });

setSessionTimeoutInterval

メソッド説明

setSessionTimeoutInterval(Number interval, successCallback, errorCallback)

セッションタイムアウト間隔を設定します。

パラメータ

interval : Number インターバルを指定します。
初期値は1800000ミリ秒。
単位はミリ秒で指定します。
successCallback : Function セッションタイムアウト間隔が設定完了した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

// タイムアウトを 1 時間に設定
applican.firebaseAnalytics.setSessionTimeoutInterval(3600000, function() {
  console.log("success: setSessionTimeoutInterval()");
  }, function(error) {
    switch(error.code) {
    case applican.firebaseAnalytics.ERROR_NOT_INITIALIZED:
      break;
    case applican.firebaseAnalytics.ERROR_INVALID_ARGUMENTS:
      break;
    }
  });

logEvent

メソッド説明

logEvent(String name, Object parameters, successCallback, errorCallback)

イベントを記録します。

パラメータ

name : String イベント名を指定します。
英字から始まる 40 文字までの英数字を使用できます。
いくつかのイベント名は予約されており、接頭辞 "firebase_" "google_" "ga_" も予約されています。
以下のイベント名は予約されており、使用できません。
- ad_activeview
- ad_click
- ad_exposure
- ad_impression
- ad_query
- adunit_exposure
- app_clear_data
- app_uninstall
- app_update
- error
- first_open
- first_visit
- in_app_purchase
- notification_dismiss
- notification_foreground
- notification_open
- notification_receive
- os_update
- screen_view
- session_start
- user_engagement
parameters : Object キーバリューストアパラメーターを指定します。
キー名は英字から始まる 40 文字までの英数字を使用できます。
接頭辞 "firebase_" "google_" "ga_" は予約されています。
successCallback : Function イベントが記録完了した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

// キーバリューストアパラメーターを設定。
var params = {
  foo: "bar",
};

applican.firebaseAnalytics.logEvent("test_event", params, function() {
  console.log("success: logEvent()");
  }, function(error) {
    switch(error.code) {
    case applican.firebaseAnalytics.ERROR_NOT_INITIALIZED:
      break;
    case applican.firebaseAnalytics.ERROR_INVALID_ARGUMENTS:
      break;
    }
  });

setUserProperty

メソッド説明

setUserProperty(String name, String value, successCallback, errorCallback)

ユーザープロパティーを設定します。(最大 25 個まで)

パラメータ

name : String プロパティ名を指定します。
英字から始まる 24 文字までの英数字を使用できます。
接頭辞 "firebase_" "google_" "ga_" は予約されています。
以下のプロパティー名は予約されており、使用できません。
- first_open_time
- first_visit_time
- last_deep_link_referrer
- user_id
- first_open_after_install
value : String プロパティー値を指定します。
36 文字まで使用できます。
`null` を指定すると削除されます。
successCallback : Function イベントが記録完了した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

applican.firebaseAnalytics.setUserID("test_user_001", function() {
  console.log("success: setUserID()");
  }, function(error) {
    switch(error.code) {
    case applican.firebaseAnalytics.ERROR_NOT_INITIALIZED:
      break;
    case applican.firebaseAnalytics.ERROR_INVALID_ARGUMENTS:
      break;
    }
  });

setUserID

メソッド説明

setUserID(String userID, successCallback, errorCallback)

ユーザー ID を設定します。

パラメータ

userID : String ユーザーIDを指定します。
successCallback : Function ユーザー ID を設定完了した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

applican.firebaseAnalytics.setUserID("test_user_001", function() {
  console.log("success: setUserID()");
  }, function(error) {
    switch(error.code) {
    case applican.firebaseAnalytics.ERROR_NOT_INITIALIZED:
      break;
    case applican.firebaseAnalytics.ERROR_INVALID_ARGUMENTS:
      break;
    }
  });

setScreenName

メソッド説明

setScreenName(String screenName, successCallback, errorCallback)

スクリーン名を設定します。

パラメータ

screenName : String スクリーン名を指定します。
`null` を指定するとクリアします。
successCallback : Function スクリーン名を設定完了した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

applican.firebaseAnalytics.setScreenName("login_screen", function() {
  console.log("success: setScreenName()");
  }, function(error) {
    switch(error.code) {
    case applican.firebaseAnalytics.ERROR_NOT_INITIALIZED:
      break;
    case applican.firebaseAnalytics.ERROR_INVALID_ARGUMENTS:
      break;
    }
  });

getAppInstanceID

メソッド説明

getAppInstanceID(successCallback, errorCallback)

アプリケーションのインスタンス ID を取得します。

パラメータ

successCallback : Function アプリケーションのインスタンス ID を取得完了した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

applican.firebaseAnalytics.getAppInstanceID(function(instanceId) {
  console.log("success: getAppInstanceID() -> instanceId = " + instanceId);
  }, function(error) {
    switch(error.code) {
    case applican.firebaseAnalytics.ERROR_NOT_INITIALIZED:
      break;
    case applican.firebaseAnalytics.ERROR_INVALID_ARGUMENTS:
      break;
    }
  });

resetAnalyticsData

メソッド説明

resetAnalyticsData(successCallback, errorCallback)

解析データをクリアし、アプリケーションのインスタンス ID をリセットします。

パラメータ

successCallback : Function 解析データをクリアし、アプリケーションのインスタンス ID をリセット完了した場合にCallbackされます。
errorCallback : Function エラーが起きた場合にCallbackされます。

Return

void

サンプルコード

applican.firebaseAnalytics.resetAnalyticsData(function() {
  console.log("success: resetAnalyticsData()");
  }, function(error) {
    switch(error.code) {
    case applican.firebaseAnalytics.ERROR_NOT_INITIALIZED:
      break;
    case applican.firebaseAnalytics.ERROR_INVALID_ARGUMENTS:
      break;
    }
  });