Show Menu
主题×

SDK methods

由通用 Windows 平台库提供的类和方法。
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();
      
      
    • 以下是这种方法的代码示例:
      var ADB = ADBMobile;var libVersion = ADB.Config.getVersion();
      
      
  • GetPrivacyStatusAsync (winJS: getPrivacyStatusAsync)
    返回当前用户隐私状态的枚举表示形式。
    • ADBMobilePrivacyStatusOptIn - Hits are sent immediately.
    • ADBMobilePrivacyStatusOptOut -丢弃点击。
    • ADBMobilePrivacyStatusUnknown - 如果您的报表包启用了时间戳,将会保存点击,直到隐私状态更改为选择启用(发送点击)或选择禁用(丢弃点击)。如果您的报表包未启用时间戳,则将丢弃点击,直到隐私状态更改为选择启用。
      The default value is set in the ADBMobileConfig.json config file. For more information, see ADBMobileConfig.json config file. ADBMobileConfig.json配置文件
    • 下面是这种方法对应的语法:
      static Windows::Foundation::IAsyncOperation<ADBMobilePrivacyStatus>
      ^getPrivacyStatusAsync();
      
      
    • 以下是此方法的代码示例:
      C Sharp
      public enum class ADBMobilePrivacyStatus : int { ADBMobilePrivacyStatusOptIn = 1, 
      ADBMobilePrivacyStatusOptOut = 2, 
      ADBMobilePrivacyStatusUnknown = 3};
      
      
      JavaScript
      var ADB = ADBMobile;
      var status;
      ADB.Config.getPrivacyStatusAsync.then(function(privacyStatus) {
        status = privacyStatus;}
      );
      
      
  • SetPrivacyStatus (winJS: setPrivacyStatus)
    将当前用户的隐私状态设置为 status 。设置为以下值之一:
    • ADBMobilePrivacyStatusOptIn -立即发送点击。
    • ADBMobilePrivacyStatusOptOut -丢弃点击。
    • DBMobilePrivacyStatusUnknown -如果您的报表包启用了时间戳,则会保存点击,直到隐私状态更改为选择加入(发送点击)或选择退出(丢弃点击)。 如果您的报表包未启用时间戳,则将丢弃点击,直到隐私状态更改为选择启用。
      • 下面是这种方法对应的语法:
        static void SetPrivacyStatus(ADBMobilePrivacyStatus status);
        
        
      • 以下是此方法的代码示例:
        C-sharp
        public enum class ADBMobilePrivacyStatus : int { 
          ADBMobilePrivacyStatusOptIn = 1, 
          ADBMobilePrivacyStatusOptOut = 2
          ADBMobilePrivacyStatusUnknown = 3
        };
        
        
        JavaScript
        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)
    如果设置了自定义标识符,则返回自定义用户标识符。Returns null if a custom identifier is not set. 默认值为 null .
    如果您的应用程序从Experience Cloud 3.x升级到4.x SDK,则将检索之前的ID服务(自定义或自动生成)并将其存储为自定义用户标识符。 这样可在 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 的所有解决方案中使用。有关更多信息,请参阅 Lifecycle metrics .
    • 下面是这种方法对应的语法:
      static void CollectLifecycleData();
      
      
    • 以下是这种方法的代码示例:
      var ADB = ADBMobile;
      ADB.Config.collectLifecycleData();
      
      
  • 暂停收​集生命周期数据(winJS:pauseCollecting ​ LifecycleData)
    指示 SDK 您的应用程序已暂停,以便正确计算生命周期量度。例如,暂停时收集时间戳以确定上一个会话时长。此方法还会设置一个标记,以便生命周期准确知道应用程序并没有崩溃。有关更多信息,请参阅 生命周期量度
    • 下面是这种方法对应的语法:
      static void PauseCollectingLifecycleData();
      
      
    • 以下是这种方法的代码示例:
      var ADB = ADBMobile;
      ADB.Config.pauseCollectingLifecycleData();