文档Analytics流媒体集合指南

设置适用于 Roku 的 Mobile SDK v2.x set-up-roku

Last update: Wed Jul 31 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 用户
  • 管理员
  • 开发人员

先决条件 roku-prerequisites

  • 获取适用于流媒体收藏集加载项的有效配置参数

    在设置Adobe流媒体收集附加帐户后，这些参数可以从Adobe代表获取。

  • 在媒体播放器中包含以下 API

    • 用于订阅播放器事件的 API – Media SDK 要求在播放器中发生事件时调用一组简单的 API。
    • 提供播放器信息的 API - 此信息包括媒体名称和播放头位置等详细信息。

适用于 Experience Cloud 解决方案的 Roku SDK 2.x 让您能够测量使用 BrightScript 编写的 Roku 应用程序，通过受众管理收集并利用受众数据，以及通过视频事件测量视频参与。

移动设备库/SDK 实施

  1. 将下载的 Roku 库添加到您的项目中。

    1. AdobeMobileLibrary-2.*-Roku.zip 下载文件包含以下软件组件：

      • adbmobile.brs：此库文件将包含在您的 Roku 应用程序源文件夹中。

      • ADBMobileConfig.json：这是为您的应用程序自定义的 SDK 配置文件。

    2. 将库文件和 JSON 配置文件添加到您的项目源。

      用于配置 Adobe Mobile 的 JSON 具有一个用于 Media Analytics 的专有密钥，其名称为 mediaHeartbeat。这是Media Analytics的配置参数所属的位置。

      note tip
      TIP
      此包中提供了一个 ADBMobileConfig JSON 文件示例。有关设置，请与 Adobe 代表联系。

      例如：

      code language-none 
      {
  "version":"1.0",
  "analytics":{
    "rsids":"",
    "server":"",
    "charset":"UTF-8",
    "ssl":true,
    "offlineEnabled":false,
    "lifecycleTimeout":30,
    "batchLimit":50,
    "privacyDefault":"optedin",
    "poi":[ ]
},
"marketingCloud":{
  "org":""
},
"target":{
  "clientCode":"",
  "timeout":5
},
"audienceManager":{
  "server":""
},
"acquisition":{
  "server":"example.com",
  "appid":"sample-app-id"
},

"mediaHeartbeat":{
   "server":"example.com",
   "publisher":"sample-publisher",
   "channel":"sample-channel",
   "ssl":true,
   "ovp":"sample-ovp",
   "sdkVersion":"sample-sdk",
   "playerName":"roku"
   }
}
      table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2
      配置参数 描述
      server 表示后端跟踪端点的 URL 的字符串。
      publisher 表示内容发布者唯一标识符的字符串。
      channel 表示内容分发渠道名称的字符串。
      ssl 布尔值，表示是否应使用 SSL 来跟踪调用。
      ovp 表示视频播放器提供程序名称的字符串。
      sdkversion 表示应用程序/SDK 当前版本的字符串。
      playerName 表示播放器名称的字符串。
      note important
      IMPORTANT
      如果未正确配置 mediaHeartbeat，则媒体模块 (VHL) 会进入错误状态并将停止发送跟踪调用。

  2. 配置 Experience Cloud 访客 ID。

    Experience Cloud 访客 ID 提供了一个跨 Experience Cloud 解决方案的通用访客 ID。视频事件和其他 Marketing Cloud 集成都需要使用访客 ID 服务。

    验证您的 ADBMobileConfig 配置包含 marketingCloud 组织 ID。

    code language-none 
    "marketingCloud": {
    "org": "YOUR-MCORG-ID"
}

    Experience Cloud 组织 ID 唯一标识 Adobe Marketing Cloud 中的每个客户公司，它类似于以下值：016D5C175213CCA80A490D05@AdobeOrg。

    note important
    IMPORTANT
    确保包含 @AdobeOrg。

    配置完成后，将生成一个 Experience Cloud 访客 ID，并将其包含在所有点击中。其他访客 ID（如 custom 和 automatically-generated）将继续随每次点击一起发送。

    Experience Cloud 访客 ID 服务方法

    note tip
    TIP
    Experience Cloud 访客 ID 方法以 visitor 为前缀。
    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
    方法 描述
    visitorMarketingCloudID 从访客 ID 服务中检索 Experience Cloud 访客 ID。

    ADBMobile().visitorMarketingCloudID()
    visitorSyncIdentifiers 使用 Experience Cloud 访客 ID，您可以设置其他可与每个访客关联的客户 ID。访客 API 接受同一访客具有多个客户 ID，并且使用客户类型标识符区分不同客户 ID 的适用范围。此方法对应于 setCustomerIDs。例如：

    identifiers={}
    identifiers["idType"]="idValue"
    ADBMobile().visitorSyncIdentifiers(identifiers)
    setAdvertisingIdentifier 用于在 SDK 上设置 Roku ID for Advertising (RIDA)。例如：

    ADBMobile().setAdvertisingIdentifier(
      "<sample_roku_identifier_for_advertising>")


    使用 Roku SDK getRIDA() API 获取 Roku ID for Advertising (RIDA)。
    getAllIdentifiers 返回由 SDK 存储的所有标识符的列表，包括 Analytics、Visitor、Audience Manager 和自定义标识符。

    identifiers = ADBMobile().getAllIdentifiers()

    其他公共 API

    DebugLogging

    table 0-row-2 1-row-2 2-row-2
    方法 描述
    setDebugLogging 用于启用或禁用 SDK 的调试记录。

    ADBMobile().setDebugLogging(true)
    getDebugLogging 如果启用调试记录，则返回 true。

    isDebugLoggingEnabled = ADBMobile().getDebugLogging()

    PrivacyStatus

    table 0-row-2 1-row-2 2-row-2
    常量 描述
    PRIVACY_STATUS_OPT_IN 在调用 setPrivacyStatus 以选择启用时要传递的常量。

    optInString = ADBMobile().PRIVACY_STATUS_OPT_IN
    PRIVACY_STATUS_OPT_OUT 在调用 setPrivacyStatus 以选择禁用时要传递的常量。

    optOutString = ADBMobile().PRIVACY_STATUS_OPT_OUT
    table 0-row-2 1-row-2 2-row-2
    方法 描述
    setPrivacyStatus 在 SDK 上设置隐私状态。

    ADBMobile().setPrivacyStatus(ADBMobile().PRIVACY_STATUS_OPT_IN)
    getPrivacyStatus 获取 SDK 上设置的当前隐私状态。

    privacyStatus = ADBMobile().getPrivacyStatus()
    note important
    IMPORTANT
    务必每 250 毫秒在主事件循环中调用一次 processMessages 和 processMediaMessages 函数以确保 SDK 正确发送 ping。
    table 0-row-2 1-row-2 2-row-2
    方法 描述
    processMessages 负责将 Analytics 事件传递给 SDK 以进行处理。

    ADBMobile().processMessages()
    processMediaMessages 负责将 Media 事件传递给 SDK 以进行处理。

    ADBMobile().processMediaMessages()
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb