Roku - SceneGraph でのトラッキング

はじめに

Roku SceneGraph XML プログラミングフレームワークを使用して、アプリケーションを開発できます。 このフレームワークの特長は、次の 2 つの重要な概念です。

• アプリケーション画面の SceneGraph レンダリング
• SceneGraph 画面の XML 設定

Adobe Mobile SDK for Roku は BrightScript で記述されています。SDK では、SceneGraph 上で実行されるアプリでは利用できない様々なコンポーネントを使用します（スレッドなど）。したがって、SceneGraph フレームワークの使用を考えている Roku アプリケーション開発者は Adobe Mobile SDK API を呼び出すことができません（後者はレガシー BrightScript アプリで利用可能なものに類似しています）。

アーキテクチャ

SceneGraph サポートを AdobeMobile SDK に追加するために、アドビは AdobeMobile SDK と adbmobileTask の接続ブリッジを作成する新たな API を追加しました。後者は、SDK の API 実行に使用される SceneGraph ノードです（adbmobileTask の使用方法については、このドキュメントの後半で詳しく説明します）。

コネクタブリッジは以下のように設計されています。

• ブリッジは、AdobeMobile SDK の SceneGraph 互換インスタンスを返します。SceneGraph 互換 SDK は、レガシー SDK で提供されているすべての API を備えています。
• SceneGraph での AdobeMobile SDK API の使用方法は、レガシー API の使用方法とほぼ同じです。
• ブリッジには、データを返す API のコールバックをリッスンするメカニズムも用意されています。

コンポーネント

SceneGraph アプリケーション：

• SceneGraph 接続ブリッジ API を介して AdobeMobileLibrary API を利用します。
• 予期される出力データ変数に関して、adbmobileTask で応答コールバックを登録します。

AdobeMobileLibrary：

• コネクタブリッジ API を含む一連の公開 API（レガシー）を提供します。
• 従来の公開 API をすべて含む SceneGraph 接続インスタンスを返します。
• API 実行時には、adbmobileTask の SceneGraph ノードと通信します。

adbmobileTask Node：

• AdobeMobileLibrary API をバックグラウンドスレッドで実行する SceneGraph タスクノードです。
• データをアプリケーションシーンに戻すデリゲートとして機能します。

公開 SceneGraph API

ADBMobileConnector

SceneGraphConstants

adbmobileTask ノード

response = {
  "apiName" : <SceneGraphConstants.
               API_NAME>
  "returnValue : <API_RESPONSE>
}

response = {
  "apiName" : m.
              adbmobileConstants.
              VISITOR_MARKETING_CLOUD_ID
  "returnValue : "07050x25671x33760x72644x14"
}

response = {
  "apiName" : m.
              adbmobileConstants.
              VISITOR_MARKETING_CLOUD_ID
  "returnValue : invalid
}

adbmobile.brs

getADBMobileConnectorInstance

API 署名: ADBMobile().getADBMobileConnectorInstance()
入力：adbmobileTask
戻り値の型：ADBMobileConnector

sgConstants

API 署名：ADBMobile().sgConstants()
入力：なし
戻り値の型：SceneGraphConstants

ADBMobile 定数

レガシー AdobeMobileLibrary のグローバルに定義されたユーティリティ MediaHeartbeat API は、SceneGraph ノードでは使用できない Brightscript のコンポーネントが使用されていないので、SceneGraph 環境でそのままアクセスできます​。​これらのメソッドについて詳しくは、以下の表を参照してください。

MediaHeartbeat のグローバルメソッド

実装

1. Roku ライブラリのダウンロード - 最新の Roku ライブラリをダウンロードします。

2. 開発環境の設定

   1. adbmobile.brs（AdobeMobileLibrary）を pkg:/source/ ディレクトリにコピーします。

   2. SceneGraph をサポートするために、adbmobileTask.brs および adbMobileTask.xml を pkg:/components/ ディレクトリにコピーします。

