Show Menu

Set Up Roku


  • Obtain valid configuration parameters for Heartbeats These parameters can be obtained from an Adobe representative after you set up your media analytics account.
  • Provide the following capabilities in your media player:
    • An API to subscribe to player events - The Media SDK requires that you call a set of simple APIs when events occur in your player.
    • An API that provides player information - This information includes details such as the media name and the play head position.
Adobe Mobile services provides a new UI that brings together mobile marketing capabilities for mobile applications from across the Adobe Marketing Cloud. Initially, the Mobile service provides seamless integration of app analytics and targeting capabilities for the Adobe Analytics and Adobe Target solutions.
Roku SDK 2.x for Experience Cloud Solutions lets you measure Roku applications written in BrightScript, leverage and collect audience data through audience management, and measure video engagement through Video heartbeats.

SDK Implementation

  1. Add your downloaded Roku library to your project.
    1. The AdobeMobileLibrary-2.* download file consists of the following software components:
      • adbmobile.brs : This library file will be included in your Roku app source folder.
      • ADBMobileConfig.json : This SDK configuration file is customized for your app.
    2. Add the library file and JSON config file to your project source.
      The JSON that is used to configure Adobe Mobile has an exclusive key for media heartbeats called mediaHeartbeat . This is where the configuration parameters for the media heartbeats belong.
      A sample ADBMobileConfig JSON file is provided with the package. Contact your Adobe representatives for the settings.
      For example:
          "poi":[ ]
      Config Parameter
      String that represents the URL of the tracking endpoint on the backend.
      String that represents the content publisher unique identifier.
      String that represents the name of the content distribution channel.
      Boolean that represents whether SSL should be used for tracking calls.
      String that represents the name of the video player provider.
      String that represents the current version of the app/SDK.
      String that represents the name of the player.
      If mediaHeartbeat is incorrectly configured, the media module (VHL) enters an error state and will stop sending tracking calls.
  2. Configure Experience Cloud Visitor ID.
    The Experience Cloud Visitor ID service provides a universal Visitor ID across Experience Cloud solutions. The Visitor ID service is required by Video heartbeat and other Marketing Cloud integrations.
    Verify that your ADBMobileConfig config contains your marketingCloud organization ID.
    "marketingCloud": {
        "org": YOUR-MCORG-ID"
    Experience Cloud organization IDs uniquely identify each client company in the Adobe Marketing Cloud and appear similar to the following value: 016D5C175213CCA80A490D05@AdobeOrg .
    Ensure that you include @AdobeOrg .
    After the configuration is complete, an Experience Cloud Visitor ID is generated and is included on all hits. Other Visitor IDs, such as custom and automatically-generated , continue to be sent with each hit.
    Experience Cloud Visitor ID Service Methods
    Experience Cloud Visitor ID methods are prefixed with visitor .
    Retrieves the Experience Cloud visitor ID from the visitor ID service.
    With the Experience Cloud Visitor ID, you can set additional customer IDs that can be associated with each visitor. The Visitor API accepts multiple customer IDs for the same visitor and a customer type identifier to separate the scope of the different customer IDs. This method corresponds to setCustomerIDs . For example:
    Used to set the Roku ID for Advertising (RIDA) on the SDK. For example:
    Get the Roku ID for Advertising (RIDA) using the Roku SDK getRIDA() API.