Show Menu
主题×

iOS方法

用于Experience Cloud解决方案4.x SDK的Xamarin组件的iOS方法。

配置方法

  • CollectLifecycleData
    指示 SDK 应收集生命周期数据以在 SDK 的所有解决方案中使用。有关更多信息,请参阅 生命周期量度
    • 以下是此方法的语法:
      public static void CollectLifecycleData();
      
      
    • 以下是此方法的代码示例:
      ADBMobile.CollectLifecycleData();
      
      
  • 调试日志记录
    返回当前的调试日志记录首选项。默认值为 false
    • 以下是此方法的语法:
      public static bool DebugLogging(); 
      
      
    • 以下是此方法的代码示例:
      var debugEnabled = ADBMobile.DebugLogging();
      
      
  • SetDebugLogging
    将调试日志记录首选项设置为启用。
    • 以下是此方法的语法:
      public static void SetDebugLogging(bool enabled);
      
      
    • 以下是此方法的代码示例:
      ADBMobile.SetDebugLogging(true);
      
      
  • LifetimeValue
    返回当前用户的生命周期值。
    • 以下是此方法的语法:
      public static double LifetimeValue();
      
      
    • 以下是此方法的代码示例:
      var lifetimeValue = ADBMobile.LifetimeValue();
      
      
  • 隐私状态
    返回当前用户隐私状态的枚举表示形式。
    • ADBMobilePrivacyStatus.OptIn - 立即发送点击。
    • ADBMobilePrivacyStatus.OptOut - 丢弃点击。
    • ADBMobilePrivacyStatus.Unknown —— 如果启用离线跟踪,则会保存点击,直到隐私状态更改为选择加入(然后发送点击)或选择退出(然后丢弃点击)。 如果禁用脱机跟踪,则会丢弃点击,直到隐私状态更改选择加入为。
    The default value is set in the ADBMobileConfig.json .
    • 以下是此方法的语法:
      public static ADBPrivacyStatus PrivacyStatus();
      
      
    • 以下是此方法的代码示例:
      var privacyStatus = ADBMobile.PrivacyStatus();
      
      
  • SetPrivacyStatus
    将当前用户的隐私状态设置为状态。 设置为以下值之一:
    • ADBMobilePrivacyStatus.OptIn - 立即发送点击。
    • ADBMobilePrivacyStatus.OptOut - 丢弃点击。
    • ADBMobilePrivacyStatus.Unknown - 如果启用了离线跟踪,将会保存点击,直到隐私状态更改为选择启用(发送点击)或选择禁用(丢弃点击)。如果未启用离线跟踪,则将丢弃点击,直到隐私状态更改为选择启用。
    • 以下是此方法的语法:
      public static void SetPrivacyStatus(ADBPrivacyStatus status) 
      
      
    • 以下是此方法的代码示例:
      ADBMobile.SetPrivacyStatus(ADBMobilePrivacyStatus.OptIn); 
      
      
  • 用户标识符
    如果已设置自定义标识符,则返回自定义用户标识符。 如果未设置自定义标识符,则返回null。 默认值为 null
    • 以下是此方法的语法:
      public static string UserIdentifier(); 
      
      
    • 以下是此方法的代码示例:
      var userId = ADBMobile.UserIdentifier(); 
      
      
  • SetUserIdentifier
    如果已设置自定义标识符,则返回自定义用户标识符。 如果未设置自定义标识符,则返回null。 默认值为 null
    • 以下是此方法的语法:
      public static string UserIdentifier();
      
      
    • 以下是此方法的代码示例:
      ADBMobile.SetUserIdentifier ("customUserIdentifier”); 
      
      
  • GetVersion
    获取库版本。
    • 以下是此方法的语法:
      public static string Version();
      
      
    • 以下是此方法的代码示例:
      var version = ADBMobile.Version();
      
      
  • KeepLifecycleSessionAlive(仅限iOS)
    指示 SDK 无论配置文件中的生命周期会话超时值为多少,下次从后台恢复时都不应启动新会话。
    此方法适用于在后台注册通知的应用程序,并且只应从应用程序在后台运行时运行的代码中调用。
    • 以下是此方法的语法:
      public static void KeepLifecycleSessionAlive();
      
      
    • 以下是此方法的代码示例:
      ADBMobile.KeepLifecycleSessionAlive();
      
      

Analytics 方法

  • 跟踪标识符
    检索分析跟踪标识符。
    • 以下是此方法的语法:
      public static string TrackingIdentifier();
      
      
    • 以下是此方法的代码示例:
      var trackingId = ADBMobile.TrackingIdentifier();
      
      
  • TrackState
    通过可选的上下文数据跟踪应用程序状态。状态是您的应用程序中可用的视图,如“标题屏幕”、“级别1”、“暂停”等。 这些状态与网站上的页面类似,并调 TrackState 用增量页面视图。如果状态为空,则在报告中将显示为“应用程序名称应用程序版本(内部版本)”。 If you see this value in reports, make sure you are setting state in each TrackState call.
    只有此跟踪调用会递增页面查看次数。
    • 以下是此方法的语法:
      public static void TrackState(string state, NSDictionary cdata); 
      
      
    • 以下是此方法的代码示例:
      NSDictionary contextData; 
       contextData = NSDictionary.FromObjectAndKey (NSObject.FromObject("val"),NSObject.FromObject("key")); 
        ADBMobile.TrackState("title screen", contextData); 
      
      
  • TrackAction
    跟踪您的应用程序中的操作。操作是您要衡量的应用程序中发生的事情,如“死亡”、“获得的级别”、“供给订阅”和其他指标。
    如果您的代码可能会在应用程序位于后台时运行(例如,后台数据检索),请改用 trackActionFromBackground
    • 以下是此方法的语法:
      public static void TrackAction(string action, NSDictionary cdata); 
      
      
    • 以下是此方法的代码示例:
      ADBMobile.TrackAction("level gained", null); 
      
      
  • TrackActionFromBackground(仅限iOS)
    跟踪在后台发生的操作。在某些情况下,这会阻止触发生命周期事件。
    仅应当在应用程序处于后台时运行的代码中调用此方法。
    • 以下是此方法的语法:
      public static void TrackActionFromBackground(string action, NSDictionary cdata); 
      
      
    • 以下是此方法的代码示例:
      ADBMobile.TrackActionFromBackground("majorLocationChange", null);
      
      
  • TrackLocation
    发送当前纬度和经度坐标。此方法还使用 ADBMobileConfig.json 文件中定义的目标点来确定作为参数提供的位置是否位于您的任何 POI 内。如果当前坐标位于定义的 POI 内,则会填充上下文数据变量,并随 TrackLocation 调用发送该变量。
    • 以下是此方法的语法:
      public static void TrackLocation(CLLocation location, NSDictionary cdata); 
      
      
    • 以下是此方法的代码示例:
      CoreLocation.CLLocation l = new CoreLocation.CLLocation  (111.111, 44.156);
      ADBMobile.TrackLocation (l, null);
      
      
  • TrackBeacon
    跟踪用户接近信标的时间。
    • 以下是此方法的语法:
      public static void TrackBeacon( CLBeacon beacon, NSDictionary cdata);
      
      
    • 以下是此方法的代码示例:
      CoreLocation.CLBeacon beacon = new CoreLocation.CLBeacon (); 
      ADBMobile.TrackBeacon (beacon, null);
      
      
  • TrackingClearCurrentBeacon
    在用户远离信标后清除信标数据。
    • 以下是此方法的语法:
      public static void TrackingClearCurrentBeacon();
      
      
    • 以下是此方法的代码示例:
      ADBMobile.TrackingClearCurrentBeacon();
      
      
  • TrackLifetimeValueIncrease
    增加用户终身价值。
    • 以下是此方法的语法:
      公共nbsp;静态void voidTrackLifetimeValueIncrease(多次量,NSDictionary cdata);
    • 以下是此方法的代码示例:
      ADBMobile.TrackLifetimeValueIncrease(5, null); 
      
      
  • TrackTimedActionStart
    开始具有指定操作名称的定时操作。如果对已启动的操作调用此方法,则将覆盖上一个定时操作。
    这个调用不发送点击。
    • 以下是此方法的语法:
      public static void TrackTimedActionStart(string action, NSDictionary cdata); 
      
      
    • 以下是此方法的代码示例:
      ADBMobile.TrackTimedActionStart("level2", null);
      
      
  • TrackTimedActionUpdate
    传入数据以更新与给定操作关联的上下文数据。 传入的数据将附加到给定操作的现有数据中,并覆盖数据(如果已为操作定义相同的密钥)。
    这个调用不发送点击。
    • 以下是此方法的语法:
      public static void TrackTimedActionUpdate(string action, NSDictionary cdata); 
      
      
    • 以下是此方法的代码示例:
      NSDictionary updatedData = NSDictionary.FromObjectAndKey (NSObject.FromObject("val2"), NSObject.FromObject ("key2")); 
        ADBMobile.TrackTimedActionUpdate("level2", updatedData); 
      
      
  • TrackTimedActionEnd
    结束定时操作。
    • 以下是此方法的语法:
      public static void TrackTimedActionEnd(string action, Func<double, double, NSMutableDictionary, sbyte> block); 
      
      
    • 以下是此方法的代码示例:
      ADBMobile.TrackTimedActionEnd  ("level2", (double  arg1,  double  arg2,  NSMutableDictionary  arg3)  =>  { 
      return  Convert.ToSByte(true); 
      });
      
      
  • TrackingTimedActionExists
    返回定时操作是否正在进行。
    • 以下是此方法的语法:
      public static bool TrackingTimedActionExists(string action); 
      
      
    • 以下是此方法的代码示例:
      ADBMobile.TrackTimedActionEnd  ("timedAction",  (double  inAppDuration, 
      double  totalDuration,  NSMutableDictionary  data)  =>  { 
                   return  true; 
      });
      
      
  • 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 methods

  • GetMarketingCloudID
    从 ID 服务中检索 Experience Cloud ID。
    • 以下是此方法的语法:
      public static string GetMarketingCloudID(); 
      
      
    • 以下是此方法的代码示例:
      var mcid = ADBMobile.GetMarketingCloudID();
      
      
  • VisitorSyncIdentifiers
    使用Experience CloudID,您可以设置其他客户ID以与每个访客关联。 访客API接受同一访客的多个客户ID以及客户类型标识符,以分隔不同客户ID的范围。 此方法对应于 JavaScript 库中的 setCustomerIDs。
    • 以下是此方法的语法:
      public static void VisitorSyncIdentifiers(NSDictionary identifiers);
      
      
    • 以下是此方法的代码示例:
      NSDictionary  ids  =  NSDictionary.FromObjectAndKey  (NSObject.FromObject  ("value2"),  NSObject.FromObject  ("pushID")); 
      ADBMobile.VisitorSyncIdentifiers(ids); 
      
      

Target 方法

  • TargetLoadRequest
    Sends request to your configured Target server and returns the string value of the offer generated in a Action<NSDictionary> callback.
    • 以下是此方法的语法:
      public static void TargetLoadRequest (ADBTargetLocationRequest request, Action<NSString> callback); 
      
      
    • 以下是此方法的代码示例:
      NSDictionary  dict  =  NSDictionary.FromObjectAndKey  (NSObject.FromObject  ("value2"),  NSObject.FromObject  ("key1")); 
      ADBTargetLocationRequest  req  =  ADBMobile.TargetCreateRequest  ("iOSTest",  "defGal",  dict); 
      ADBMobile.TargetLoadRequest(req,    (context)  =>  { 
      Console.WriteLine  (context); 
      });
      
      
  • TargetCreateRequest
    Convenience constructor to create an ADBTargetLocationRequest object with the given parameters.
    • 以下是此方法的语法:
      public static ADBTargetLocationRequest ADBTargetLocationRequest TargetCreateRequest (string name, string defaultContent, NSDictionary parameters); 
      
      
    • 以下是此方法的代码示例:
      NSDictionary  dict  =  NSDictionary.FromObjectAndKey  (NSObject.FromObject  ("value2"),  NSObject.FromObject  ("key1")); 
      ADBTargetLocationRequest  req  =  ADBMobile.TargetCreateRequest  ("iOSTest",  "defGal",  dict); 
      
      
  • TargetCreateOrderConfirmRequest
    创建 ADBTargetLocationRequest
    • 以下是此方法的语法:
      public static ADBTargetLocationRequest ADBTargetLocationRequest TargetCreateRequest (string name, string defaultContent, NSDictionary parameters);
      
      
    • 以下是此方法的代码示例:
      ADBMobile.TargetCreateOrderConfirmRequest ("myOrder", "12345", "29.41", "cool stuff", null); 
      
      
  • TargetClearCookies
    清除应用程序中的任何目标 Cookie。
    • 以下是此方法的语法:
      public static void TargetClearCookies(); 
      
      
    • 以下是此方法的代码示例:
      ADBMobile.TargetClearCookies(); 
      
      

Audience Manager

  • AudienceVisitorProfile
    返回最近获取的访客资料。如果尚未提交任何信号,则返回零。 Visitor profile is saved in NSUserDefaults for easy access across multiple launches of your app.
    • 以下是此方法的语法:
      public static NSDictionary AudienceVisitorProfile (); 
      
      
    • 以下是此方法的代码示例:
      NSDictionary profile = ADBMobile.AudienceVisitorProfile();
      
      
  • AudienceDpid
    返回当前 DPID。
    • 以下是此方法的语法:
      public static string AudienceDpid ();
      
      
    • 以下是此方法的代码示例:
      string currentDpid = ADBMobile.AudienceDpid();
      
      
  • AudienceDpuuid
    返回当前 DPUUID。
    • 以下是此方法的语法:
      public static string AudienceDpuuid ();
      
      
    • 以下是此方法的代码示例:
      string currentDpuuid = ADBMobile.AudienceDpuuid(); 
      
      
  • AudienceSetDpidAndDpuuid
    设置dpid和dpuuid。 如果设置了dpid和dpuuid,则会随每个信号一起发送它们。
    • 以下是此方法的语法:
      public static void AudienceSetDpidAndDpuuid (NSDictionary data, Action<NSDictionary> callback); 
      
      
    • 以下是此方法的代码示例:
      ADBMobile.AudienceSetDpidAndDpuuid ("testDppid", "testDpuuid")
      
      
  • AudienceSignalWithData
    Sends audience management a signal with traits and get the matching segments returned in a Action<NSDictionary> callback.
    • 以下是此方法的语法:
      public static void AudienceSignalWithData (NSDictionary data, Action<NSDictionary> callback); 
      
      
    • 以下是此方法的代码示例:
      NSDictionary  audienceData  =  NSDictionary.FromObjectAndKey  (NSObject.FromObject  ("value2"),  NSObject.FromObject  ("key1")); 
      ADBMobile.AudienceSignalWithData  (audienceData,  (context)  =>  { 
      Console.WriteLine  (context); 
      }); 
      
      
  • AudienceReset
    重置 Audience Manager UUID 并清除当前访客资料。
    • 以下是此方法的语法:
      public static void AudienceReset ();
      
      
    • 以下是此方法的语法:
      ADBMobile.AudienceReset ();
      
      

视频

有关详细信息,请参阅 视频分析
  • MediaCreateSettings
    通过指定的参数返回 ADBMediaSettings 对象。
    • 以下是此方法的语法:
      public static ADBMediaSettings MediaCreateSettings ([string name, double length, string playerName, string playerID); 
      
      
    • 以下是此方法的代码示例:
      ADBMediaSettings settings = ADBMobile.MediaCreateSettings ("name1", 10, "playerName1", "playerID1"); 
      
      
  • MediaAdCreateSettings
    返回用于跟踪广告视频的 ADBMediaSettings 对象。
    • 以下是此方法的语法:
      public static ADBMediaSettings MediaAdCreateSettings ( string name,  double length,  string playerName,  string parentName,  string parentPod,  double parentPodPosition,  string CPM); 
      
      
    • 以下是此方法的代码示例:
      ADBMediaSettings adSettings = ADBMobile.MediaAdCreateSettings("adName1", 2, "playerName1", "name1", "podName1", 4, "CPM1");
      
      
  • MediaOpenWithSettings
    打开 ADBMediaSettings 对象以进行跟踪。
    • 以下是此方法的语法:
      public static void MediaOpenWithSettings ( ADBMediaSettings settings,  Action<ADBMediaState> callback); 
      
      
    • 以下是此方法的代码示例:
      ADBMediaSettings settings = ADBMobile.MediaCreateSettings  ("name1",  10,  "playerName1",  "playerID1"); 
      ADBMobile.MediaOpenWithSettings  (settings,  (state)  =>  { 
      Console.WriteLine  (state.Name); 
      }); 
      
      
  • MediaClose
    关闭名为“name”的媒体项目。
    • 以下是此方法的语法:
      public static void MediaClose ( string name);
      
      
    • 以下是此方法的代码示例:
      ADBMobile.MediaClose  (settings.Name);
      
      
  • MediaPlay
    在给定的“offset”时间(以秒为单位)播放名为“name”的媒体项目。
    • 以下是此方法的语法:
      public static void MediaPlay ( string name, double offset);
      
      
    • 以下是此方法的代码示例:
      ADBMobile.MediaPlay (settings.Name, 0); 
      
      
  • MediaComplete
    在提供的“offset”时间(以秒为单位)将媒体项目手动标记为完成。
    • 以下是此方法的语法:
      public static void MediaComplete ( string name, double offset);
      
      
    • 以下是此方法的代码示例:
      ADBMobile.MediaComplete (settings.Name, 5);
      
      
  • MediaStop
    通知媒体模块已在给定的“offset”时间停止或暂停视频。
    • 以下是此方法的语法:
      public static void MediaStop ( string name, double offset);
      
      
    • 以下是此方法的代码示例:
      ADBMobile.MediaStop (settings.Name, 3);
      
      
  • MediaClick
    通知媒体模块已单击媒体项目。
    • 以下是此方法的语法:
      public static void MediaClick ( string name, double offset); 
      
      
  • MediaTrack
    发送用于获取当前媒体状态的跟踪操作调用(无页面查看)。
    • 以下是此方法的语法:
      public static void MediaTrack ( string name, NSDictionary data); 
      
      
    • 以下是此方法的代码示例:
       ADBMobile.MediaTrack (settings.Name, null);