3. 初期設定

   1. adbmobile.brs を Scene に読み込みます。

      <script type="text/brightscript" uri="pkg:/source/adbmobile.brs" />
      

   2. adbmobileTask ノードのインスタンスを Scene に作成します。

      m.adbmobileTask = createObject("roSGNode", "adbmobileTask")
      

   3. adbmobile インスタンスを使用して、SceneGraph 用 adbmobileTask コネクタを取得します。

      m.adbmobile = ADBMobile().getADBMobileConnectorInstance(m.adbmobileTask)
      

   4. adbmobile SG 定数を取得します。

      m.adbmobileConstants = m.adbmobile.sceneGraphConstants()
      

   5. すべての AdbMobile API 呼び出しの応答オブジェクトを受け取るためのコールバックを登録します。

      m.adbmobileTask.ObserveField(m.adbmobileConstants.API_RESPONSE,
                                   "onAdbmobileApiResponse")
      
      ' Sample implementation of the callback
      ' Listen for all the constants for which API calls are made on the SDK
      function onAdbmobileApiResponse() as void
          responseObject = m.adbmobileTask[m.adbmobileConstants.API_RESPONSE]
      
          if responseObject <> invalid
              methodName = responseObject.apiName
              retVal = responseObject.returnValue
      
              if methodName = m.adbmobileConstants.DEBUG_LOGGING
                  if retVal
                      print "API Response: DEBUG LOGGING: " + "True"
                  else
                      print "API Response: DEBUG LOGGING: " + "False"
                  endif
              else if methodName = m.adbmobileConstants.PRIVACY_STATUS
                  print "API Response: PRIVACY STATUS: " + retVal
              else if methodName = m.adbmobileConstants.TRACKING_IDENTIFIER
                  if retVal <> invalid
                      print "API Response: TRACKING IDENTIFIER: " + retVal
                  else
                      print "API Response: TRACKING IDENTIFIER: " + "invalid"
                  endif
              else if methodName = m.adbmobileConstants.USER_IDENTIFIER
                  if retVal <> invalid
                      print "API Response: USER IDENTIFIER: " + retVal
                  else
                      print "API Response: USER IDENTIFIER: " + "invalid"
                  endif
              else if methodName = m.adbmobileConstants.VISITOR_MARKETING_CLOUD_ID
                  if retVal <> invalid
                      print "API Response: MCID: " + retVal
                  else
                      print "API Response: MCID: " + "invalid"
                  endif
              else if methodName = m.adbmobileConstants.AUDIENCE_DPID
                  if retVal <> invalid
                      print "API Response: AUDIENCE DPID: " + retVal
                  else
                      print "API Response: AUDIENCE DPID: " + "invalid"
                  endif
              else if methodName = m.adbmobileConstants.AUDIENCE_DPUUID
                  if retVal <> invalid
                      print "API Response: AUDIENCE DPUUID: " + retVal
                  else
                      print "API Response: AUDIENCE DPUUID: " + "invalid"
                  endif
              else if methodName = m.adbmobileConstants.AUDIENCE_VISITOR_PROFILE
                  if retVal <> invalid
                      print "API Response: AUDIENCE VISITOR PROFILE: Valid Object"
                  else
                      print "API Response: AUDIENCE VISITOR PROFILE: " + "invalid"
                  endif
              endif
          endif
      end function
      

実装例

レガシー SDK の API 呼び出しの例

'get an instance of SDK
m.adbmobile = ADBMobile()

'execute setter APIs
m.adbmobile.setDebugLogging(true)

'execute getter APIs
debugLogging = m.adbmobile.getDebugLogging()

SG SDK の API 呼び出しの例

'create adbmobileTask instance
m.adbmobileTask = createObject("roSGNode", "adbmobileTask")

'get an instance of SDK using task instance
m.adbmobile =
  ADBMobile().getADBMobileConnectorInstace(m.adbmobileTask)
m.adbmobileConstants = m.adbmobile.sceneGraphConstants()
'execute setter APIs
m.adbmobile.setDebugLogging(true)

'execute getter APIs
m.adbmobileTask.ObserverField(m.adbConstants.API_RESPONSE,
                              "onAdbmobileApiResponse")
m.adbmobile.getDebugLogging()

'listen for return data in registered callbacks
function onAdbmobileApiResponse() as void
    responseObject = m.adbmobileTask[m.adbmobileConstants.API_RESPONSE]

        if responseObject <> invalid
            methodName = responseObject.apiName
            retVal = responseObject.returnValue

        if methodName = m.adbmobileConstants.DEBUG_LOGGING
            if retVal
                print "API Response: DEBUG LOGGING: " + "True"
            else
                print "API Response: DEBUG LOGGING: " + "False"
         endif
    endif
end function

Business.Adobe.com リソース