Implementing TRUENDO CMP on TV Platforms: Detailed Instructions

Introduction#

This comprehensive guide provides detailed, actionable instructions for implementing the TRUENDO Consent Management Platform (CMP) on various TV platforms. It is designed to assist developers in integrating TRUENDO CMP into their TV applications, ensuring compliance with data protection regulations like GDPR and CCPA while providing a seamless user experience.

Table of Contents#

Understanding TRUENDO CMP Integration
General Recommendations
Platform-Specific Implementation Guides
- A. Android TV
- B. Apple TV (tvOS)
- C. Samsung Tizen TV
- D. LG webOS TV
- E. Amazon Fire TV
- F. Roku TV
Testing and Validation
Compliance and Legal Considerations
Support and Resources
Conclusion

1. Understanding TRUENDO CMP Integration#

TRUENDO CMP helps manage user consent for data processing activities, ensuring compliance with privacy regulations. Integrating it into TV platforms involves:

Embedding the CMP interface (web-based or native).
Handling user interactions and consent preferences.
Storing and updating consent data securely.
Ensuring the application respects user consent choices.

2. General Recommendations#

Prepare the Development Environment: Install necessary SDKs, emulators, and tools for each platform.
Obtain TRUENDO Credentials: Ensure you have your unique websiteUuid from TRUENDO's admin panel.
Understand Platform Capabilities: Know whether the platform supports web views or requires native implementations.
Optimize User Experience: Design the CMP interface for remote navigation and large screens.
Ensure Compliance: Adhere to GDPR, CCPA, and other relevant regulations.

3. Platform-Specific Implementation Guides#

A. Android TV

Prerequisites

Development Environment:

Install Android Studio.
Install the Android SDK and Android TV system images.

TRUENDO Credentials:

Obtain your websiteUuid from the TRUENDO admin panel.

Step-by-Step Instructions

1. Create a New Android TV Project

Open Android Studio.
Select File > New > New Project.
Choose TV > Android TV Empty App.
Configure your project settings (e.g., name, package name).
Click Finish.

2. Configure Project Dependencies

Ensure the following dependencies are in your app/build.gradle:


dependencies {
    implementation 'androidx.leanback:leanback:1.0.0'
    implementation 'android.webkit:webkit:1.4.0'
    // Other dependencies
}

3. Add Internet Permissions

In AndroidManifest.xml, add:


<uses-permission android:name="android.permission.INTERNET" />

4. Design the Layout with WebView

Create or modify activity_main.xml:


<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <WebView
        android:id="@+id/truendoWebView"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />
</FrameLayout>

5. Initialize the WebView in Your Activity

In MainActivity.java or MainActivity.kt:


public class MainActivity extends Activity {

    private WebView webView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        webView = findViewById(R.id.truendoWebView);

        WebSettings webSettings = webView.getSettings();
        webSettings.setJavaScriptEnabled(true);
        webSettings.setAllowFileAccessFromFileURLs(true);
        webSettings.setAllowUniversalAccessFromFileURLs(true);

        // Enable remote debugging if needed
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {
            WebView.setWebContentsDebuggingEnabled(true);
        }

        // Load the TRUENDO CMP
        loadTruendoCMP();
    }

    private void loadTruendoCMP() {
        webView.addJavascriptInterface(new JavaScriptInterface(this), "Android");
        webView.setWebViewClient(new WebViewClient());
        webView.loadUrl("file:///android_asset/truendo.html");
    }

    // Handle remote control inputs
    @Override
    public boolean onKeyDown(int keyCode, KeyEvent event) {
        if (webView != null) {
            webView.dispatchKeyEvent(event);
            return true;
        }
        return super.onKeyDown(keyCode, event);
    }
}

6. Create the JavaScript Interface

Still in MainActivity.java:


public class JavaScriptInterface {
    Context mContext;

    JavaScriptInterface(Context c) {
        mContext = c;
    }

    @JavascriptInterface
    public void closePanel() {
        // Handle closing the CMP if needed
    }

