Show Menu
主题×

ADBMobile.cs methods

配置方法

  • CollectLifecycleData
    指示 SDK 应收集生命周期数据以在 SDK 的所有解决方案中使用。有关更多信息,请参阅 生命周期量度
    • 下面是这种方法对应的语法:
      public static void CollectLifecycleData();
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.CollectLifecycleData(); 
      
      
  • EnableLocalNotifications(仅限 iOS)
    在您的应用程序中启用本机通知。
    • 下面是这种方法对应的语法:
      public static void EnableLocalNotifications();
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.EnableLocalNotifications(); 
      
      
  • GetDebugLogging
    返回当前的调试日志记录首选项。默认值为 false .
    • 下面是这种方法对应的语法:
      public static bool GetDebugLogging();
      
      
    • 以下是这种方法的代码示例:
      var debugEnabled = ADBMobile.GetDebugLogging();
      
      
  • GetLifetimeValue
    返回当前用户的生命周期值。
    • 下面是这种方法对应的语法:
      public static double GetLifetimeValue();
      
      
    • 以下是这种方法的代码示例:
      var lifetimeValuea = ADBMobile.GetLifetimeValue();
      
      
  • GetPrivacyStatus
    返回当前用户隐私状态的枚举表示形式。
    • MOBILE_PRIVACY_STATUS_OPT_IN :点击会立即发送。
    • MOBILE_PRIVACY_STATUS_OPT_OUT :将丢弃点击。
    • MOBILE_PRIVACY_STATUS_UNKNOWN :如果启用了离线跟踪,将会保存点击,直到隐私状态更改为选择启用(发送点击)或选择禁用(丢弃点击)。
      如果未启用离线跟踪,则将丢弃点击,直到隐私状态更改为选择启用。默认值在 ADBMobileConfig.json 文件中设置。
    • 下面是这种方法对应的语法:
      public static ADBPrivacyStatus GetPrivacyStatus();
      
      
    • 以下是这种方法的代码示例:
      var privacyStatus = ADBMobile.GetPrivacyStatus();
      
      
  • GetUserIdentifier
    如果设置了自定义标识符,则返回自定义用户标识符。如果未设置自定义标识符,则返回 null。默认值为 null .
    • 下面是这种方法对应的语法:
      public static string GetUserIdentifier();
      
      
    • 以下是这种方法的代码示例:
      var userId = ADBMobile.GetUserIdentifier(); 
      
      
  • GetVersion
    获取库版本。
    • 下面是这种方法对应的语法:
      public static string GetVersion();
      
      
    • 以下是这种方法的代码示例:
      var version = ADBMobile.GetVersion();
      
      
  • KeepLifecycleSessionAlive(仅限 iOS)
    指示 SDK 无论配置文件中的生命周期会话超时值为多少,下次从后台恢复时都不应启动新会话。
    此方法适用于在后台注册通知的应用程序,并且只应从应用程序在后台运行的代码中调用。
    • 下面是这种方法对应的语法:
      public static void KeepLifecycleSessionAlive(); 
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.KeepLifecycleSessionAlive(); 
      
      
  • PauseCollectingLifecycleData(仅限 Android)
    指示 SDK 您的应用程序已暂停,以便正确计算生命周期量度。例如,暂停时收集时间戳以确定上一个会话时长。此方法还会设置一个标记,以便生命周期准确知道应用程序并没有崩溃。有关更多信息,请参阅 生命周期量度
    • 下面是这种方法对应的语法:
      public static void PauseCollectingLifecycleData();
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.PauseCollectingLifecycleData(); 
      
      
  • SetContext(仅限 Android)
    向 SDK 指明,应该通过 UnityPlayer 的当前活动设置其应用程序上下文.
    • 下面是这种方法对应的语法:
      public static void SetContext();
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.SetContext(); 
      
      
  • SetDebugLogging
    将调试日志记录首选项设置为启用。
    • 下面是这种方法对应的语法:
      public static void SetDebugLogging (bool enabled); 
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.SetDebugLogging(true); 
      
      
  • SetPrivacyStatus
    设置当前用户的隐私状态。设置为以下值之一:
    • MOBILE_PRIVACY_STATUS_OPT_IN :点击会立即发送。
    • MOBILE_PRIVACY_STATUS_OPT_OUT :将丢弃点击。
    • MOBILE_PRIVACY_STATUS_UNKNOWN :如果启用了离线跟踪,将会保存点击,直到隐私状态更改为选择启用(发送点击)或选择禁用(丢弃点击)。如果未启用离线跟踪,则将丢弃点击,直到隐私状态更改为选择启用。
    • 下面是这种方法对应的语法:
      public static void SetPrivacyStatus(ADBPrivacyStatusstatus); 
      
      
    • 以下是此语法的代码示例:
      ADBMobile.SetPrivacyStatus(ADBMobile.ADBPrivacyStatus.MOBILE_PRIVACY_STATUS_OPT_IN);
      
      
  • SetUserIdentifier
    将用户标识符设置为 userId。
    • 下面是这种方法对应的语法:
      public static void SetUserIdentifier(string userId); 
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.SetUserIdentifier("myCustomUserId"); 
      
      

