Configurer le SDK mobile v2.x pour Roku set-up-roku
Conditions préalables roku-prerequisites
-
Obtenir des paramètres de configuration valides pour les services de streaming multimédia Adobe
Ces paramètres peuvent être obtenus auprès d’un représentant Adobe une fois que vous avez configuré votre compte pour le module complémentaire de collecte de médias en flux continu Adobe ou le module complémentaire Adobe Analytics for Streaming Media.
-
Incluez 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
-
Ajoutez la bibliothèque Roku que vous avez téléchargée à votre projet.
-
Le fichier de téléchargement
AdobeMobileLibrary-2.*-Roku.zipest 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.
-
-
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.note tip TIP Un exemple de fichier JSON ADBMobileConfigest fourni avec le package. Contactez vos représentants Adobe au sujet des paramètres.Par exemple :
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 Paramètre de configuration Description serverChaîne représentant l’URL du point d’entrée de suivi sur le serveur principal. publisherChaîne représentant l’identifiant unique de l’éditeur de contenu. channelChaîne représentant le nom du canal de distribution du contenu. sslValeur booléenne qui indique si SSL doit être utilisé pour le suivi des appels. ovpChaîne représentant le nom du fournisseur de lecteur vidéo. sdkversionChaîne représentant la version actuelle de l’application/du kit SDK. playerNameChaîne représentant le nom du lecteur. note important IMPORTANT Si mediaHeartbeatn’est pas correctement configuré, le module multimédia (VHL) entre dans un état d’erreur et arrête l’envoi des appels de suivi.
-
-
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
ADBMobileConfigcontient votre ID d’organisationmarketingCloud.code language-none "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.note important 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
custometautomatically-generated, continuent à être envoyés avec chaque accès.Méthodes du service d’identifiant visiteur Experience Cloud
note tip TIP Les méthodes d’identification des visiteurs Experience Cloud sont précédées du préfixe visitor.table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 Méthode Description visitorMarketingCloudIDRécupère l’identifiant visiteur Experience Cloud auprès du service d’identification des visiteurs. ADBMobile().visitorMarketingCloudID()visitorSyncIdentifiersAvec 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)setAdvertisingIdentifierUtilisé 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.getAllIdentifiersRenvoie 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
table 0-row-2 1-row-2 2-row-2 Méthode Description setDebugLoggingUtilisé pour activer ou désactiver l’enregistrement de débogage pour le SDK. ADBMobile().setDebugLogging(true)getDebugLoggingRenvoie true si l’enregistrement de débogage est activé. isDebugLoggingEnabled = ADBMobile().getDebugLogging()PrivacyStatus
table 0-row-2 1-row-2 2-row-2 Constante Description PRIVACY_STATUS_OPT_INConstante à transmettre lors de l’appel de setPrivacyStatus pour l’opt-in. optInString = ADBMobile().PRIVACY_STATUS_OPT_INPRIVACY_STATUS_OPT_OUTConstante à transmettre lors de l’appel de setPrivacyStatus pour l’opt-out. optOutString = ADBMobile().PRIVACY_STATUS_OPT_OUTtable 0-row-2 1-row-2 2-row-2 Méthode Description setPrivacyStatusDéfinit le statut de confidentialité sur le SDK. ADBMobile().setPrivacyStatus(ADBMobile().PRIVACY_STATUS_OPT_IN)getPrivacyStatusObtient le statut de confidentialité actuel défini sur le SDK. privacyStatus = ADBMobile().getPrivacyStatus()note important IMPORTANT Veillez à appeler les fonctions processMessagesetprocessMediaMessagesdans la boucle d’événement principale toutes les 250 ms pour vous assurer que le SDK envoie correctement les pings.table 0-row-2 1-row-2 2-row-2 Méthode Description processMessagesResponsable de la transmission des événements Analytics au SDK à gérer. ADBMobile().processMessages()processMediaMessagesResponsable de la transmission des événements Media au SDK à gérer. ADBMobile().processMediaMessages()