Show Menu
トピック×

Adobe Mobile class and method reference

BlackBerry ライブラリが提供するクラスおよびメソッド。
The SDK currently has support for Adobe Analytics, and methods are in separate classes based on the solution.

SDK settings

  • getPrivacyStatus
    現在のユーザーのプライバシーステータスの enum 表現を返します。
    • ADBMobilePrivacyStatusOptIn - ヒットが即座に送信されます。
    • ADBMobilePrivacyStatusOptOut - ヒットは破棄されます。
    • ADBMobilePrivacyStatusUnknown - レポートスイートでタイムスタンプが有効になっている場合、プライバシーステータスがオプトイン(ヒットが送信される)またはオプトアウト(ヒットが破棄される)に変更されるまで、ヒットは保存されます。レポートスイートのタイムスタンプが有効になっていない場合、プライバシーステータスがオプトインに変更されるまで、ヒットは破棄されます。
      デフォルト値は ADBMobileConfig.json ファイルに設定します。
    • このメソッドの構文を次に示します。
      static ADBMobilePrivacyStatus getPrivacyStatus();
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobilePrivacyStatus privacyStatus = ADBMobile::getPrivacyStatus();
      
      
  • setPrivacyStatus
    現在のユーザーのプライバシーステータスを status に設定します。次のいずれかの値に設定します。
    • ADBMobilePrivacyStatusOptIn - hits are sent immediately.
    • ADBMobilePrivacyStatusOptOut — ヒットは破棄されます。
    • ADBMobilePrivacyStatusUnknown - レポートスイートでタイムスタンプが有効になっている場合、プライバシーステータスがオプトイン(ヒットが送信される)またはオプトアウト(ヒットが破棄される)に変更されるまで、ヒットは保存されます。レポートスイートのタイムスタンプが有効になっていない場合、プライバシーステータスがオプトインに変更されるまで、ヒットは破棄されます。
    • このメソッドの構文を次に示します。
      static void setPrivacyStatus(ADBMobilePrivacyStatus status);
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile::setPrivacyStatus(ADBMobilePrivacyStatusOptIn);
      
      
  • getUserIdentifier
    カスタム識別子が設定されている場合は、ユーザー識別子を返します。Returns null if a custom identifier is not set. デフォルト値は null です。
    • このメソッドの構文を次に示します。
      static QString getUserIdentifier();
      
      
    • このメソッドのコードサンプルを次に示します。
      QString userId = ADBMobile::getUserIdentifier(); 
      
      
  • setUserIdentifier
    ユーザー識別子を identifier に設定します。
    • このメソッドの構文を次に示します。
      static void setUserIdentifier(QString identifier);
      
      
    • このメソッドのコードサンプルを次に示します。
      ADBMobile::setUserIdentifier("billybob");
      
      
  • getDebugLogging
    現在のデバッグログの環境設定を返します。デフォルト値は false です。
    • このメソッドの構文を次に示します。
      static bool getDebugLogging();
      
      
    • このメソッドのコードサンプルを次に示します。
       bool debugging = ADBMobile::getDebugLogging(); 
      
      
  • setDebugLogging
    デバッグログの環境設定を debugLogging に設定します。
    • このメソッドの構文を次に示します。
      static void setDebugLogging(bool debugLogging);
      
      
    • このメソッドのコードサンプルを次に示します。
        ADBMobile::setDebugLogging(true); 
      
      
  • collectLifecycleData
    SDK のすべてのソリューションで使用するライフサイクルデータを収集するように SDK に指示します。詳しくは、 ライフサイクル指標 を参照してください。
    • このメソッドの構文を次に示します。
      static void collectLifecycleData();
      
      
    • このメソッドのコードサンプルを次に示します。
      ApplicationUI::ApplicationUI(bb::cascades::Application *app):  QObject(app)  { 
      //... 
      ADBMobile::collectLifecycleData(); 
      }
      
      

Analytics methods

