TVJS 方法

以下是 tvOS 库提供的 TVJS 方法列表。

配置方法

  • version

    返回 Adobe Mobile 库的当前版本。

    • 以下是此方法的语法:

      version()
      
    • 以下是此方法的代码示例:

      var sdkVersion = ADBMobile.version();
      
    • 返回:String

  • privacyStatus

    返回当前用户隐私状态枚举的 NSUInteger 表示形式。

    以下是选项:

    • ADBMobilePrivacyStatusOptIn:立即发送点击。

    • ADBMobilePrivacyStatusOptOut:丢弃点击。

    • ADBMobilePrivacyStatusUnknown:如果启用了离线跟踪,将会保存点击,直到隐私状态更改为选择启用(发送点击)或选择禁用(丢弃点击)。

      如果未启用离线跟踪,则将丢弃点击,直到隐私状态更改为选择启用。默认值在 ADBMobileConfig.json 文件中设置。

    • 以下是此方法的语法:

      privacyStatus()
      
    • 以下是此方法的代码示例:

      var privacyStatus = ADBMobile.privacyStatus();
      
    • 返回:Number

  • setPrivacyStatus

    将当前用户的隐私状态设置为以下值之一:

    • ADBMobilePrivacyStatusOptIn:立即发送点击。
    • ADBMobilePrivacyStatusOptOut:丢弃点击。
    • ADBMobilePrivacyStatusUnknown:如果启用了离线跟踪,将会保存点击,直到隐私状态更改为选择启用(发送点击)或选择禁用(丢弃点击)。

    如果未启用离线跟踪,则将丢弃点击,直到隐私状态更改为选择启用。

    • 以下是此方法的语法:

      setPrivacyStatus(privacyStatus)
      
    • 以下是此方法的代码示例:

      ADBMobile.setPrivacyStatus(ADBMobilePrivacyStatusOptIn);
      
  • lifetimeValue

    返回当前用户的生命周期值。默认值为 0

    • 以下是此方法的语法:

      lifetimeValue()
      
    • 以下是此方法的代码示例:

      var ltv = ADBMobile.lifetimeValue();
      
    • 返回:Number

  • userIdentifier

    如果设置了自定义标识符,则返回用户标识符。如果未设置自定义标识符,则返回 nil。默认值为 nil

    重要

    如果您的应用程序从 Experience Cloud 3.x SDK 升级到 4.x SDK,则会检索之前的自定义访客 ID 或自动生成的访客 ID,并将其存储为自定义用户标识符。这样可在 SDK 升级期间保留访客数据。对于 4.x SDK 上的新安装,用户标识符在设置之前为 nil。

    • 以下是此方法的语法:

      userIdentifier()
      
    • 以下是此方法的代码示例:

      var uid = ADBMobile.userIdentifier();
      
    • 返回:String

  • setUserIdentifier

    设置用户标识符。

    • 以下是此方法的语法:

      setUserIdentifier(userId)
      
    • 以下是此方法的代码示例:

      ADBMobile.setUserIdentifier(‘myUserId’);
      
    • 返回:不适用

    • 参数:userID

      • 类型:字符串
      • 此用户的新标识符。
  • setAdvertisingIdentifier

    在 SDK 中设置 IDFA,如果已在 SDK 中设置 IDFA,则将在生命周期中发送 IDFA。此外,也可以在信号(回发)中访问 IDFA。

    重要

    仅当使用广告服务时,才应从 Apple API 检索 IDFA。如果您检索 IDFA 但并未正确使用它,则您的应用程序可能会被拒绝。

    • 以下是此方法的语法:

      setAdvertisingIdentifier(idfa)
      
    • 以下是此方法的代码示例:

      ADBMobile.setAdvertisingIdentifier(‘myIdfa’);
      
    • 返回:不适用

    • 参数:idfa

      • 类型:String
      • 从 Apple API 检索 IDFA。
  • setDebugLogging

    设置调试日志记录首选项。

    • 以下是此方法的语法:

      setDebugLogging(logging)
      
    • 以下是此方法的代码示例:

      `ADBMobile.setDebugLogging(true);
      
    • 返回:不适用

    • 参数:logging

      • 类型:Bool
      • 指示 Adobe SDK 是否应登录到调试控制台的值。

Analytics 方法

  • trackStateData

    通过可选的上下文数据跟踪应用程序状态。状态是指您的应用程序中提供的各种视图,例如主页功能板、应用程序设置、购物车等。这些状态与网站中的页面类似,而且 trackState 调用会使页面查看次数递增。

    如果状态为空,它会在报表中显示为“应用程序名称 应用程序版本 (内部版本)”。如果您在报表中看到此值,请确保在每个 trackState 调用中设置状态。

    小贴士

    只有此跟踪调用会递增页面查看次数。

    • 以下是此方法的语法:

      trackStateData(stateName [, contextData])
      
      • 返回:不适用
      • 参数:stateName
        • 类型:String
        • 页面状态名称
      • 参数:contextData
        • 类型:对象
        • 这个点击的其他上下文数据。
    • 以下是此方法的代码示例:

      ADBMobile.trackStateData(‘homepage’, {‘userid’:12345});
      
  • trackActionData

    跟踪您的应用程序中的操作。操作是指您的应用程序中发生的要测量的事件,例如登录、横幅点按、信息源订阅及其他量度。

    • 以下是此方法的语法:

      trackActionData(actionName [, contextData])
      
      • 返回:不适用
      • 参数:actionName
        • 类型:字符串
        • 要跟踪的操作的名称。
      • 参数:contextData
        • 类型:对象
        • 这个点击的其他上下文数据。
    • 以下是此方法的代码示例:

      ADBMobile.trackActionData(‘likeClicked’, {‘imageName’:’funnyKitty’});
      
  • trackLocationWithLatLonData

    发送当前纬度和经度坐标。

    此方法还使用 ADBMobileConfig.json 文件中定义的目标点 (POI) 来确定作为参数输入的位置是否位于您的任何 POI 内。如果当前坐标位于定义的 POI 内,则会填充上下文数据变量,并随 trackLocation 调用发送该变量。

    • 以下是此方法的语法:

      trackLocationWithLatLonData(lat, lon [, contextData]);
      
      • 返回:不适用
      • 参数:lat
        • 类型:数值
        • 位置的纬度。
      • 参数:lon
        • 类型:数值
        • 位置的经度。
      • 参数:contextData
        • 类型:对象
        • 这个点击的其他上下文数据。
    • 以下是此方法的代码示例:

      ADBMobile.trackLocationWithLatLonData(43.36, -116.12, null);
      
  • trackLifetimeValueIncreaseJsData

    向用户的生命周期值中添加数量。

    • 以下是此方法的语法:

      trackLifetimeValueIncreaseJsData(increaseAmount)
      
      • 返回:不适用
      • 参数:increaseAmount
        • 类型:数值
        • 添加到用户当前生命周期值中的数量。
    • 以下是此方法的代码示例:

      ADBMobile.trackLifetimeValueIncreaseJsData(5);
      
  • trackTimedActionStartData

    开始具有指定操作名称的定时操作。如果对已启动的操作调用此方法,则将覆盖上一个定时操作。

    小贴士

    这个调用不发送点击。

    • 以下是此方法的语法:

      trackTimedActionStartData(name [, contextData])
      
      • 返回:不适用
      • 参数:name
        • 类型:字符串
        • 将要启动的定时操作的名称。
      • 参数:contextData
        • 类型:对象
        • 这个点击的其他上下文数据。
    • 以下是此方法的代码示例:

      ADBMobile.trackTimedActionStartData(‘level1’, {‘userId’:42423});
      
  • trackTimedActionUpdateData

    传入数据,以更新与给定操作关联的上下文数据。

    传入的数据将附加到给定操作的现有数据中,如果已经为该操作定义了相同的键,则会覆盖此数据。

    小贴士

    这个调用不发送点击。

    • 以下是此方法的语法:

      trackTimedActionUpdateData(name [, contextData])
      
      • 返回:不适用
      • 参数:name
        • 类型:字符串
        • 要更新的定时操作的名称。
      • 参数:contextData
        • 类型:对象
        • 这个点击的其他上下文数据。
    • 以下是此方法的代码示例:

      ADBMobile.trackTimedActionUpdateData(‘level1’);
      
  • trackTimedActionEndJsLogic

    结束定时操作。

    如果提供回调函数,则可以访问最终的时间值。如果未提供回调,或者如果该回调返回 true,Adobe SDK 则会自动发送一个点击。当从回调返回 false 时,将禁止定时操作点击。

    • 以下是此方法的语法:

      trackTimedActionEndJsLogic(name [, callback])
      
      • 返回:不适用

      • 参数:name

        • 类型:字符串
        • 要结束的定时操作的名称
      • 参数:callback

        • 类型:function(inAppDuration, totalDuration, data)

        • 参数中具有 inAppDuration(数值)、totalDuration(数值)和 data(上下文数据对象)的回调方法。

          您可以通过在回调函数中返回 false 来禁止 SDK 发送的最终点击。

      • 以下是此方法的代码示例:

        ADBMobile.trackTimedActionEndJsLogic(‘level1’, 
        function(inAppDuration, totalDuration, data) {
            // do something with final values
            return true;
            });
        
  • trackingTimedActionExistsJs

    返回定时操作是否正在进行中。

    • 以下是此方法的语法:

      trackingTimedActionExistsJs(name)
      
      • 返回:布尔
      • 参数:name
        • 类型:String
        • 需要检查其是否存在的定时操作的名称。
    • 以下是此方法的代码示例:

      var actionExists = ADBMobile.trackTimedActionExistsJs(‘level1’);
      
  • trackingIdentifier

    返回自动生成的访客标识符。

    这是由 Adobe 服务器生成的特定于应用程序的唯一访客 ID。如果生成期间无法访问 Adobe 服务器,则使用 Apple 的 CFUUID 来生成访客 ID。这个值是在初始启动时生成的,并从那时起被保存和使用。这个 ID 在应用程序升级期间仍会保留,在标准应用程序备份过程中保存并恢复,并在应用程序卸载后删除。

    小贴士

    如果您的应用程序从 Experience Cloud 3.x SDK 升级到 4.x SDK,则会检索之前的自定义访客 ID 或自动生成的访客 ID,并将其存储为自定义用户标识符。这样可在 SDK 升级期间保留访客数据。对于 4.x SDK 上的新安装,用户标识符为 nil,并且将使用跟踪标识符。有关更多信息,请参阅下面的 userIdentifier 行。

    • 以下是此方法的语法:

      trackingIdentifier()
      
      • 返回:String
      • 参数:无
    • 以下是此方法的代码示例:

      var trackingId = ADBMobile.trackingIdentifier();
      
  • trackingSendQueuedHits

    强制库发送离线队列中的所有点击,而不考虑当前排队的点击量。

    • 以下是此方法的语法:

      trackingSendQueuedHits()
      
      • 返回:不适用
      • 参数:无
    • 以下是此方法的代码示例:

      ADBMobile.trackingSendQueuedHits();
      
  • trackingClearQueue

    清除离线队列中的所有点击。

    • 以下是此方法的语法:

      trackingClearQueue()
      
      • 返回:不适用
      • 参数:无
    • 以下是此方法的代码示例:

      ADBMobile.trackingClearQueue();
      
  • trackingGetQueueSize

    检索离线队列中的当前点击量。

    • 以下是此方法的语法:

      trackingGetQueueSize()
      
      • 返回:数值
      • 参数:无
    • 以下是此方法的代码示例:

      var queueSize = ADBMobile.trackingGetQueueSize();
      

Audience Manager 方法

  • audienceVisitorProfile

    返回最近获取的访客资料。

    如果尚未提交任何信号,则返回 null。访客资料保存在 NSUserDefaults 中,以供在多次启动应用程序时轻松访问。

    • 以下是此方法的语法:

      audienceVisitorProfile()
      
      • 返回:对象
      • 参数:无
    • 以下是此方法的代码示例:

      var profile = ADBMobile.audienceVisitorProfile();
      
  • audienceDpid

    返回当前 DPID。

    • 以下是此方法的语法:

      audienceDpid()
      
      • 返回:字符串
      • 参数:无
    • 以下是此方法的代码示例:

      var dpid = ADBMobile.audienceDpid();
      
  • audienceDpuuid

    返回当前 DPUUID。

    • 以下是此方法的语法:

      audienceDpuuid()
      
      • 返回:String
      • 参数:无
    • 以下是此方法的代码示例:

      var dpuuid = ADBMobile.audienceDpuuid();
      
  • audienceSetDpidDpuuid

    设置 dpid 和 dpuuid,设置后,它们将随每个信号一起发送。

    • 以下是此方法的语法:

      audienceSetDpidDpuuid(dpid, dpuuid)
      
      • 返回:不适用
      • 参数:dpid
        • 类型:String
        • Audience Manager 数据提供程序 ID。
      • 参数:dpuuid
        • 类型:String
        • 用户和数据提供程序组合的标识符。
    • 以下是此方法的代码示例:

      ADBMobile.audienceSetDpidDpuuid(‘myDpid’, ‘userDpuuid’);
      
  • audienceSignalWithDataJsCallback

    向 Audience Manager 发送一个具有特征的信号,并获取回调函数中返回的匹配区段。

    • 以下是此方法的语法:

      audienceSignalWithDataJsCallback(traits [, callback])
      
      • 参数:traits
        • 类型:对象
        • 此用户的特征词典。
      • 参数:callback
        • 类型:函数(用户资料)
        • 在回调函数的参数中,从 Audience Manager 返回的用户资料。
    • 以下是此方法的代码示例:

      ADBMobile.audienceSignalWithDataJsCallback({‘trait’:’something’}, 
      function(profile) {
          //do something with the user’s segments found in profile
           });
      
  • audienceReset

    重置 Audience Manager UUID 并清除当前访客资料。

    • 以下是此方法的代码示例:

      audienceReset()
      
      • 返回:不适用
      • 参数:无
    • 以下是此方法的代码示例:

      ADBMobile.audienceReset();
      

ID 服务方法

  • visitorMarketingCloudID

    从 ID 服务中检索 Experience Cloud ID。

    • 以下是此方法的语法:

      visitorMarketingCloudID()
      
      • 返回:字符串
      • 参数:无
    • 以下是此方法的代码示例:

      var mcid = ADBMobile.visitorMarketingCloudID();
      
  • visitorSyncIdentifiers

    除了 Experience Cloud ID 之外,您还可以设置要与每个访客关联的其他客户 ID。访客 API 接受同一访客具有多个客户 ID,并且使用客户类型标识符区分不同客户 ID 的适用范围。此方法对应于 JavaScript 库中的 setCustomerIDs。

    • 以下是此方法的语法:

      visitorSyncIdentifiers(identifiers)
      
      • 返回:不适用

      • 参数:identifiers

        • 类型:Object
        • 用于同步到此用户的 ID 服务的标识符。
    • 以下是此方法的代码示例:

      ADBMobile.visitorSyncIdentifiers({‘idType’:’idValue’});
      
  • visitorSyncIdentifiersAuthenticationState

    将提供的标识符同步到 ID 服务。

    • 以下是此方法的语法:

      visitorSyncIdentifiersAuthenticationState(identifiers, authState)
      
      • 返回:不适用
      • 参数:identifiers
        • 类型:Object
        • 用于同步到此用户的 ID 服务的标识符。
      • 参数:authState
        • 类型:ADBMobileVisitorAuthenticationState
        • 用户的身份验证状态,可能的值包括:
          • ADBMobileVisitorAuthenticationStateUnknown
          • ADBMobileVisitorAuthenticationStateAuthenticated
          • ADBMobileVisitorAuthenticationStateLoggedOut
    • 以下是此方法的代码示例:

      ADBMobile.visitorSyncIdentifiersAuthenticationState({'myIdType':'valueForUser'}, ADBMobileVisitorAuthenticationStateLoggedOut)
      
  • visitorSyncIdentifierWithTypeIdentifierAuthenticationState

    将提供的标识符类型和值同步到 ID 服务。

    • 以下是此方法的语法:

      visitorSyncIdentifierWithTypeIdentifierAuthenticationState(idType, identifier, authState)
      
      • 返回:不适用
      • 参数:idType
        • 类型:String
        • 正在同步的标识符类型。
      • 参数:identifier
        • 类型:String
        • 正在同步的标识符值。
      • 参数:authState
        • 类型:ADBMobileVisitorAuthenticationState
          用户的身份验证状态。可能的值包括:
          • ADBMobileVisitorAuthenticationStateUnknown
          • ADBMobileVisitorAuthenticationStateAuthenticated
          • ADBMobileVisitorAuthenticationStateLoggedOut
    • 以下是此方法的代码示例:

      ADBMobile.visitorSyncIdentifierWithTypeIdentifierAuthenticationState('myIdType', 'valueForUser', 
      ADBMobileVisitorAuthenticationStateAuthenticated);
      
  • visitorGetIDsJs

    检索只读 ADBVisitorID 对象的数组。以下代码示例是一个 VisitorID 对象示例:

    {
        idType: "abc",
        authenticationState: 1, 
        identifier: "123"
    }
    
    • 以下是此方法的语法:

      visitorGetIDsJs()
      
      • 返回:Array [Object]

      • 参数:无

    • 以下是此方法的代码示例:

      var myVisitorIds = ADBMobile.visitorGetIDsJs();
      

Target 方法

  • targetThirdPartyID

    返回第三方 ID。

    • 以下是此方法的语法:

      targetThirdPartyID()
      
      • 返回:String
      • 参数:无
    • 以下是此方法的代码示例:

      var thirdPartyID = ADBMobile.targetThirdPartyID();
      
  • targetSetThirdPartyID

    设置第三方 ID。

    • 以下是此方法的语法:

      targetSetThirdPartyID(thirdPartyID)
      
      • 返回:不适用
      • 参数:thirdPartyID
        • 类型:String
        • 用于目标请求的第三方 ID。
    • 以下是此方法的代码示例:

    ADBMobile.targetSetThirdPartyID(‘thirdPartyID’);
    
  • targetPcID

    返回 PcID。

    • 以下是此方法的语法:

      targetPcID()
      
      • 返回:String
      • 参数:无
    • 以下是此方法的代码示例:

      var pcID = ADBMobile.targetPcID();
      
  • targetSessionID

    返回会话 ID。

    • 以下是此方法的语法:

      targetSessionID()
      
      • 返回:String
      • 参数:无
    • 以下是此方法的代码示例:

      var sessionID = ADBMobile.targetSessionID();
      

在此页面上