Dokumentation Analytics Direktuppspelning av Media Collection Guide

Konfigurera Mobile SDK v2.x för Roku set-up-roku

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Ämnen:

Skapat för:

Användare
Administratör
Utvecklare

Förutsättningar roku-prerequisites

Hämta giltiga konfigurationsparametrar för tilläggsprogrammet för den direktuppspelade mediesamlingen

Dessa parametrar kan hämtas från en Adobe-representant när du har konfigurerat Adobe-direktuppspelningstillägget för Media Collection.
Ta med följande API:er i mediespelaren
- Ett API för att prenumerera på spelarhändelser - Media SDK kräver att du anropar en uppsättning enkla API:er när händelser inträffar i spelaren.
- Ett API som tillhandahåller spelarinformation - Den här informationen innehåller information som medienamnet och spelhuvudets position.

Med Roku SDK 2.x för Experience Cloud Solutions kan du mäta Roku-applikationer skrivna i BrightScript, utnyttja och samla in målgruppsdata via målgruppshantering och mäta videoengagemang via videohändelser.

Implementering av mobilbibliotek/SDK

Lägg till ditt hämtade Roku-bibliotek i ditt projekt.

Den hämtade filen AdobeMobileLibrary-2.*-Roku.zip består av följande programvarukomponenter:
- adbmobile.brs: Den här biblioteksfilen inkluderas i Roku-appens källmapp.
- ADBMobileConfig.json: Den här SDK-konfigurationsfilen är anpassad för ditt program.

Lägg till biblioteksfilen och JSON-konfigurationsfilen i projektkällan.

JSON som används för att konfigurera Adobe Mobile har en exklusiv nyckel för medieanalys som kallas mediaHeartbeat. Det är här som konfigurationsparametrarna för medieanalys hör hemma.

note tip
TIP
Paketet innehåller ett exempel på JSON-filen `ADBMobileConfig`. Kontakta Adobe för att få hjälp med inställningarna.

Exempel:

code language-none

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" } }

{
  "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
Konfigurationsparameter	Beskrivning
`server`	Sträng som representerar URL:en för spårningsslutpunkten på backend-objektet.
`publisher`	En sträng som representerar den unika identifieraren för innehållsutgivaren.
`channel`	En sträng som representerar namnet på innehållsdistributionskanalen.
`ssl`	Boolean som representerar om SSL ska användas för att spåra anrop.
`ovp`	Sträng som representerar namnet på videospelarleverantören.
`sdkversion`	Sträng som representerar den aktuella versionen av programmet/SDK.
`playerName`	Sträng som representerar spelarens namn.

note important
IMPORTANT
Om `mediaHeartbeat` är felaktigt konfigurerad försätts mediemodulen (VHL) i ett feltillstånd och skickar inte längre spårningsanrop.

Konfigurera Experience Cloud Visitor-ID.

Experience Cloud Visitor ID-tjänsten tillhandahåller ett universellt besökar-ID för olika Experience Cloud-lösningar. Tjänsten för besökar-ID krävs av videohändelser och andra Marketing Cloud-integreringar.

Kontrollera att din ADBMobileConfig-konfiguration innehåller ditt organisations-ID för marketingCloud.

code language-none
`"marketingCloud": { "org": "YOUR-MCORG-ID" }`

Experience Cloud organisations-ID:n identifierar unikt varje klientföretag i Adobe Marketing Cloud och ser ut ungefär som följande värde: 016D5C175213CCA80A490D05@AdobeOrg.

note important
IMPORTANT
Se till att du inkluderar `@AdobeOrg`.

När konfigurationen är klar skapas ett Experience Cloud Visitor-ID som ingår i alla träffar. Andra besökar-ID:n, som custom och automatically-generated, fortsätter att skickas med varje träff.

Tjänstmetoder för Experience Cloud Visitor ID

note tip
TIP
Experience Cloud Visitor-ID-metoder har prefixet `visitor`.

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Metod	Beskrivning
`visitorMarketingCloudID`	Hämtar besökar-ID:t för Experience Cloud från besökar-ID-tjänsten. `ADBMobile().visitorMarketingCloudID()`
`visitorSyncIdentifiers`	Med besökar-ID:t för Experience Cloud kan du ange ytterligare kund-ID:n som kan kopplas till varje besökare. Besökar-API:t godkänner flera kund-ID:n för samma besökare och en kundtypsidentifierare för att skilja omfattningen för olika kund-ID:n åt. Den här metoden motsvarar `setCustomerIDs`. Till exempel: `identifiers={}` `identifiers["idType"]="idValue"` `ADBMobile().visitorSyncIdentifiers(identifiers)`
`setAdvertisingIdentifier`	Används för att ange Roku-ID för Advertising (RIDA) på SDK:n. Till exempel: `ADBMobile().setAdvertisingIdentifier(` `"<sample_roku_identifier_for_advertising>")` Hämta Roku-ID:t för Advertising (RIDA) med Roku SDK-API:t getRIDA().
`getAllIdentifiers`	Returnerar en lista med alla identifierare som lagras av SDK, inklusive Analytics, Visitor, Audience Manager och anpassade identifierare. `identifiers = ADBMobile().getAllIdentifiers()`

Fler publika API:er

DebugLogging

table 0-row-2 1-row-2 2-row-2
Metod	Beskrivning
`setDebugLogging`	Används för att aktivera eller inaktivera felsökningsloggning för SDK. `ADBMobile().setDebugLogging(true)`
`getDebugLogging`	Returnerar true om felsökningsloggning är aktiverad. `isDebugLoggingEnabled = ADBMobile().getDebugLogging()`

PrivacyStatus

table 0-row-2 1-row-2 2-row-2
Konstant	Beskrivning
`PRIVACY_STATUS_OPT_IN`	En konstant som ska skickas när setPrivacyStatus anropas för att anmäla sig. `optInString = ADBMobile().PRIVACY_STATUS_OPT_IN`
`PRIVACY_STATUS_OPT_OUT`	En konstant som ska skickas när setPrivacyStatus anropas för avanmälan. `optOutString = ADBMobile().PRIVACY_STATUS_OPT_OUT`

table 0-row-2 1-row-2 2-row-2
Metod	Beskrivning
`setPrivacyStatus`	Anger sekretessstatus för SDK. `ADBMobile().setPrivacyStatus(ADBMobile().PRIVACY_STATUS_OPT_IN)`
`getPrivacyStatus`	Hämtar den aktuella sekretessstatusen som angetts för SDK. `privacyStatus = ADBMobile().getPrivacyStatus()`

note important
IMPORTANT
Se till att du anropar funktionen `processMessages` och `processMediaMessages` i huvudhändelseslingan var 250:e ms för att vara säker på att SDK skickar ut pingarna korrekt.

table 0-row-2 1-row-2 2-row-2
Metod	Beskrivning
`processMessages`	Ansvarig för att skicka Analytics-händelser till SDK som ska hanteras. `ADBMobile().processMessages()`
`processMediaMessages`	Ansvarig för att skicka mediahändelser till den SDK som ska hanteras. `ADBMobile().processMediaMessages()`

recommendation-more-help

c8eee520-cef5-4f8c-a38a-d4952cfae4eb