    @JavascriptInterface
    public void updateConsent(String consentData) {
        // Store consent data
        SharedPreferences sharedPref = mContext.getSharedPreferences("ConsentPrefs", Context.MODE_PRIVATE);
        SharedPreferences.Editor editor = sharedPref.edit();
        editor.putString("consentData", consentData);
        editor.apply();
    }
}

7. Add the TRUENDO HTML File

Create a file named truendo.html in the app/src/main/assets directory.

Contents of truendo.html:


<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <title>TRUENDO CMP</title>
  <script type="text/javascript">
    window.truendoConfig = {
      websiteUuid: 'YOUR_WEBSITE_UUID'
    };

    function appCallback(name, parameters) {
      if (name === "closePanel") {
        Android.closePanel();
      }
      if (name === "allData" && parameters?.truendo_cmp?.ack === true) {
        Android.updateConsent(JSON.stringify(parameters));
      }
    }
  </script>
  <script src="https://cdn.truendo.com/truendo.min.js" async></script>
</head>
<body>
</body>
</html>

Replace 'YOUR_WEBSITE_UUID' with your actual TRUENDO websiteUuid.

8. Handle Remote Control Navigation

Ensure the WebView captures remote control inputs as shown in step 5.
No additional code is needed if the onKeyDown method dispatches events to the WebView.

9. Store and Retrieve Consent Preferences

Consent data is stored in SharedPreferences within the updateConsent method.
Retrieve consent data when needed:


SharedPreferences sharedPref = getSharedPreferences("ConsentPrefs", Context.MODE_PRIVATE);
String consentData = sharedPref.getString("consentData", null);

10. Control Data Processing Based on Consent

Before performing any data processing, check if the user has consented:


private boolean userHasConsented() {
    SharedPreferences sharedPref = getSharedPreferences("ConsentPrefs", Context.MODE_PRIVATE);
    String consentData = sharedPref.getString("consentData", null);
    if (consentData != null) {
        // Parse consentData and determine if consent is given
        return true;
    }
    return false;
}

11. Test the Implementation

Run the app on an Android TV emulator or device.
Verify that:
- The CMP loads correctly.
- Navigation works with the remote control.
- Consent preferences are stored and respected.

Troubleshooting Tips

CMP Not Loading: Ensure internet permissions are set and the WebView settings allow JavaScript.
Navigation Issues: Confirm that key events are properly dispatched to the WebView.
Consent Data Not Saving: Check the updateConsent method for errors.

Additional Resources

Android TV Developer Guide: Android TV App Development
TRUENDO Support: support@truendo.com

B. Apple TV (tvOS)

Prerequisites

Development Environment:

Install Xcode and the tvOS SDK.

TRUENDO Credentials:

Obtain your websiteUuid from the TRUENDO admin panel.

Step-by-Step Instructions

1. Create a New tvOS Project

Open Xcode.
Select File > New > Project.
Choose tvOS > App and click Next.
Configure project settings (e.g., name, organization identifier).
Select Storyboard as the interface (if desired).
Click Finish.

2. Set Up the TruendoWebView Integration

Since WKWebView is supported on tvOS, you can leverage the TRUENDO TruendoWebView class with some adjustments for remote control navigation.

Create or update ViewController.swift:


import UIKit
import WebKit

class ViewController: UIViewController, TruendoWebViewDelegate {
    private var truendoWebView: TruendoWebView!

    override func viewDidLoad() {
        super.viewDidLoad()

        truendoWebView = TruendoWebView(frame: self.view.frame, delegate: self)
        self.view.addSubview(truendoWebView)
        truendoWebView.show(with: "YOUR_WEBSITE_UUID", dataLang: "en", tdc: nil)
    }

    func close() {
        // Handle the close action for the TRUENDO CMP interface
    }

    func updatedCookie(with body: String) {
        // Store consent data from TRUENDO here
    }
}

Note: Replace "YOUR_WEBSITE_UUID" with your actual TRUENDO websiteUuid.

3. Enable Remote Control Navigation

Focus Navigation: Apple TV applications rely on focus navigation, so ensure focusable elements are properly configured within the TruendoWebView.
UIFocusEnvironment: Handle UIFocusEnvironment by enabling isFocusable on necessary elements and ensure smooth navigation among buttons or consent options.

