DocumentationAnalyticsGuide de Media Analytics

Roku - Suivi dans SceneGraph tracking-in-scenegraph-roku

Last update: Mon Jan 23 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • User
  • Admin
  • Developer

Introduction introduction

Vous pouvez utiliser le framework de programmation XML SceneGraph de Roku pour développer des applications. Ce framework comprend deux nouveaux concepts clés :

  • Rendu SceneGraph des écrans de l’application
  • Configuration XML des écrans SceneGraph

Le SDK Adobe Mobile pour Roku est écrit dans BrightScript. Le SDK utilise de nombreux composants qui ne sont pas disponibles pour une application s’exécutant sur SceneGraph (par exemple, les threads). Par conséquent, un développeur d’applications Roku ayant l’intention d’utiliser la structure SceneGraph ne peut pas appeler les API SDK Adobe Mobile (ces dernières sont similaires à celles disponibles dans les applications BrightScript héritées).

Architecture architecture

Pour ajouter la prise en charge de SceneGraph au kit SDK AdobeMobile, Adobe a ajouté une nouvelle API qui crée un pont de connecteur entre le kit SDK AdobeMobile et adbmobileTask. Le second est un nœud SceneGraph utilisé pour l’exécution de l’API du kit SDK. (L’utilisation d’adbmobileTask est expliquée en détail dans tout le reste de ce document.)

Le pont de connecteur est conçu pour fonctionner comme suit :

  • Le pont renvoie une instance compatible SceneGraph du SDK AdobeMobile. Le SDK compatible avec SceneGraph possède toutes les API exposées par le SDK hérité.
  • Vous utilisez les API SDK AdobeMobile dans SceneGraph de manière très similaire à la manière dont vous utilisiez les API héritées.
  • Le pont expose également un mécanisme d’écoute des rappels pour les API qui renvoient certaines données.

Composants components

Application SceneGraph :

  • Utilise les AdobeMobileLibrary API via les API de pont de connecteur SceneGraph.
  • Enregistre les rappels de réponse sur adbmobileTask pour les variables de données de sortie attendues.

AdobeMobileLibrary :

  • Expose un ensemble d’API publiques (héritées), y compris l’API du pont de connecteur.
  • Renvoie une instance de connecteur SceneGraph qui encapsule toutes les API publiques héritées.
  • Communique avec un nœud SceneGraph adbmobileTask pour l’exécution des API.

Nœud adbmobileTask :

  • Nœud de tâche SceneGraph qui exécute les AdobeMobileLibrary API sur un thread d’arrière-plan.
  • Agit en tant que délégué pour renvoyer des données aux scènes d’application.

API SceneGraph publiques public-scenegraph-apis

ADBMobileConnector

