Tracking in SceneGraph (Roku)

Einführung

Roku hat ein neues Programmier-Framework für die Entwicklung von Anwendungen herausgebracht: das SceneGraph XML-Programmier-Framework. Dieses neue Framework umfasst zwei neue Schlüsselkonzepte:

• SceneGraph-Rendering der Anwendungsszenen
• XML-Konfiguration der SceneGraph-Screens

Das Adobe Mobile SDK for Roku wurde in BrightScript geschrieben. Das SDK verwendet viele Komponenten, die nicht für eine App verfügbar sind, die auf SceneGraph ausgeführt wird (z. B. Threads). Daher kann ein Roku-App-Entwickler, der das SceneGraph-Framework verwenden möchte, Adobe Mobile SDK-APIs nicht aufrufen (letztere sind ähnlich wie die in älteren BrightScript-Apps verfügbaren APIs).

Architektur

Damit das AdobeMobile-SDK SceneGraph unterstützt, hat Adobe eine neue API hinzugefügt, die eine Connector-Verbindung zwischen dem AdobeMobile-SDK und adbmobileTask herstellt. Letzterer ist ein SceneGraph-Knoten, der für die API-Ausführung des SDK verwendet wird. (Die Verwendung von adbmobileTask wird im Rest dieses Dokuments ausführlich erklärt.)

Die Connector-Verbindung ist wie folgt ausgelegt:

• Die Verbindung gibt eine SceneGraph-kompatible Instanz des AdobeMobile SDK zurück. Das SceneGraph-kompatible SDK verfügt über alle APIs, die vom alten SDK bereitgestellt werden.
• Sie verwenden die AdobeMobile SDK-APIs in SceneGraph ähnlich wie die alten APIs.
• Die Verbindung stellt auch einen Mechanismus zum Abhören von Callbacks für APIs, die Daten zurückgeben, bereit.

Komponenten

SceneGraph-Anwendung:

• Nutzt AdobeMobileLibrary-APIs über die APIs der SceneGraph-Connector-Verbindung.
• Überwacht Antwort-Callbacks in adbmobileTask auf unerwartete Ausgabedatenvariablen.

AdobeMobileLibrary:

• Stellt eine Reihe öffentlicher APIs (Legacy) bereit, einschließlich der Connector Bridge-API.
• Gibt eine SceneGraph-Connector-Instanz zurück, die alle älteren öffentlichen APIs einpackt.
• Kommuniziert mit einem SceneGraph-adbmobileTask-Knoten für die Ausführung der APIs.

adbmobileTask-Knoten:

• Ein SceneGraph-Aufgabenknoten, der AdobeMobileLibrary-APIs im Hintergrund-Thread ausführt.
• Dient als Delegate, der Daten an die Anwendungsszenen zurückgeben kann.

Öffentliche SceneGraph-APIs

ADBMobileConnector

SceneGraphConstants

adbmobileTask-Knoten

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-Signatur: ADBMobile().getADBMobileConnectorInstance()
Eingabe: adbmobileTask
Rückgabetyp: ADBMobileConnector

sgConstants

API-Signatur: ADBMobile().sgConstants()
Eingabe: Keine
Rückgabetyp: SceneGraphConstants

ADBMobile-Konstanten

Auf global definierte MediaHeartbeat-APIs für Dienstprogramme in der älteren AdobeMobileLibrary kann wie in der SceneGraph-Umgebung zugegriffen werden, da keine in SceneGraph-Knoten nicht verfügbaren Brightscript-Komponenten verwendet werden. Weitere Informationen zu diesen Methoden finden Sie in der unten stehenden Tabelle:

Globale Methoden für MediaHeartbeat

Implementierung

1. Roku-Bibliothek herunterladen - Laden Sie die aktuelle Roku-Bibliothek herunter.

2. Entwicklungsumgebung einrichten

   1. Kopieren Sie adbmobile.brs (AdobeMobileLibrary) in das Verzeichnis pkg:/source/.

   2. Kopieren Sie für die SceneGraph-Unterstützung adbmobileTask.brs und adbMobileTask.xml in das Verzeichnis pkg:/components/.

3. Initialisieren

   1. Importieren Sie adbmobile.brs in Ihre Szene.

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

   2. Erstellen Sie eine Instanz des adbmobileTask-Knotens in Ihrer Szene.

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

   3. Rufen Sie mit adbmobile eine Instanz des adbmobileTask-Connectors für SceneGraph ab.

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

   4. Rufen Sie die adbmobile-SceneGraph-Konstanten ab.

      m.adbmobileConstants = m.adbmobile.sceneGraphConstants()
      

   5. Registrieren Sie einen Callback, der das Antwortobjekt für alle AdbMobile-API-Aufrufe empfängt.

      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 
      

Beispielimplementierung

API-Beispielaufrufe im Legacy-SDK

'get an instance of SDK 
m.adbmobile = ADBMobile() 
   
'execute setter APIs 
m.adbmobile.setDebugLogging(true) 
   
'execute getter APIs 
debugLogging = m.adbmobile.getDebugLogging()

API-Beispielaufrufe im SceneGraph-SDK

'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