4. Capture and Store Consent Data

The updatedCookie(with:) function in TruendoWebViewDelegate captures consent data.
Store the consent data in UserDefaults:


func updatedCookie(with body: String) {
    UserDefaults.standard.set(body, forKey: "ConsentPrefs")
}

5. Respect User Consent Choices

Before performing any data processing, verify user consent from stored preferences:


func userHasConsented() -> Bool {
    guard let consentData = UserDefaults.standard.string(forKey: "ConsentPrefs") else {
        return false
    }
    // Parse `consentData` and determine if consent is given
    return true
}

6. Test the Implementation

Run the app on the Apple TV simulator or a physical device.
Verify the following:
- The consent interface loads correctly.
- Navigation works seamlessly with the Apple TV remote.
- Consent preferences are stored and respected.

Troubleshooting Tips

UI Not Updating: Ensure that all UI updates are performed on the main thread.
Focus Issues: Verify that focusable elements are correctly configured, especially for tvOS's focus engine.

Additional Resources

Apple TV Developer Guide: tvOS Development
TRUENDO Support: support@truendo.com

C. Samsung Tizen TV

Prerequisites

Development Environment:

Install Tizen Studio.
Set up the Tizen TV SDK.

TRUENDO Credentials:

Obtain your websiteUuid from the TRUENDO admin panel.

Step-by-Step Instructions

1. Create a New Tizen Web Project

Open Tizen Studio.
Select File > New > Tizen Project.
Choose TV > Template > Basic Project.
Click Next and configure your project settings.
Click Finish.

2. Add the TRUENDO CMP to Your App

Open index.html in your project's src folder.
Insert the TRUENDO CMP script in the <head> section:


<script type="text/javascript">
  window.truendoConfig = {
    websiteUuid: 'YOUR_WEBSITE_UUID'
  };

  function appCallback(name, parameters) {
    if (name === "closePanel") {
      // Handle closing the CMP
    }
    if (name === "allData" && parameters?.truendo_cmp?.ack === true) {
      // Handle updated consent data
      var consentData = JSON.stringify(parameters);
      localStorage.setItem("consentData", consentData);
    }
  }
</script>
<script src="https://cdn.truendo.com/truendo.min.js" async></script>

3. Handle Remote Control Navigation

Tizen apps use the tizen.tvinputdevice API to handle remote input.
Add the following script to capture key events:


document.addEventListener('keydown', function(e) {
  var keyCode = e.keyCode;
  // Handle navigation keys (e.g., arrows, enter)
  // Pass events to the CMP if needed
});

4. Store and Retrieve Consent Preferences

Use localStorage to store consent data:


localStorage.setItem("consentData", consentData);

Retrieve consent data when needed:


var consentData = localStorage.getItem("consentData");

5. Control Data Processing Based on Consent

Before processing data, check if consent is given:


function userHasConsented() {
  var consentData = localStorage.getItem("consentData");
  if (consentData) {
    // Parse consentData and determine consent status
    return true;
  }
  return false;
}

6. Test the Implementation

Use the Tizen TV emulator or a Samsung TV in Developer Mode.
Verify that:
- The CMP loads correctly.
- Remote navigation works.
- Consent preferences are saved and respected.

Troubleshooting Tips

CMP Not Loading: Check internet connectivity and script permissions.
Key Events Not Captured: Ensure that the tizen.tvinputdevice API is properly initialized.

Additional Resources

Samsung Tizen TV Developer Guide: Tizen TV Web Application
TRUENDO Support: support@truendo.com

D. LG webOS TV

Prerequisites

Development Environment:

Install the webOS TV SDK.
Install webOS IDE or use CLI tools.

TRUENDO Credentials:

Obtain your websiteUuid from the TRUENDO admin panel.

Step-by-Step Instructions

1. Create a New webOS TV App

Use the webOS IDE to create a new web app project.
Choose TV > webOS TV Web Application.
Configure your project settings and click Finish.

2. Add the TRUENDO CMP to Your App

Open your main HTML file (e.g., index.html).
Insert the TRUENDO CMP script in the <head> section:


<script type="text/javascript">
  window.truendoConfig = {
    websiteUuid: 'YOUR_WEBSITE_UUID'
  };

  function appCallback(name, parameters) {
    if (name === "closePanel") {
      // Handle closing the CMP
    }
    if (name === "allData" && parameters?.truendo_cmp?.ack === true) {
      // Handle updated consent data
      var consentData = JSON.stringify(parameters);
      localStorage.setItem("consentData", consentData);
    }
  }
</script>
<script src="https://cdn.truendo.com/truendo.min.js" async></script>

3. Handle Remote Control Navigation

Use JavaScript to capture key events:


document.addEventListener('keydown', function(e) {
  var keyCode = e.keyCode;
  // Handle navigation keys
});

4. Store and Retrieve Consent Preferences

Use localStorage:


localStorage.setItem("consentData", consentData);

Retrieve consent data:


var consentData = localStorage.getItem("consentData");

5. Control Data Processing Based on Consent

Implement a function to check consent:


function userHasConsented() {
  var consentData = localStorage.getItem("consentData");
  if (consentData) {
    // Parse and check consent status
    return true;
  }
  return false;
}

6. Test the Implementation

Use the webOS emulator or an LG TV in Developer Mode.
Verify CMP functionality and remote navigation.

Troubleshooting Tips

CMP Not Displaying: Ensure network permissions are set in appinfo.json.
Key Events Not Working: Verify that the app captures key events and that they are not being blocked.

Additional Resources

LG webOS TV Developer Guide: webOS TV Web Apps
TRUENDO Support: support@truendo.com

E. Amazon Fire TV

Prerequisites

Development Environment:

Install Android Studio.
Install the Fire TV SDK Add-on.

TRUENDO Credentials:

Obtain your websiteUuid from the TRUENDO admin panel.

Step-by-Step Instructions

1. Create a New Fire TV Project

Similar to Android TV, but target Fire TV devices.

2. Configure Project Dependencies

Same as the Android TV setup.

3. Add Internet Permissions

In AndroidManifest.xml:


<uses-permission android:name="android.permission.INTERNET" />

4. Add the WebView to Your Layout

As in the Android TV instructions.

5. Initialize the WebView

Similar to Android TV, but ensure compatibility with Fire TV devices.

6. Load the TRUENDO CMP

Use the same truendo.html file.

7. Handle Remote Control Navigation

Fire TV uses the same key event handling as Android TV.

8. Store and Retrieve Consent Preferences

Use SharedPreferences as in the Android TV example.

9. Control Data Processing Based on Consent

Implement consent checks before processing data.

10. Test the Implementation

Use the Fire TV emulator or a physical Fire TV device.

Troubleshooting Tips

Compatibility Issues: Ensure your app meets Amazon's Fire TV app guidelines.
Remote Input Problems: Confirm that key events are handled correctly.

Additional Resources

Amazon Fire TV Developer Guide: Fire TV App Development
TRUENDO Support: support@truendo.com

F. Roku TV

Prerequisites

Development Environment:

Install the Roku SDK.
Set up the BrightScript development environment.

TRUENDO Credentials:

Obtain your websiteUuid from the TRUENDO admin panel.

Step-by-Step Instructions

1. Create a New Roku Channel

Use the Roku SDK to create a new channel application.

2. Design the Consent Interface

Use SceneGraph components to build the UI.


<Interface>
  <Font
    id="FontRegular"
    uri="pkg:/fonts/Regular.ttf"
    size="24" />
  <!-- Define UI elements like Labels, Buttons -->
</Interface>

3. Implement the Consent Logic in BrightScript

In Main.brs:


sub RunUserInterface()
    m.top = CreateObject("roSGScreen")
    m.port = CreateObject("roMessagePort")
    m.top.SetMessagePort(m.port)
    scene = m.top.CreateScene("ConsentScene")
    m.top.Show()

    while true
        msg = wait(0, m.port)
        if type(msg) = "roSGScreenEvent"
            if msg.isScreenClosed()
                exit while
            end if
        end if
        ' Handle other events
    end while
end sub

4. Fetch CMP Configuration

Use Roku's networking capabilities:


function fetchCMPConfig()
    url = "https://prod-origin.truendo.com/configs/YOUR_WEBSITE_UUID/default"
    request = CreateObject("roUrlTransfer")
    request.SetUrl(url)
    response = request.GetToString()
    ' Parse the JSON response
end function

5. Handle User Interactions

Map remote control inputs to consent options.
Update consent preferences based on user selections.

6. Store Consent Preferences

Use roRegistry to store data:


registry = CreateObject("roRegistrySection", "ConsentPrefs")
registry.Write("consentData", consentData)

7. Control Data Processing Based on Consent

Before processing data, check consent:


function userHasConsented()
    registry = CreateObject("roRegistrySection", "ConsentPrefs")
    consentData = registry.Read("consentData")
    if consentData <> invalid
        ' Parse consentData and determine consent status
        return true
    end if
    return false
end function

8. Test the Implementation

Package and sideload the app onto a Roku device for testing.

Troubleshooting Tips

UI Issues: Ensure that UI components are correctly defined in the XML files.
Network Errors: Check that the Roku device has internet access and that URLs are correctly formatted.

Additional Resources

Roku Developer Guide: Roku SceneGraph Developer Extensions
TRUENDO Support: support@truendo.com

4. Testing and Validation#

Functional Testing:

Verify that the CMP loads and functions correctly.
Test consent acceptance and rejection flows.

Performance Testing:

Ensure the CMP doesn't negatively impact app performance.

Compliance Testing:

Confirm that data processing aligns with user consent.

User Acceptance Testing:

Gather feedback to improve the user experience.

5. Compliance and Legal Considerations#

Data Protection Regulations:

Ensure compliance with GDPR, CCPA, and other relevant laws.

Consent Records:

Store consent choices securely.

Privacy Policy:

Include links or references to your privacy policy within the app.

Third-Party Services:

Ensure that third-party services respect user consent.

6. Support and Resources#

TRUENDO Support:

Email: support@truendo.com
Website: TRUENDO Support Center

Platform Developer Guides:

Android TV: Android TV App Development
Apple TV: tvOS Development
Samsung Tizen TV: Tizen TV Web Application
LG webOS TV: webOS TV Web Apps
Amazon Fire TV: Fire TV App Development
Roku TV: Roku Developer

Legal Resources:

GDPR Information: GDPR.eu
CCPA Information: CCPA Overview

7. Conclusion#

Implementing the TRUENDO CMP on TV platforms requires adapting to the unique capabilities and constraints of each platform. By following the detailed instructions provided, developers can integrate TRUENDO CMP effectively, ensuring compliance with data protection regulations and delivering a seamless user experience.

Remember to:

Test Thoroughly: Validate the implementation on actual devices.
Stay Updated: Keep abreast of changes in platform capabilities and legal requirements.
Seek Support: Utilize TRUENDO's support resources for assistance.

Note: Always consult with legal professionals to ensure full compliance with data protection laws relevant to your region and audience.

Start typing to search, or search using the advanced options below.

Sources:

Implementing TRUENDO CMP on TV Platforms: Detailed Instructions

Introduction#

Table of Contents#

1. Understanding TRUENDO CMP Integration#

2. General Recommendations#

3. Platform-Specific Implementation Guides#

A. Android TV

Prerequisites

Step-by-Step Instructions

Troubleshooting Tips

Additional Resources

B. Apple TV (tvOS)

Prerequisites

Step-by-Step Instructions

Troubleshooting Tips

Additional Resources

C. Samsung Tizen TV

Prerequisites

Step-by-Step Instructions

Troubleshooting Tips

Additional Resources

D. LG webOS TV

Prerequisites

Step-by-Step Instructions

Troubleshooting Tips

Additional Resources

E. Amazon Fire TV

Prerequisites

Step-by-Step Instructions

Troubleshooting Tips

Additional Resources

F. Roku TV

Prerequisites

Step-by-Step Instructions

Troubleshooting Tips

Additional Resources

4. Testing and Validation#

5. Compliance and Legal Considerations#

6. Support and Resources#

7. Conclusion#

End of Guide

Start typing to search,
or search using the advanced options below.