Catégorie
Nom de la méthode
Description
Constantes
sceneGraphConstants
Renvoie un objet contenant SceneGraphConstants. Reportez-vous au tableau ci-dessus pour plus de détails.
Journalisation de débogage
setDebugLogging
API SceneGraph permettant de définir la journalisation de débogage sur le kit SDK ADBMobile.
getDebugLogging
API SceneGraph permettant d’obtenir la journalisation de débogage du kit SDK ADBMobile.
Pour plus d’informations, reportez-vous à la section Journalisation de débogage du kit SDK hérité.
État de désinscription/confidentialité
setPrivacyStatus
API SceneGraph permettant de définir l’état de confidentialité sur le kit SDK ADBMobile.
getPrivacyStatus
API SceneGraph permettant d’obtenir l’état de confidentialité du kit SDK ADBMobile.
Pour plus d’informations, reportez-vous à la section État de désinscription/confidentialité du kit SDK hérité.
Analytics
trackState
API SceneGraph permettant de suivre l’état sur le kit SDK ADBMobile.
trackAction
API SceneGraph permettant de suivre l’action sur le kit SDK ADBMobile.
trackingIdentifier
API SceneGraph permettant d’obtenir un identifiant de suivi à partir du kit SDK ADBMobile.
userIdentifier
API SceneGraph permettant d’obtenir un identifiant d’utilisateur du kit SDK ADBMobile.
setUserIdentifier
API SceneGraph permettant de définir l’identifiant d’utilisateur sur le kit SDK ADBMobile.
getAllIdentifiers
L’API SceneGraph récupère toutes les identités d’utilisateur connues et conservées par le kit SDK Roku.
Pour plus d’informations, reportez-vous à la section Analytics du kit SDK hérité.
Experience Cloud
visitorSyncIdentifiers
API SceneGraph permettant de synchroniser les identifiants Experience Cloud sur le kit SDK ADBMobile.
visitorMarketingCloudID
API SceneGraph permettant d’obtenir l’Experience Cloud ID de visiteur depuis le kit SDK ADBMobile.
Pour plus d’informations, reportez-vous à la section Experience Cloud du kit SDK hérité.
Audience Manager
audienceSubmitSignal
API SceneGraph permettant d’envoyer un signal de gestion de l’audience avec caractéristique.
audienceVisitorProfile
API SceneGraph permettant d’obtenir un profil de visiteur Audience Manager du kit SDK ADBMobile.
audienceDpid
API SceneGraph permettant d’obtenir un DPID d’audience du kit SDK ADBMobile.
audienceDpuuid
API SceneGraph permettant d’obtenir un DPUUID d’audience du kit SDK ADBMobile.
audienceSetDpidAndDpuuid
API SceneGraph permettant de définir le DPID et le DPUUID d’audience sur le kit SDK ADBMobile.
Pour plus d’informations, reportez-vous à la section Audience Manager du kit SDK hérité.
MediaHeartbeat
mediaTrackLoad
API SceneGraph permettant de charger le contenu vidéo pour le suivi MediaHeartbeat.
mediaTrackStart
API SceneGraph pour commencer la session de suivi vidéo à l’aide de MediaHeartbeat.
mediaTrackUnload
API SceneGraph permettant de décharger le contenu vidéo depuis le suivi MediaHeartbeat.
mediaTrackPlay
API SceneGraph permettant de suivre la lecture de contenu vidéo.
mediaTrackPause
API SceneGraph permettant de suivre la mise en pause de contenu vidéo.
mediaTrackComplete
API SceneGraph permettant de suivre la fin du contenu vidéo.
mediaTrackError
API SceneGraph permettant de suivre les erreurs de lecture.
mediaTrackEvent
API SceneGraph permettant de suivre les événements de lecture pendant le suivi. Par exemple : Publicités, Chapitres.
mediaUpdatePlayhead
API SceneGraph permettant d’envoyer des mises à jour playhead à MediaHeartbeat pendant le suivi vidéo.
mediaUpdateQoS
API SceneGraph permettant d’envoyer des mises à jour QoS à MediaHeartbeat pendant le suivi vidéo.
Pour plus d’informations, reportez-vous à la section MediaHeartbeat du kit SDK hérité.

SceneGraphConstants

Nom de constante
Description
API_RESPONSE
Utilisé pour récupérer l’objet de réponse du champ adbmobileTask du adbmobileApiResponse.
DEBUG_LOGGING
Utilisé comme apiName pour getDebugLogging
PRIVACY_STATUS
Utilisé comme apiName pour getPrivacyStatus
TRACKING_IDENTIFIER
Utilisé comme apiName pour trackingIdentifier
USER_IDENTIFIER
Utilisé comme apiName pour userIdentifier
VISITOR_MARKETING_CLOUD_ID
Utilisé comme apiName pour visitorMarketingCloudID
AUDIENCE_VISITOR_PROFILE
Utilisé comme apiName pour audienceVisitorProfile
AUDIENCE_DPID
Utilisé comme apiName pour audienceDpid
AUDIENCE_DPUUID
Utilisé comme apiName pour audienceDpuuid

Nœud adbmobileTask

Champ
Type
Par défaut
Utilisation
adbmobileApiCall
assocarray
Non valide
Ne modifiez PAS ce champ ou laissez l’application l’utiliser. Ce champ est utilisé par le composant SceneGraphConnector ADBMobile pour acheminer les appels API via les nœuds SceneGraph et pour récupérer les réponses. Par conséquent, cette clé/ce champ est réservé(e) à la compatibilité AdobeMobileSDK pour SceneGraph. Important : Une modification apportée à ce champ peut entraîner un mauvais fonctionnement d’AdobeMobileSDK.
adbmobileApiResponse
assocarray
Non valide

Lecture seule de toutes les API exécutéees sur AdobeMobileSDK renvoie la réponse sur ce champ. Inscrivez-vous à un rappel pour écouter les mises à jour de ce champ afin de recevoir les objets de réponse. Voici le format de l’objet de réponse :

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