これらの各メソッドを使用して、Adobe Analytics レポートスイートにデータを送信します。
  • trackState
    オプションのコンテキストデータでアプリ状態を追跡します。状態とは、アプリで使用可能なビューのことで、「home dashboard」、「app settings」、「cart」などがあります。これらの状態は Web サイト上のページによく似ており、 trackState コールはページビュー数を増分します。
    This is the only tracking call that increments page views.
    • このメソッドの構文を次に示します。
      static void trackState(QString state, QHash<QString, QString> contextData = QHash<QString, QString>()); 
      
      
    • このメソッドのコードサンプルを次に示します。
         ADBMobile::trackState("loginScreen", null);
      
      
  • trackAction
    アプリのアクションを追跡します。アクションとは、アプリ内で測定対象となる重要な操作のことで、「logons」、「banner taps」、「feed subscriptions」などの指標があります。
    • このメソッドの構文を次に示します。
      static void trackAction(QString action, QHash<QString, QString> contextData = QHash<QString, QString>()); 
      
      
    • このメソッドのコードサンプルを次に示します。
        ADBMobile::trackAction("heroBannerTouched", null); 
      
      
  • trackLocation
    現在の XY 座標を送信します。イベントを、サブスクライバーから BPS に受信されるイベントに置き換えます。
    • このメソッドの構文を次に示します。
      static void trackLocation(bps_event_t *geoEvent, QHash<QString, QString> contextData = QHash<QString, QString> ());
      
      
    • このメソッドのコードサンプルを次に示します。
        ADBMobile::trackLocation(event, null);
      
      

ADBMobileConfig.json 設定ファイルの参照

The ADBMobileConfig.json file must be placed in the assets folder.
  • rsids
    (必須)Analytics データを受け取るための 1 つまたは複数のレポートスイート。レポートスイート ID を複数指定する場合は、スペースを入れずにレポートスイート ID をコンマで区切る必要があります。
    Here are the code sample for this variable:
    "rsids" : "rsid"
    
    
    "rsids" : "rsid1,rsid2"
    
    
  • server
    (必須). Analytics サーバー。This variable should be populated with the server domain, without an https:// or https:// protocol prefix. プロトコルプレフィックスは、 ssl 変数に基づいてライブラリで自動的に処理されます。 ssl true の場合、このサーバーとの安全な接続が確立されます。 ssl false の場合、このサーバーとの安全でない接続が確立されます。
  • charset
    Analytics に送信されるデータに使用する文字セットを定義します。この文字セットは、受信データを格納およびレポート用に UTF-8 に変換するために使用されます。
  • ssl
    Enables ( true ) or disables ( false ) sending measurement data via SSL (HTTPS). デフォルト値は false です。
  • offlineEnabled
    When enabled ( true ), hits are queued while the device is offline and sent later when the device is online. オフライン追跡を使用するには、レポートスイートでタイムスタンプを有効にする必要があります。
    If timestamps are enabled on your report suite, your offlineEnabled configuration property must be true . レポートスイートでタイムスタンプが有効になっていない場合、 offlineEnabled 設定プロパティを​ 必ず false に設定してください。このプロパティを適切に設定しなければ、データが失われます。レポートスイートのタイムスタンプが有効になっているかどうか判断できない場合は、 contact Enterprise Support. enterprise-support.ec.html
    現在、同じレポートスイートで JavaScript と AppMeasurement からデータを収集している場合は、モバイルデータのレポートスイートを個別に設定するか、 s.timestamp 変数を使用するすべての JavaScript ヒットにカスタムタイムスタンプを含めます。
    デフォルト値は false です。
  • lifecycleTimeout
    アプリケーションの起動が新しいセッションであると見なされるまでの経過時間を秒数で指定します。このタイムアウトは、アプリケーションがバックグラウンドに移行し、再びアクティブになる場合にも適用されます。アプリケーションがバックグラウンドになっている時間はセッションの長さには含まれません。
    デフォルト値は 300 秒です。
  • batchLimit
    キューに格納されるオフラインヒットの最大数。デフォルト値は0(制限なし)です。
  • privacyDefault
    • optedin — ヒットは直ちに送信されます。
    • optedout — ヒットは破棄されます。
    • optunknown - レポートスイートでタイムスタンプが有効になっている場合、プライバシーステータスがオプトイン(ヒットが送信される)またはオプトアウト(ヒットが破棄される)に変更されるまで、ヒットは保存されます。
      レポートスイートのタイムスタンプが有効になっていない場合、プライバシーステータスがオプトインに変更されるまで、ヒットは破棄されます。 この変数は初期値のみを設定します。 この値をコードで設定または変更した場合、値が変更されるか、アプリがアンインストールされて再インストールされるまで、新しい値が使用されます。
    デフォルト値は optedin です。
ADBMobileConfig.json ファイルの例を次に示します。
{ 
    "version" : "1.0", 
    "analytics" : { 
        "rsids" : "coolApp", 
        "server" : "my.CoolApp.com", 
        "charset" : "UTF-8", 
        "ssl" : true, 
        "offlineEnabled" : true, 
        "lifecycleTimeout" : 5, 
        "privacyDefault" : "optedin", 
    } 
}