https://github.com/appsflyersdk/appsflyer-html5-ctv-sdk
AppsFlyer SDK for TV application
https://github.com/appsflyersdk/appsflyer-html5-ctv-sdk
Last synced: 6 months ago
JSON representation
AppsFlyer SDK for TV application
- Host: GitHub
- URL: https://github.com/appsflyersdk/appsflyer-html5-ctv-sdk
- Owner: AppsFlyerSDK
- License: mit
- Created: 2022-12-14T12:08:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-27T07:35:34.000Z (about 1 year ago)
- Last Synced: 2024-04-23T03:41:06.971Z (about 1 year ago)
- Language: JavaScript
- Size: 1.32 MB
- Stars: 2
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# appsflyer-html5-ctv-sdk
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/js/appsflyer-html5-ctv-sdk)
[](https://www.npmjs.com/package/appsflyer-html5-ctv-sdk)
🛠In order for us to provide optimal support, we would kindly ask you to submit any issues to [email protected]
> *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.*
- 
Samsung (Tizen 4 & above)
- 
LG (Webos 4 & above)
- Other platforms (See example for VIZIO (Smartcast) Vidaa (vidaaOS) in the [following implementation guide](/docs/other-platforms.md))
## 📖 Guides
- [Adding the SDK to your project](#installation)
- [Yarn](#yarn)
- [appsflyerSdk.bundle.js](#bundle)
- [Platforms dependency](#platform-dependency)
- [Samsung](#samsung)
- [LG](#lg)
- [Other platforms](/docs/other-platforms.md)
- [Basic implemantation of the SDK](#integration)
- [API](/docs/api.md)
- [AppsFlyerSDK initialization](/docs/api.md#newAppsflyerSdk)
- [Start](/docs/api.md#start)
- [In-app events](/docs/api.md#inappevents)
- [Set custom payload](/docs/api.md#setCustomPayload)
- [Set customer user Id](/docs/api.md#setCustomerUserId)
- [Init (Deprecated!)](/docs/api.md#init)
- [Testing the integration](/docs/testing.md)
- [Logs](/docs/testing.md#logs)
- [Response codes](/docs/testing.md#response-codes)
- [Sample App](/docs/testing.md#demo)
#
## 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
```
Download the appsflyerSdk.bundle.js file from [here](dist/appsflyerSdk.bundle.js), and add it to your index.html file header:
```
```
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:
```
```
2. Add the following dependecies through Tizen studio:
```
```
### LG
1. Download the [webOSTVjs](https://webostv.developer.lge.com/develop/references/webostvjs-introduction) to your project.
2. Add the following script to your index.html file:
```
```
### Other platforms (VIDAA/VIZIO)
For VIDAA/VIZIO Please follow [this guide](/docs/other-platforms.md)
## 🚀 Basic implemantation of the SDK
Initialize the SDK to enable AppsFlyer to detect installations, sessions (app opens) and updates.
```javascript
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));
}
```