Une instance de cet objet de réponse sera envoyée pour tout appel API sur AdobeMobileSDK qui doit renvoyer une valeur conformément au guide de référence d’API. Par exemple, un appel API pour visitorMarketingCloudID() renvoie l’objet de réponse suivant :

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

OU, les données de réponse peuvent également être non valides :

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

adbmobile.brs

getADBMobileConnectorInstance

Signature API : ADBMobile().getADBMobileConnectorInstance()
Entrée : adbmobileTask
Type de retour : ADBMobileConnector

sgConstants

Signature API : ADBMobile().sgConstants()
Entrée : Aucune
Type de retour : SceneGraphConstants

NOTE
Reportez-vous à la référence d’API ADBMobileConnector pour plus d’informations.

Constantes ADBMobile

Fonctionnalité
Nom de constante
Description
Contrôle de version
version
Constante permettant de récupérer les informations de version d’AdobeMobileLibrary
Confidentialité/désinscription
PRIVACY_STATUS_OPT_IN
Constante pour l’état de confidentialité choisi
PRIVACY_STATUS_OPT_OUT
Constante pour l’état de confidentialité refusé
Accéder aux constantes MediaHeartbeat
Consultez les constantes de cette page :

Méthodes Media Heartbeat.
Utilisation de ces constantes avec les API MediaHeartbeat
Métadonnées standard
Reportez-vous aux constantes de cette page :

Paramètres de métadonnées standard.
Utilisez ces constantes pour joindre des métadonnées de type vidéo/publicitaire standard dans des API MediaHeartbeat

Les API MediaHeartbeat d’utilitaire globalement définies sur le composant AdobeMobileLibrary hérité sont accessibles telles quelles dans l’environnement SceneGraph car elles n’utilisent aucun composant Brightscript non disponible dans les nœuds SceneGraph. Pour plus d’informations sur ces méthodes, consultez le tableau ci-dessous :

Méthodes globales pour MediaHeartbeat

Méthode
Description
adb_media_init_mediainfo
Cette méthode renvoie un objet d’informations de média initialisé. Function adb_media_init_mediainfo(name As String, id As String, length As Double, streamType As String) As Object
adb_media_init_adinfo
Cette méthode renvoie un objet d’informations de publicité initialisé. Function adb_media_init_adinfo(name As String, id As String, position As Double, length As Double) As Object
adb_media_init_chapterinfo
Cette méthode renvoie l’objet d’informations de chapitre initialisé. Function adb_media_init_adbreakinfo(name As String, startTime as Double, position as Double) As Object
adb_media_init_adbreakinfo
Cette méthode renvoie l’objet Informations de l’AdBreak initialisé. Function adb_media_init_chapterinfo(name As String, position As Double, length As Double, startTime As Double) As Object
adb_media_init_qosinfo
Cette méthode renvoie un objet d’informations QoS initialisé. Function adb_media_init_qosinfo(bitrate As Double, startupTime as Double, fps as Double, droppedFrames as Double) As Object

Implémentation implementation

  1. Téléchargement de la bibliothèque Roku - Téléchargez la dernière bibliothèque Roku.

  2. Configuration de votre environnement de développement

    1. Copiez adbmobile.brs (AdobeMobileLibrary) dans votre répertoire pkg:/source/.

    2. Pour la prise en charge de SceneGraph, copiez adbmobileTask.brs et adbMobileTask.xml dans votre répertoire pkg:/components/.

  3. Initialisation

    1. Importez adbmobile.brs dans votre scène.

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

    2. Créez une occurrence du nœud adbmobileTask dans votre scène.

      code language-none 
      m.adbmobileTask = createObject("roSGNode", "adbmobileTask")

    3. Obtenez une instance du connecteur adbmobile pour SceneGraph à l’aide de l’occurrence adbmobileTask.

      code language-none 
      m.adbmobile = ADBMobile().getADBMobileConnectorInstance(m.adbmobileTask)

    4. Procurez-vous les constantes SG adbmobile.

      code language-none 
      m.adbmobileConstants = m.adbmobile.sceneGraphConstants()

    5. Enregistrez un rappel pour recevoir l’objet de réponse pour tous les appels de l’API AdbMobile.

      code language-none 
      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

Exemple de mise en œuvre sample-implementation

Exemples d’appels d’API sur le kit SDK hérité

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

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

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

Exemples d’appels d’API sur le kit SDK SG

'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
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb