Configurer le SDK mobile v2.x pour Roku

Conditions préalables

  • Obtenir des paramètres de configuration valides pour Media Analytics

    Vous pouvez obtenir ces paramètres auprès d’un représentant Adobe une fois votre compte Media Analytics configuré.

  • Inclure les API suivantes dans votre lecteur multimédia

    • Une API pour vous abonner aux événements du lecteur - Le SDK Media exige d’appeler un ensemble d’API simples lorsque des événements se produisent dans votre lecteur.
    • Une API qui fournit des informations au lecteur - Ces informations incluent des éléments tels que le nom du média et la position de la tête de lecture.

Le kit SDK Roku 2.x pour les solutions Experience Cloud vous permet de mesurer les applications Roku écrites en BrightScript, d’exploiter et de collecter les données d’audience par le biais de la gestion de l’audience et de mesurer l’engagement vidéo grâce aux événements vidéo.

Mise en œuvre de la bibliothèque/du SDK mobile

  1. Ajoutez la bibliothèque Roku que vous avez téléchargée à votre projet.

    1. Le fichier de téléchargement AdobeMobileLibrary-2.*-Roku.zip est constitué des composants logiciels suivants :

      • adbmobile.brs : Ce fichier de bibliothèque sera inclus dans le dossier source de votre application Roku.

      • ADBMobileConfig.json : Ce fichier de configuration SDK est personnalisé pour votre application.

    2. Ajoutez le fichier de bibliothèque et le fichier de configuration JSON à la source de votre projet.

      Le fichier JSON utilisé pour configurer Adobe Mobile comporte une clé exclusive pour Media Analytics appelée mediaHeartbeat. C’est à cet endroit que se trouvent les paramètres de configuration de Media Analytics.

      CONSEIL

      Un exemple de fichier JSON ADBMobileConfig est fourni avec le module. Contactez vos représentants Adobe au sujet des paramètres.

      Par exemple :

      {
  "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"
   }
}
      Paramètre de configuration Description
      server Chaîne représentant l’URL du point de terminaison de suivi sur le serveur principal.
      publisher Chaîne représentant l’identifiant unique de l’éditeur de contenu.
      channel Chaîne représentant le nom du canal de distribution du contenu.
      ssl Valeur booléenne qui indique si SSL doit être utilisé pour le suivi des appels.
      ovp Chaîne représentant le nom du fournisseur de lecteur vidéo.
      sdkversion Chaîne représentant la version actuelle de l’application/du kit SDK.
      playerName Chaîne représentant le nom du lecteur.
      IMPORTANT

      Si mediaHeartbeat n’est pas correctement configuré, le module multimédia (VHL) entre dans un état d’erreur et arrête l’envoi des appels de suivi.

  2. Configurez l’identifiant visiteur Experience Cloud.

    Le service d’identification des visiteurs Experience Cloud fournit un identifiant visiteur universel pour toutes les solutions Experience Cloud. Le service d’identifiant visiteur est requis par les événements vidéo et les autres intégrations de Marketing Cloud.

    Vérifiez que votre configuration ADBMobileConfig contient votre ID d’organisation marketingCloud.

    "marketingCloud": {
    "org": "YOUR-MCORG-ID"
}

    Les identifiants d’organisation d’Experience Cloud identifient de manière unique chaque entreprise cliente dans Adobe Experience Cloud et ressemblent à ceci : 016D5C175213CCA80A490D05@AdobeOrg.

    IMPORTANT

    Veillez à inclure @AdobeOrg.

    Une fois la configuration terminée, un identifiant visiteur Experience Cloud est généré et inclus sur tous les accès. D’autres identifiants visiteur, tels que custom et automatically-generated, continuent à être envoyés avec chaque accès.

    Méthodes du service d’identifiant visiteur Experience Cloud

    CONSEIL

    Les méthodes d’identification des visiteurs Experience Cloud sont précédées du préfixe visitor.

    Méthode Description
    visitorMarketingCloudID Récupère l’identifiant visiteur Experience Cloud auprès du service d’identification des visiteurs.

    ADBMobile().visitorMarketingCloudID()
    visitorSyncIdentifiers Avec l’identifiant visiteur d’Experience Cloud, vous pouvez définir d’autres identifiants de client qui peuvent être associés à chaque visiteur. L’API visiteur accepte plusieurs identifiants de client pour un même visiteur, ainsi qu’un identifiant de type client, afin de séparer la portée des différents identifiants de client. Cette méthode correspond à setCustomerIDs. Par exemple :

    identifiers={}
    identifiers["idType"]="idValue"
    ADBMobile().visitorSyncIdentifiers(identifiers)
    setAdvertisingIdentifier Utilisé pour définir l’ID de Roku pour la publicité (RIDA) sur le SDK. Par exemple :

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


    Obtenez l’ID Roku pour la publicité (RIDA) à l’aide de l’API getRIDA() du SDK Roku.
    getAllIdentifiers Renvoie une liste de tous les identifiants stockés par le SDK, y compris les identifiants Analytics, Visiteur, Audience Manager et personnalisés.

    identifiers = ADBMobile().getAllIdentifiers()

    API publiques supplémentaires

    DebugLogging

    Méthode Description
    setDebugLogging Utilisé pour activer ou désactiver l’enregistrement de débogage pour le SDK. 

    ADBMobile().setDebugLogging(true)
    getDebugLogging Renvoie true si l’enregistrement de débogage est activé.

    isDebugLoggingEnabled = ADBMobile().getDebugLogging()

    PrivacyStatus

    Constante Description
    PRIVACY_STATUS_OPT_IN Constante à transmettre lors de l’appel de setPrivacyStatus pour l’opt-in.

    optInString = ADBMobile().PRIVACY_STATUS_OPT_IN
    PRIVACY_STATUS_OPT_OUT Constante à transmettre lors de l’appel de setPrivacyStatus pour l’opt-out.

    optOutString = ADBMobile().PRIVACY_STATUS_OPT_OUT
    Méthode Description
    setPrivacyStatus Définit le statut de confidentialité sur le SDK.

    ADBMobile().setPrivacyStatus(ADBMobile().PRIVACY_STATUS_OPT_IN)
    getPrivacyStatus Obtient le statut de confidentialité actuel défini sur le SDK.

    privacyStatus = ADBMobile().getPrivacyStatus()
    IMPORTANT

    Veillez à appeler les fonctions processMessages et processMediaMessages dans la boucle d’événement principale toutes les 250 ms pour vous assurer que le SDK envoie correctement les pings.

    Méthode Description
    processMessages Responsable de la transmission des événements Analytics au SDK à gérer.

    ADBMobile().processMessages()
    processMediaMessages Responsable de la transmission des événements Media au SDK à gérer.

    ADBMobile().processMediaMessages()

Sur cette page