Configurar SDK móvil v2.x para Roku

Requisitos previos

• Obtener parámetros de configuración válidos para Media Analytics

  Puede solicitar estos parámetros a un representante de Adobe después de configurar su cuenta de análisis de medios.

• Incluya las siguientes API en su reproductor multimedia

  • Una API para suscribirse a eventos del reproductor: Media SDK requiere que llame a un conjunto de API simples cuando se produzcan eventos en el reproductor.
  • Una API que proporciona información del reproductor: Esta información incluye detalles como el nombre del medio y la posición del cabezal de reproducción.

Roku SDK 2.x para Experience Cloud Solutions le permite medir aplicaciones Roku escritas en BrightScript, aprovechar y recopilar datos de audiencia a través de la gestión de público, y medir la participación de vídeo a través de eventos de vídeo.

Biblioteca móvil / Implementación SDK

1. Añada la biblioteca de Roku descargada al proyecto.

   1. El archivo de descarga AdobeMobileLibrary-2.*-Roku.zip consta de los siguientes componentes de software:

      • adbmobile.brs: Este archivo de biblioteca se incluirá en la carpeta de origen de la aplicación Roku.

      • ADBMobileConfig.json: Este archivo de configuración del SDK se personaliza en función de la aplicación.

   2. Añada el archivo de biblioteca y el archivo de configuración JSON al origen del proyecto.

      El JSON que se utiliza para configurar Adobe Mobile tiene una clave exclusiva para el análisis de medios llamada mediaHeartbeat. Es allí donde actúan los parámetros de configuración de los análisis de medios.

      SUGERENCIA

      Se suministra un archivo JSON ADBMobileConfig de muestra con el paquete. Contacte con sus representantes de Adobe para conocer la configuración.

      Por ejemplo:

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

      Parámetro de configuración	Descripción
      server	Cadena que representa la URL del punto final de seguimiento en el servidor.
      publisher	Cadena que representa el identificador único del editor de contenido.
      channel	Cadena que representa el nombre del canal de distribución de contenido.
      ssl	Booleano que representa si SSL debe utilizarse para rastrear llamadas.
      ovp	Cadena que representa el nombre del proveedor del reproductor de vídeo.
      sdkversion	Cadena que representa la versión actual de la aplicación/SDK.
      playerName	Cadena que representa el nombre del reproductor.

      IMPORTANTE

      Si mediaHeartbeat se configura incorrectamente, el módulo multimedia (VHL) entrará en un estado de error y dejará de enviar llamadas de seguimiento.

2. Configure el ID de visitante de Experience Cloud.

   El servicio de ID de visitante de Experience Cloud ofrece un ID de visitante universal para las soluciones de Experience Cloud. El servicio de identificación de visitantes es necesario para los eventos de vídeo y otras integraciones de Marketing Cloud.

   Verifique que su configuración de ADBMobileConfig contenga su ID de empresa de marketingCloud.

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

   Los ID de empresa de Experience Cloud identifican exclusivamente cada empresa de los clientes en Adobe Experience Cloud y aparecen similares al siguiente valor: 016D5C175213CCA80A490D05@AdobeOrg.

   IMPORTANTE

   Asegúrese de incluir @AdobeOrg.

   Una vez completada la configuración, se genera un ID de visitante de Experience Cloud que se incluye en todas las visitas. Otros ID de visitante, como custom y automatically-generated, se siguen enviando con cada visita.

   Métodos de servicio de ID de visitantes de Experience Cloud

   SUGERENCIA

   Los métodos de ID de los visitantes de Experience Cloud cuentan con el prefijo visitor.

   Método	Descripción
   visitorMarketingCloudID	Recupera el ID del visitante de Experience Cloud del servicio de ID del visitante. ADBMobile().visitorMarketingCloudID()
   visitorSyncIdentifiers	Con el ID de Visitante de Experience Cloud, puede establecer ID de cliente adicionales que se pueden asociar con cada visitante. La API de visitante acepta varios ID de cliente para el mismo visitante y un identificador de tipo de cliente para separar el ámbito de los distintos ID de cliente. Este método corresponde a setCustomerIDs. Por ejemplo: identifiers={} identifiers["idType"]="idValue" ADBMobile().visitorSyncIdentifiers(identifiers)
   setAdvertisingIdentifier	Se utiliza para establecer el ID de Roku para publicidad (RIDA) en el SDK. Por ejemplo: ADBMobile().setAdvertisingIdentifier(   "<sample_roku_identifier_for_advertising>") Obtenga el ID de Roku para publicidad (RIDA) mediante la API de SDK de Roku getRIDA().
   getAllIdentifiers	Devuelve una lista de todos los identificadores almacenados por el SDK, incluidos los identificadores de Analytics, Visitante, Audience Manager y personalizados. identifiers = ADBMobile().getAllIdentifiers()

   API públicas adicionales

   DebugLogging

   Método	Descripción
   setDebugLogging	Se utiliza para habilitar o deshabilitar el registro de depuración para el SDK. ADBMobile().setDebugLogging(true)
   getDebugLogging	Devuelve true si el registro de depuración está habilitado. isDebugLoggingEnabled = ADBMobile().getDebugLogging()

   PrivacyStatus

   Constante	Descripción
   PRIVACY_STATUS_OPT_IN	Constante que se pasa al llamar a setPrivacyStatus para la adhesión. optInString = ADBMobile().PRIVACY_STATUS_OPT_IN
   PRIVACY_STATUS_OPT_OUT	Constante que se pasa al llamar a setPrivacyStatus para la exclusión. optOutString = ADBMobile().PRIVACY_STATUS_OPT_OUT

   Método	Descripción
   setPrivacyStatus	Establece el estado de privacidad en el SDK. ADBMobile().setPrivacyStatus(ADBMobile().PRIVACY_STATUS_OPT_IN)
   getPrivacyStatus	Obtiene el estado de privacidad actual establecido en el SDK. privacyStatus = ADBMobile().getPrivacyStatus()

   IMPORTANTE

   Asegúrese de llamar a la función processMessages y processMediaMessages en el bucle de evento principal cada 250 m para garantizar que el SDK envíe los pings correctamente.

   Método	Descripción
   processMessages	Responsable de pasar los eventos de Analytics al SDK que se va a gestionar. ADBMobile().processMessages()
   processMediaMessages	Responsable de pasar los eventos de medios al SDK que se va a gestionar. ADBMobile().processMediaMessages()