appsflyer-html5-ctv-sdk

🛠 In order for us to provide optimal support, we would kindly ask you to submit any issues to support@appsflyer.com

When submitting an issue please specify your AppsFlyer sign-up (account) email , your app ID , production steps, logs, code snippets and any additional relevant information.

This SDK is built for

• Samsung (Tizen 4 & above)
• LG (Webos 4 & above)
• Other platforms (See example for VIZIO (Smartcast) Vidaa (vidaaOS) in the following implementation guide)

📖 Guides

• Adding the SDK to your project
  • Yarn
  • appsflyerSdk.bundle.js
• Platforms dependency
  • Samsung
  • LG
  • Other platforms
• Basic implemantation of the SDK
• API
  • AppsFlyerSDK initialization
  • Start
  • In-app events
  • Set custom payload
  • Set customer user Id
  • Init (Deprecated!)
• Testing the integration
  • Logs
  • Response codes
  • Sample App

Adding the SDK to your project

Yarn

Please make sure to use npm v16.16.0/yarn v1.21.0 and above!

$ yarn add appsflyer-html5-ctv-sdk

appsflyerSdk.bundle.js

Download the appsflyerSdk.bundle.js file from here, and add it to your index.html file header:

<script src="[bundle-js-location]"></script>

Platform dependency

In order for the SDK to fetch device data from the relevant platform, make sure to follow the following instructions:

Samsung

1. Add the following script to your index.html file:

<script type="text/javascript" src="$WEBAPIS/webapis/webapis.js"></script>

2. Add the following dependecies through Tizen studio:

<tizen:privilege name="http://tizen.org/privilege/internet"/>
<tizen:privilege name="http://developer.samsung.com/privilege/productinfo"/>
<tizen:privilege name="http://developer.samsung.com/privilege/adinfo"/>

LG

1. Download the webOSTVjs to your project.

2. Add the following script to your index.html file:

<script type="text/javascript" src="[webOSTVjs-1.2.4-directory]"></script>

Other platforms (VIDAA/VIZIO)

For VIDAA/VIZIO Please follow this guide

🚀 Basic implemantation of the SDK

Initialize the SDK to enable AppsFlyer to detect installations, sessions (app opens) and updates.

import AppsFlyerSDK from 'appsflyer-html5-ctv-sdk'

let appsflyer;
let config = {
    devKey: "RxutGo4bSB9MKkM7bMCjHP",
    appId: "3202204027284",
    isDebug: true, 
    isSandbox: false
}

try{
    appsflyer = await new AppsFlyerSDK(config);
}catch(e){
    console.log("AppsFlyerSDK initialization failed. Error " + e);
}  

try{
    let response = await appsflyer.start();
    console.log("start API response success: " + JSON.stringify(response));
}catch(err){
    console.log("start API response err: " + JSON.stringify(err));
}