分析方法

  • GetTrackingIdentifier
    检索分析跟踪标识符。
    • 下面是这种方法对应的语法:
      public static string GetTrackingIdentifier();
      
      
    • 以下是这种方法的代码示例:
      var trackingId = ADBMobile.GetTrackingIdentifier(); 
      
      
  • TrackState
    通过可选的上下文数据跟踪应用程序状态。状态是指应用程序中可用的视图,如“标题屏幕”、“级别 1”、“暂停”,等等。这些状态与网站中的页面类似,而且 TrackState 调用会使页面查看次数递增。
    如果状态为空,则状态将显示为报 app name app version (build) 告中的状态。 如果您在报表中看到该值,请确保在每个 TrackState 调用中设置 state。
    这是唯一可增加页面查看次数的跟踪调用。
    • 下面是这种方法对应的语法:
      public static void TrackState(string state, Dictionary<string, object> cdata);
      
      
    • 以下是这种方法的代码示例:
      var contextData = new Dictionary<string, object>); 
      contextData.Add ("user", "jim");
      ADBMobile.TrackState("title screen", contextData);
      
      
  • TrackAction
    跟踪应用程序中的操作。操作是指应用程序中发生的需要测量的事件,如“终止次数”、“获取的级别”、“信息源订阅”及其他量度。
    If you have code that might run while the app is in the background (for example, a background data retrieval), use trackActionFromBackground instead.
    • 下面是这种方法对应的语法:
      public static void TrackAction(string action, Dictionary<string, object> cdata); 
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.TrackAction("level gained", null); 
      
      
  • TrackActionFromBackground(仅限 iOS)
    跟踪后台发生的操作。此方法在某些情况下会阻止生命周期事件的触发。
    只应在应用程序处于后台时运行的代码中调用此方法。
    • 下面是这种方法对应的语法:
      public static void TrackActionFromBackground(string action, Dictionary<string,object> cdata); 
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.TrackActionFromBackground("majorLocationChange", null);
      
      
  • TrackLocation
    发送当前纬度和经度坐标。此方法还使用 ADBMobileConfig.json 文件中定义的目标点来确定作为参数提供的位置是否位于您的任何 POI 内。如果当前坐标位于定义的 POI 内,则会填充上下文数据变量并且与 TrackLocation 调用一起发送。
    • 下面是这种方法对应的语法:
      public static void TrackLocation(float latValue, float lonValue, Dictionary<string, object> cdata); 
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.TrackLocation(28.418649, -81.581324, null); 
      
      
  • TrackBeacon
    跟踪用户接近信标的时间。
    • 下面是这种方法对应的语法:
      public static void TrackBeacon(int major, int minor, string uuid, ADBBeaconProximity proximity, Dictionary<string, object> cdata); 
      
      
  • TrackingClearCurrentBeacon
    在用户远离信标后清除信标数据。
    • 下面是这种方法对应的语法:
      public static void TrackingClearCurrentBeacon(); 
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.TrackingClearCurrentBeacon();
      
      
  • TrackLifetimeValueIncrease
    增加用户生命周期值的数量。
    • 下面是这种方法对应的语法:
      public static void TrackLifetimeValueIncrease(double amount, Dictionary<string, object> cdata);
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.TrackLifetimeValueIncrease(5, null); 
      
      
  • TrackTimedActionStart
    开始具有指定操作名称的定时操作。如果对已启动的操作调用此方法,则将覆盖上一个定时操作。
    这个调用不发送点击。
    • 下面是这种方法对应的语法:
      public static void TrackTimedActionStart(string action, Dictionary<string,object> cdata); 
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.TrackTimedActionStart("level2", null);
      
      
  • TrackTimedActionUpdate
    传入数据以更新与给定操作关联的上下文数据。传入的数据会附加在给定操作的现有数据之后,但如果已为操作定义了相同的键值,则会覆盖现有数据。
    这个调用不发送点击。
    • 下面是这种方法对应的语法:
      public static void TrackTimedActionUpdate(string action, Dictionary<string, object> cdata); 
      
      
    • 以下是这种方法的代码示例:
      var contextData = new Dictionary<string, object>; 
      contextData.Add("checkpoint", "1:32"); 
         ADBMobile.TrackTimedActionUpdate("level2", contextData);
      
      
  • TrackTimedActionEnd
    结束定时操作。
    • 下面是这种方法对应的语法:
      public static void TrackTimedActionEnd(string action); 
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.TrackTimedActionEnd("level2"); 
      
      
  • TrackingTimedActionExists
    返回定时操作是否正在进行中。
    • 下面是这种方法对应的语法:
      public static bool TrackingTimedActionExists(string action); 
      
      
    • 以下是这种方法的代码示例:
       var level2InProgress = ADBMobile.TrackingTimedActionExists("level2"); 
      
      
  • TrackingSendQueuedHits
    强制库发送离线队列中的所有点击,而不考虑当前排队的点击量。
    • 下面是这种方法对应的语法:
      public static void TrackingSendQueuedHits();
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.TrackingSendQueuedHits(); 
      
      
  • TrackingClearQueue
    清除离线队列中的所有点击。
    • 下面是这种方法对应的语法:
      public static void TrackingClearQueue();
      
      
    • 以下是这种方法的代码示例:
      ADBMobile.TrackingClearQueue(); 
      
      
  • TrackingGetQueueSize
    检索离线队列中的当前点击量。
    • 下面是这种方法对应的语法:
      public static int TrackingGetQueueSize();
      
      
    • 以下是这种方法的代码示例:
      var queueSize = ADBMobile.TrackingGetQueueSize();
      
      

Experience Cloud ID方法

  • GetMarketingCloudID
    从 ID 服务中检索 Experience Cloud ID。
    • 下面是这种方法对应的语法:
      public static string GetMarketingCloudID(); 
      
      
    • 以下是这种方法的代码示例:
      var mcid = ADBMobile.GetMarketingCloudID();
      
      
  • VisitorSyncIdentifiers
    使用 Experience Cloud ID,您可以设置其他的客户 ID 以便关联每位访客。访客 API 可以接受同一访客的多个客户 ID 和一个客户类型标识符(用以区分不同客户 ID 的作用范围)。此方法对应于 JavaScript 库中的 setCustomerIDs。
    • 下面是这种方法对应的语法:
      public static void VisitorSyncIdentifiers(Dictionary<string, object> identifiers); 
      
      
    • 以下是这种方法的代码示例:
      var ids = new Dictionary<string, object> (); 
      ids.Add ("player1", "jimbob"); 
      ADBMobile.VisitorSyncIdentifiers(ids);