Show Menu
トピック×

SDK methods

Windows 8.1 ユニバーサルアプリストアライブラリによって提供されるクラスとメソッドです。
When you consume winmd methods from winJS (JavaScript), all methods automatically have their first letter lowercased.
  • GetVersion (winJS:getVersion)
    Adobe Mobile ライブラリの現在のバージョンを返します。
    • このメソッドの構文を次に示します。
      static Platform::String ^GetVersion();
      
      
    • このメソッドのコードサンプルを次に示します。
      varADB = ADBMobile;var libVersion = ADB.Config.getVersion(); 
      
      
  • GetPrivacyStatusAsync (winJS:getPrivacyStatusAsync)
    現在のユーザーのプライバシーステータスの enum 表現を返します。
    • ADBMobilePrivacyStatusOptIn — ヒットは直ちに送信されます。
    • ADBMobilePrivacyStatusOptOut — ヒットは破棄されます。
    • ADBMobilePrivacyStatusUnknown - レポートスイートでタイムスタンプが有効になっている場合、プライバシーステータスがオプトイン(ヒットが送信される)またはオプトアウト(ヒットが破棄される)に変更されるまで、ヒットは保存されます。レポートスイートのタイムスタンプが有効になっていない場合、プライバシーステータスがオプトインに変更されるまで、ヒットは破棄されます。
      The default value is set in the ADBMobileConfig.json config file.
    • このメソッドの構文を次に示します。
      static Windows::Foundation::IAsyncOperation<ADBMobilePrivacyStatus> ^getPrivacyStatusAsync(); 
      
      
    • Here are the code samples for this method:
      public enum class ADBMobilePrivacyStatus : int  {
        ADBMobilePrivacyStatusOptIn = 1, 
        ADBMobilePrivacyStatusOptOut =  2,
        ADBMobilePrivacyStatusUnknown = 3
      };
      
      
      var ADB = ADBMobile;
      var status;
      ADB.Config.getPrivacyStatusAsync.then(function(privacyStatus) {
      status = privacyStatus;
      }); 
      
      
  • SetPrivacyStatus (winJS:setPrivacyStatus)
    現在のユーザーのプライバシーステータスを status に設定します。次のいずれかの値に設定します。
    • ADBMobilePrivacyStatusOptIn — ヒットは直ちに送信されます。
    • ADBMobilePrivacyStatusOptOut — ヒットは破棄されます。
    • ADBMobilePrivacyStatusUnknown - レポートスイートでタイムスタンプが有効になっている場合、プライバシーステータスがオプトイン(ヒットが送信される)またはオプトアウト(ヒットが破棄される)に変更されるまで、ヒットは保存されます。レポートスイートのタイムスタンプが有効になっていない場合、プライバシーステータスがオプトインに変更されるまで、ヒットは破棄されます。
    • このメソッドの構文を次に示します。
      static void SetPrivacyStatus(ADBMobilePrivacyStatus status);
      
      
    • このメソッドのコードサンプルを次に示します。
      public enum class ADBMobilePrivacyStatus : int {
        ADBMobilePrivacyStatusOptIn = 1,
        ADBMobilePrivacyStatusOptOut = 2,
        ADBMobilePrivacyStatusUnknown = 3
        }; 
      
      
      var ADB = ADBMobile;
      ADB.Config.setPrivacyStatus(ADB.ADBMobilePrivacyStatus.adbmobilePrivacyStatusOptIn); 
      
      
  • GetLifetimeValue (winJS:getLifetimeValue)
    現在のユーザーのライフタイム値を返します。デフォルトは 0 です。
    • このメソッドの構文を次に示します。
      static float GetLifetimeValue();
      
      
    • このメソッドのコードサンプルを次に示します。
       var ADB = ADBMobile;
       var ltv = ADB.Config.getLifetimeValue(); 
      
      
  • GetUserIdentifier (winJS:getUserIdentifier)
    カスタム識別子が設定されている場合、カスタムユーザー識別子を返します。カスタム識別子が設定されていない場合、null を返します。デフォルト値は null です。
    If your app upgrades from the Experience Cloud 3.x to 4.x SDK, the previous ID (either custom or automatically generated) is retrieved and stored as the custom user identifier. これにより、SDK をアップグレードしても訪問者データが保持されます。4.x SDK での新規インストールの場合、ユーザー識別子は設定されるまで null です。
    • このメソッドの構文を次に示します。
      static Platform::String^GetUserIdentifier();
      
      
    • このメソッドのコードサンプルを次に示します。
      var ADB = ADBMobile;
      var userId = ADB.Config.getUserIdentifier(); 
      
      
  • SetUserIdentifier (winJS:setUserIdentifier)
    ユーザー識別子を identifier に設定します。
    • このメソッドの構文を次に示します。
      static void SetUserIdentifier(Platform::String ^userIdentifier);
      
      
    • このメソッドのコードサンプルを次に示します。
      var ADB = ADBMobile;
      ADB.Config.setUserIdentifier("someUserId"); 
      
      
  • GetDebugLogging (winJS:getDebugLogging)
    現在のデバッグログの環境設定を返します。デフォルト値は false です。
    • このメソッドの構文を次に示します。
      static bool GetDebugLogging(); 
      
      
    • このメソッドのコードサンプルを次に示します。
      var ADB = ADBMobile;
      var logging = ADB.Config.getDebugLogging(); 
      
      
  • SetDebugLogging (winJS:setDebugLogging)
    デバッグログの環境設定を debugLogging に設定します。デバッグログはデバッグバージョンのライブラリを使用している場合にのみ機能し、リリースバージョンを使用している場合、この設定は無視されます。
    • このメソッドの構文を次に示します。
      static void SetDebugLogging(bool debugLogging); 
      
      
    • このメソッドのコードサンプルを次に示します。
      var ADB = ADBMobile;
      ADB.Config.setDebugLogging(true); 
      
      
  • CollectLifecycleData (winJS:collectLifecycleData)
    SDK のすべてのソリューションで使用するライフサイクルデータを収集するように SDK に指示します。詳しくは、 ライフサイクル指標 を参照してください。
    Invoke this method in the onResume() method in each Activity inside of your application, as shown in the following example. また、グローバルの Application コンテキストではなく、Activity または Service をコンテキストオブジェクトとして渡すことをお勧めします。
    • このメソッドの構文を次に示します。
      static void CollectLifecycleData();
      
      
    • このメソッドのコードサンプルを次に示します。
      var ADB = ADBMobile;
      ADB.Config.collectLifecycleData(); 
      
      
  • PauseCollecting ​ LifecycleData (winJS:pauseCollecting ​ LifecycleData)
    ライフサイクル指標が正しく計算されるように、アプリが一時停止されたことを SDK に通知します。例えば、一時停止中にタイムスタンプを収集して、セッションの長さの計測を一時停止します。また、クラッシュ回数を正しく計測するためのフラグを設定します。詳しくは、 ライフサイクル指標 を参照してください。
    Invoke this method in the onPause() methods in each Activity inside Your application, as shown in the example. また、グローバルの Application コンテキストではなく、Activity または Service をコンテキストオブジェクトとして渡すことをお勧めします。
    • このメソッドの構文を次に示します。
      static void PauseCollectingLifecycleData();
      
      
    • このメソッドのコードサンプルを次に示します。
      var ADB = ADBMobile;
      ADB.Config.pauseCollectingLifecycleData();