# POKKT Developer Documentation
Last Update: September 9th, 2024
Welcome to POKKT Developer Documentation
**Select a topic from left menu**
# POKKT SDK
Next
Pokkt Integration To Admob (iOS, v8.2.0)
# Pokkt AdMob Adapter Integration Guide v8.2.0 Android
#### Step 1: Getting Started
The following instructions assume you have already integrated Google Mobile Ads SDK into your application.
#### Step 2 :Project Configuration
Add PokktSDK\_v8.2.0.aar to your project app/libs folder and add the following line in your app level build.gradle file.
dependencies {
implementation fileTree(include: \[‘PokktSDK\_v8.2.0.aar'], dir: ‘libs');
}
#### Step 3: Adding Your Application to Your Pokkt Publisher's Account
* Create Account and log-in at [http://www.pokkt.com](http://www.pokkt.com/)
* Add your application and get its application Id and Security key.
* Create Screen Ids to be used in AdMob dashboard to set ad source.
ScreenId is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
Developer needs to create screens in Pokkt Developer account.
#### Step 4: Adding a Custom Event
1. Sign in to your AdMob account at [https://apps.admob.com](https://apps.admob.com/).
2. Under All apps on the left navigation, select the app you want to update.
3. Click Mediation on the left navigation menu item.
4. Select the mediation group to which POKKT should be added.
5. Click Custom event under AdSources, and provide the following details:
* Label: Enter the name for the custom event. This is used in reporting and cannot be changed later.
1. Click Continue and Add class name and Parameters.
* Class Name(**Mandatory**): Enter class names as follows :
Rewarded Video: com.pokkt.wrapper.thirdparty.AdMob.PokktRewardedVideoAdapter
Interstitial : com.pokkt.wrapper.thirdparty.AdMob.PokktCustomEventInterstitial
Banner : com.pokkt.wrapper.thirdparty.AdMob.PokktCustomEventBanner
* Parameter : Enter a JSON string as below. **Screen, App Id and Sec key are mandatory**. Rest all are optional.
{
"SCREEN": "Screen ID Created on Pokkt Dashboard",
"APPID": "Pokkt App Id",
"SECKEY": "Pokkt App Security Key",
"TPID": "Unique user id(If exist) as in your app",
"RWD": "Virtual currency As per your App",
"DBG": false,
"GDPR": false
}
#### Step 5: Testing your application
Congratulation - that's it! You may now run your app and see Pokkt ads in action.
#### FAQ
* To use Pokkt AdMob adapter in Unity , add PoktSDK to your project’s Assets->Plugins->Android folder. PokktSDK Unity Plugin is not needed for AdMob Mediation.
* If your project uses GDPR, Please refer for understanding. Pokkt Solution adheres to GDPR requirement as per AdMob doc.GDPR consent must be taken by publishers before calling any ad related api. Add UMP as a dependency in your project’s app level build.gradle file.
dependencies {
implementation ‘com.google.android.ump:user-messaging-platform:2.0.0’
}
* AdMob SDK version used: **20.3.0**
* It will take around 6 hours time to reflect the changes made in the AdMob dashboard.
# POKKT SDK Integration Guide v8.2.0 Android
#### Overview
Thank you for choosing Pokkt SDK for Android. This document contains all the information required to setup the SDK with your project.
Before implementing plugins it is mandatory to go through project configuration and implementation steps, as these sections contain mandatory steps for basic SDK integration.
You can download our SDK from [pokkt.com](https://wiki.pokkt.com/Native_Android).
Downloaded SDK package will contain:
1. PokktSDK\_v8.2.0.aar : Pokkt SDK in aar format.
2. Sample App using PokktSDK
#### Project Configuration
Add PokktSDK\_v8.2.0.aar to your project app/libs folder and add the following line in your app level build.gradle file. **minSdkVersion** supported is **16.**
dependencies {
implementation fileTree(include: \[‘PokktSDK\_v8.2.0.aar'], dir: ‘libs');
implementation ‘com.google.android.gms:play-services-ads:21.3.0’ //Optional
}
We expect Google play services integrated in project, although it is optional but we recommend you to integrate it, as it is required to fetch AdvertisingID for device, which is useful to deliver targeted advertising to Android users.
#### Adding Your Application to Your Pokkt Publisher's Account
This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
Developer needs to create screens in Pokkt Developer account.
#### Implementation Steps
Set Application Id and Security key in Pokkt SDK. You can get it from Pokkt dashboard from your account. These are unique per app registered. **This must be called before calling any other methods of Pokkt SDK**.
`PokktAds.setPokktConfig("","","");`
#### FullScreen Ads
To cache FullScreen ad, call below method
`PokktAds.cacheAd("",);`
To show FullScreen ad, call below method
`PokktAds.showAd(“”,, null);`
To check if FullScreen ad is cached or not, call below method
`PokktAds.isAdCached("">);`
#### Banner Ads
Add Banner Ad View to layout
```xml
```
To show Banner ad, call below method
`PokktAds.showAd("", , );`
To destroy Banner ad, call below method
`PokktAds.destroyBanner();`
To define PokktAdDelegate, refer below code
```
PokktAds.PokktAdDelegate adDelegate = new PokktAds.PokktAdDelegate() {
@Override
public void adCachingResult(screenId,isSuccess,reward,errorMessage) { }
@Override
public void adDisplayedResult(screenId,isSuccess,errorMessage) { }
@Override
public void adClosed(screenId,isComplete) { }
@Override
public void adGratified(screenId,reward) { }
@Override
public void adClicked(screenId) { }}
```
#### Test Ads
* Application Id : f303768353fb89d188f24b36c4d80b2e
* Security Key : f3b2bec2234694467398589e1606234b
* Sample Screen Id for Video : 684ab1e66abeb060faa500136c4c6a74
* Sample Screen Id for Interstitial : 5e59028c8332c9583e742c183abbaafb
* Sample Screen Id for Banner : 129cc53b4666f5ae1ebad6a9bc942764
#### Debugging
When your application is under development and if you want to see Pokkt logs and other informatory messages, you can enable it by setting shouldDebug to true . Make sure to disable debugging before release.
Other than enabling debugging for Pokkt SDK, it can also be used to
export your log to your desired location.
`PokktAds.Debugging.shouldDebug(“”,);`
`PokktAds.Debugging.exportLog(getActivity());`
#### Proguard
If you are using proguard in your app, add following rules to your proguard file.
```
# Pokkt SDK
-keep class com.pokkt.** { public *; }
-dontwarn com.pokkt.**
# moat
-keep class com.moat.** { *; }
-dontwarn com.moat.**
# 360 if Pokktsdk360ext.jar or Pokktsdk360ext.aar is added
-keep class com.pokkt.sdkmd360ext.** { *; }
-keep class com.c.c.**{*;}
# OM
-keep class com.iab.omid.library.pokkt.**{*;}
-dontwarn com.iab.omid.**
# For communication with Pokkt WebView
-keepclassmembers class * {
@android.webkit.JavascriptInterface ;
}
```
#### FAQ
* If you are using server to server integration with Pokkt, you can also set Third Party UserId in PokktAds.
`PokktAds.setThirdPartyUserId("");`
* If you want to set GDPR consent in Pokkt SDK. This must be called before calling any ad related API. Developers/Publishers must get the consent from user. This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting.
```
PokktAds.ConsentInfo consentInfo = new PokktAds.ConsentInfo();
consentInfo.setGDPRApplicable(true);
//true if GDPR is applicable.
consentInfo.setGDPRConsentAvailable(false);
//false if user has given consent to use personal details for ad targeting.
PokktAds.setDataAccessConsent(consentInfo);
```
* If Developer want to set some values in POKKT SDK that they need to be sent to their server via POKKT Server callbacks.
`Map params = new HashMap<>();`\
`params.put("testdata","{\"adnetwork\": \"pokkt\"}");`\
`PokktAds.setCallbackExtraParams(params);`
* FullScreen Ads are of two types : Video and Interstitial. It can be rewarded or non rewarded. Its properties can be configured from the Pokkt dashboard. You can either cache the ad in advance or directly call show for it. We suggest you cache the ad in advance so as to give seamless play behaviour, In other case it will stream the video which may lead to unnecessary buffering delays depending on the network connection.
* For better targeting of ads you can also provide user details to our SDK using below code.
```
PokktUserDetails pokktUserDetails = new PokktUserDetails();
pokktUserDetails.setName(" ");
pokktUserDetails.setAge(" ");
pokktUserDetails.setSex(" ");
pokktUserDetails.setMobileNumber(" ");
pokktUserDetails.setEmailAddress(" ");
pokktUserDetails.setLocation(" ");
pokktUserDetails.setBirthday(" ");
pokktUserDetails.setMaritalStatus(" ");
pokktUserDetails.setFacebookId(" ");
pokktUserDetails.setTwitterHandle(" ");
pokktUserDetails.setEducation(" ");
pokktUserDetails.setNationality(" ");
pokktUserDetails.setEmployment(" ");
pokktUserDetails.setMaturityRating(" ");
PokktAds.setUserDetails(pokktUserDetails);
```
# POKKT SDK Integration Guide for PG Team (v 8.2.0)
Thank you for choosing Pokkt SDK. This document contains all the information required to set up the Account on Publisher dashboard. Developer needs to create account on [pokkt.com](http://pokkt.com/) and add an application. Developers also need to create screens to be used in apps.
### Adding Your Application to Your Pokkt Publisher's Account
* Create Account and log-in at
* Add your application and get its application Id and Security key.
#### Adding App
#### Screens
This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
Developer needs to create screens in the Pokkt Developer account
#### Test Ads (iOS)
Application Id : eee33f012ee30473abcda10c65593d97
Security Key : 0adf197193966c9f9c25485154897398
Sample Screen Id for Video : 129fda6f5d8c4f5ea7450ce8b9c94eb8
Sample Screen Id for Interstitial : 3f3d981b416864215563a7ddfecb93f2
Sample Screen Id for Banner : 07d5ffd1766b28cc9b25f99d4b0c22ea
#### Test Ads (Android)
Application Id : f303768353fb89d188f24b36c4d80b2e
Security Key : f3b2bec2234694467398589e1606234b
Sample Screen Id for Video : 684ab1e66abeb060faa500136c4c6a74
Sample Screen Id for Interstitial : 5e59028c8332c9583e742c183abbaafb
Sample Screen Id for Banner : 129cc53b4666f5ae1ebad6a9bc942764
# POKKT SDK Integration Guide v8.2.0 iOS
**Overview**
Thank you for choosing Pokkt SDK for iOS. This document contains all the information required to set up the SDK with your project.
**Downloaded SDK package will contain.**
* Pokkt Documents
* Sample App using PokktSDK
**SDK Integration**
The Pokkt-Ads is installed using CocoaPods. To do this, add the following line to your Podfile. Refer to the below Example 1.
| pod 'Pokkt-Ads' |
| --------------- |
Example 1
Then from the command line run:
| pod install |
| ----------- |
Configuring App Transport Security (ATS)
Add the NSAllowsArbitraryLoads to your app's Info.plist file to disable ATS restrictions. As per the Apple guideline, the below code is required to allow a non-secure network, and the default value is false. For additional details [click here.](https://stackoverflow.com/questions/31216758/how-can-i-add-nsapptransportsecurity-to-my-info-plist-file)
|
\NSAppTransportSecurity\
\
\NSAllowsArbitraryLoads\
\
\
|
| -------------------------------------------------------------------------------------------------------------------------------- |
**Adding Your Application to Your Pokkt Publisher's Account**
• Create Account and log-in at [http://www.pokkt.com](http://www.pokkt.com/)
• Add your application and get its application Id and Security key.
• Create Screen Ids to be used in AdMob dashboard to set ad source.
This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
Developer needs to create screens in the Pokkt Developer account.
### **Implementation Steps**
Set **Application Id** and **Security key** in Pokkt SDK. You can get it from the Pokkt dashboard from your account. We generally assign a unique application-id and security-key.
First Import the **PokktSDK** and its delegate **PokktAdDelegate** and implement their methods to your project.
| **Objective C** | **Swift** |
| -------------------------------------- | ----------------------------------------------------------- |
| #import \ | **import** PokktSDK |
| UIViewController <**PokktAdDelegate**> | class ViewController: UIViewController, **PokktAdDelegate** |
**This must be called before calling any other methods of Pokkt SDK**.
| **Objective C** | **Swift** |
| ------------------------------------------------------------------ | ----------------------------------------------------------------- |
| \[PokktAds setPokktConfigWithAppId:appId securityKey:securityKey]; | PokktAds.setPokktConfigWithAppId(appId, securityKey: securityKey) |
### **Full-Screen Ads**
We will be referencing the PokktAdsDemo app provided with SDK during the course of explanation in this document. We suggest you go through the sample app for better understanding.
* To cache Full-screen ad call below method
| **Objective C** | **Swift** |
| ----------------------------------------------- | -------------------------------------- |
| \[PokktAds cacheAd:screenId withDelegate:self]; | PokktAds.cacheAd(screenId, with: self) |
* To Show FullScreen ad call the below method
| **Objective C** | **Swift** |
| ---------------------------------------------------------------- | --------------------------------------------------------- |
| \[PokktAds showAd:screenId withDelegate:self presentingVC:self]; | PokktAds.showAd(screenId, with: self, presentingVC: self) |
* You can check if an ad is available, before making a show request.
| **Objective C** | **Swift** |
| -------------------------------- | ----------------------------- |
| \[PokktAds isAdCached:screenId]; | PokktAds.isAdCached(ScreenId) |
**Banner Ads**
* Add Banner to view and Load banner Ad call
| **Objective C** | **Swift** |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
* To show banner ad, call the below method
| **Objective C** | **Swift** |
| ------------------------------------------------------------------------ | ----------------------------------------------------------------- |
| \[PokktAds showAd:screenId withDelegate:self inContainer:self.bannerAd]; | PokktAds.showAd(screenId, with: self, inContainer: self.bannerAd) |
* Refresh banner: You can set a banner refresh rate on the Pokkt dashboard. Refresh rate should be in range of 30 -100
* Destroy banner
| **Objective C** | **Swift** |
| -------------------------------- | ---------------------------- |
| \[PokktAds dismissAd: screenId]; | PokktAds.dismissAd(screenId) |
* Ad actions are optional, but we suggest implementing them as it will help you to keep track of the status of your ad request.
| **Objective C** | **Swift** |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
**Test Ads**
Application Id : eee33f012ee30473abcda10c65593d97
Security Key : 0adf197193966c9f9c25485154897398
Sample Screen Id for Video : 129fda6f5d8c4f5ea7450ce8b9c94eb8
Sample Screen Id for Interstitial : 3f3d981b416864215563a7ddfecb93f2
Sample Screen Id for Banner : 07d5ffd1766b28cc9b25f99d4b0c22ea
**Debugging**
When your application is under development and if you want to see sdk logs and other informatory messages, you can enable it by setting **setDebug** to **true**. Make sure to disable debugging before release.
| **Objective C** | **Swift** |
| ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
\[PokktDebugger setDebug:\];
\[PokktDebugger exportLog:self];
|
PokktDebugger.setDebug(true/false)
PokktDebugger.exportLog(self)
|
#### **FAQ**
#### If you are using server to server integration with Pokkt, you can also set **Third Party UserId** in PokktAds.
| **Objective C** | **Swift** |
| ------------------------------------------------- | ------------------------------------ |
| PokktAds.setThirdPartyUserId:(NSString\*) userId; | PokktAds.setThirdPartyUserId(userId) |
#### **GDPR**
#### If you want to set ***GDPR consent*** in Pokkt SDK. **This must be called before calling any ad related API. Developers/Publishers must get the consent from the user.** For more information on GDPR please refer [https://www.eugdpr.org/ ](https://www.eugdpr.org/)and . This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting.
| **Objective C** | **Swift** |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
#### **Extra Parameter**
#### You can set extra parameters to POKKT SDK, to be passed back to your server via POKKT server callback. These Extra parameters will be in key-value pair.The key must be alphanumeric value. See the below example.
| Objective C | Swift |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
var dict:\[String: Any]=\["key1": "value1", "key2": "value2", "key3": "value3"]
PokktAds.setCallbackExtraParam(dict)
|
* FullScreen Ads are of two types : Video and Interstitial. It can be rewarded or non rewarded. Its properties can be configured from the Pokkt dashboard. You can either cache the ad in advance or directly call show for it. We suggest you cache the ad in advance so as to give seamless play behavior, In other case it will stream the video which may lead to unnecessary buffering delays depending on the network connection.
**For better targeting of ads you can also provide user details to our SDK using**
| Objective C | Swift |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
# POKKT AdMob Adapter Integration v8.2.0 iOS
**Overview**
The following instructions assume you are already familiar with the AdMob Mediation Network and have already integrated the Google Mobile Ads SDK into your application. Otherwise, please start by reading the following articles for a walk-through explanation of what mediation is, how to use the AdMob Mediation UI, and instructions on how to add AdMob mediation code into your app. Mediation Overview : [Click Here.](https://support.google.com/admob/answer/3063564?visit_id=637711005693608961-1689371030\&rd=1) Instruction : [Click Here.](https://developers.google.com/admob/ios/quick-start)
**Downloaded SDK package will contain.**
* Pokkt Documents
Step 1: **Adapter Integration**
The **GoogleMobileAdsMediationPokktAds** is installed using CocoaPods. To do this, add the following line to your Podfile. Refer to the following example: 1.
| pod 'GoogleMobileAdsMediationPokktAds' |
| -------------------------------------- |
Example 1
Then from the command line run:
| pod install |
| ----------- |
Configuring App Transport Security (ATS)
Add the NSAllowsArbitraryLoads to your app's Info.plist file to disable ATS restrictions. As per the Apple guideline, the below code is required to allow a non-secure network, and the default value is false. For additional details [click here.](https://stackoverflow.com/questions/31216758/how-can-i-add-nsapptransportsecurity-to-my-info-plist-file)
|
\NSAppTransportSecurity\
\
\NSAllowsArbitraryLoads\
\
\
|
| -------------------------------------------------------------------------------------------------------------------------------- |
Click on Info.plist and add the GADApplicationIdentifier key and its value. Refer to the following example: 2
Example 2
GADApplicationIdentifier / AppID value found on AdMob dashboard. First sign in to your AdMob account at [click here](https://apps.admob.com/). Click on Apps on the left panel in the AdMob account and click view all apps. Refer to the following example: 3.
Example 3
Copy App ID that belongs to your app. Refer to the following example: 4.
Example 4
Step 2: **Adding Your Application to Your Pokkt Publisher's Account**
• Create Account and log-in at [http://www.pokkt.com](http://www.pokkt.com/)
• Add your application and get its application Id and Security key.
• Create Screen Ids to be used in AdMob dashboard to set ad source.
This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
Developer needs to create screens in the Pokkt Developer account.
Step 3: **Adding a Custom Event**
1. Sign in to your AdMob account at .
2. Under All apps on the left-hand side, select the app you want to update.
3. Click Mediation on the left navigation menu item
4. Select the mediation group to which POKKT should be added.
| |
| ------------------------------------------------------------------- |
1. Click Custom event under AdSources, and provide the following details:
* **Label**: Enter the name for the custom event. This is used in reporting and cannot be changed later.
* Click Continue and Add class name and Parameters. **Class Name** (**Mandatory**) Enter the name as follows:
|
For Rewarded Video: PokktCustomRewardedVideo
For Interstitial: PokktCustomInterstitial
For Banner: PokktCustomBanner
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1. **Parameter** : Enter a JSON string as below. Screen, App Id and Seckey are mandatory. Rest all are optional.
|
{
"SCREEN":"Screen Created on Pokkt Dashboard",
"APPID":"Pokkt App Id",
"SECKEY":"Pokkt App Security Key",
"TPID":"Unique user id as in your app",
"DBG":”debug value -> true/false”
}
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Step 4**: Test Your Application**
Congratulations - that's it! You may now run your app and see Pokkt ads in action.
It will take around 6 hours time to reflect the changes made in the AdMob dashboard.
**Test Ads**
Application Id : eee33f012ee30473abcda10c65593d97
Security Key : 0adf197193966c9f9c25485154897398
Sample Screen Id for Video : 129fda6f5d8c4f5ea7450ce8b9c94eb8
Sample Screen Id for Interstitial : 3f3d981b416864215563a7ddfecb93f2
Sample Screen Id for Banner : 07d5ffd1766b28cc9b25f99d4b0c22ea
# POKKT SDK Plugins
# Native Android
### Contents
* [1 POKKT Native Android SDK v8.1.0 (GDPR Compliance)](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [2 Getting Started with Pokkt SDK v 8.1.0](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3 Integration Guide v 8.1.0](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.1 Overview](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.2 Project Configuration](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.2.1 Dependencies](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.2.2 Manifest](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.2.2.1 Permissions Declarations](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.2.2.2 Activity Declaration](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3 Implementation Steps](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.1 SDK Configuration](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.2 Ad Types](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.2.1 FullScreen Ads](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.2.2 Banner](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.2.3 Native Ads](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.3 Ad Delegates](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.3.1 FullScreen Ads](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.3.2 Native Ads](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.3.3 Banner](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.4 Pokkt ad player configuration](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.5 User Details](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.6 Pokkt Server Callback Params](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.7 Debugging](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [3.3.8 Proguard](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [4 Migration Note Guide v 8.1.0](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [4.1 Screen ID](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [4.2 AdTypes](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [4.3 Simpler APIs for full screen ads and banner ads.](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [4.4 Ad Delegates are changed. SetDelegate API is removed.](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [4.5 isAdCached API is changed.](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [4.6 Destroy Banner API is changed](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [4.7 Native Ad](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [5 Migration Note Guide v 7.6.0](broken://pages/OJzUhvcbxbvyDepsb9pf)
* [5.1 Note](broken://pages/OJzUhvcbxbvyDepsb9pf)
### POKKT Native Android SDK v8.1.0 (GDPR Compliance)
Last Update: 28th October, 2021
Download Latest Version Here
***
### Getting Started with Pokkt SDK v 8.1.0
1\. Add *"PokktSDK.aar"* to your project.
2\. Set *Application Id* and *Security Key* in Pokkt SDK. You can get it from Pokkt dashboard from your account. These are unique per app registered.
```
PokktAds.setPokktConfig("", "", “”);
```
3\. Set the following to enable or disable omission of Pokkt logs and other informatory messages. Make sure to set it to false before release.
```
PokktAds.Debugging.shouldDebug(“”,);
```
4\. Set GDPR consent in Pokkt SDK. This must be called before calling any ad related API. Developers/Publishers must get the consent from user. For more information on GDPR please refer and . This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting.
```
PokktAds.ConsentInfo consentInfo = new PokktAds.ConsentInfo();
consentInfo.setGDPRApplicable(true);
//true if GDPR is applicable.
consentInfo.setGDPRConsentAvailable(true);
//true if user has given consent to use personal details for ad targeting.
PokktAds.setDataAccessConsent(consentInfo);
```
5\. You can check if Ad is cached or not using
```
PokktAds.isAdCached("");
```
6\. Show FullScreen Ad with one of the following:
```
PokktAds.showAd("",,null);
```
7\. For Banner Ad
* Define a container (PokktBannerView) for banner something like following:
```
```
* To load banner, use:
```
PokktAds.showAd("",,);
```
* Use the following to destroy banner:
```
PokktAds.destroyBanner();
```
8\. Implement *PokktAds.PokktAdDelegate* to listen to fullscreen-ad related messages.\
9\. Implement *PokktAds.BannerAdDelegate* to listen to banner-ad related messages.\
10\. We recommend caching of video-ads for better user experience, you can cache an ad using the following:
```
PokktAds.cacheAd("",);
```
### Integration Guide v 8.1.0
#### Overview
Thank you for choosing Pokkt SDK for Android. This document contains all the information required to set up the SDK with your project. We also support mediation for various third party networks. To know the supported third party networks and their integration process go to mediation section .
Before implementing plugins it is mandatory to go through project configuration and implementation steps, as these sections contain mandatory steps for basic SDK integration and are followed by every plugin.
You can download our SDK from pokkt.com.
Downloaded SDK package will contain:
1. Docs:
* Contains documentations for step wise step integration for SDK.
2. PokktSDK\_v 8.1.0.jar
* Pokkt SDK in *jar* format.
3. PokktSDK\_v 8.1.0.aar
* Pokkt SDK in *aar* format.
4. Pokktsdk360ext.jar / Pokktsdk360ext.aar
* Add these if you want to support 360 video ads.
5. PokktAds Demo
* Source code for *PokktAds Demo*(Sample app) which showcase implementation of Pokkt SDK through code for better understanding.
6. Dependency jars:
* Please add google play services and support-v4 jar.
minSdkVersion supported is 11 .
ScreenId: This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
Developer needs to create screens in Pokkt Developer account.
We will be referencing PokktAds Demo app provided with SDK during the course of explanation in this document. We suggest you go through the sample app for better understanding.
#### Project Configuration
**Dependencies**
* Add *PokktSDK\_v 8.1.0.jar* or *PokktSDK\_v 8.1.0.aar* to your project.
* We expect Google play services integrated in project, although it is optional but we recommend you to integrate it, as it is required to fetch AdvertisingID for device,which is useful to deliver targeted advertising to Android users.
**Manifest**
Android 9.0 (API 28) blocks cleartext (non-HTTPS) traffic by default , which can prevent ads from serving correctly.To mitigate that, publishers whose apps run on Android 9.0 or above should ensure to add a network security config file or you should set the usesCleartextTraffic attribute in your application tag to true. Doing so whitelists cleartext traffic and allows non-HTTPS ads to serve.
```
...
```
**Permissions Declarations**
Add the following permissions to your project manifest
1\. Mandatory permissions.
```
```
* android.permission.INTERNET = Required for SDK communication with server.
* android.permission.ACCESS\_NETWORK\_STATE = Required to detect changes in network, like if WIFI is available or not.
**Activity Declaration**
Add the following activity in your AndroidManifest for Pokkt SDK integration.
```
```
You can change the android:screenOrientation="landscape" to of your choice, the way you want to display the ads.
#### Implementation Steps
**SDK Configuration**
1\. Set Application Id and Security key in Pokkt SDK. You can get it from Pokkt dashboard from your account. These are unique per app registered.
```
PokktAds.setPokktConfig("", "","");
```
2\. If you are using server to server integration with Pokkt, you can also set Third Party UserId in PokktAds.
```
PokktAds.setThirdPartyUserId("");
```
3\. When your application is under development and if you want to see Pokkt logs and other informatory messages, you can enable it by setting shouldDebug to true . Make sure to disable debugging before release.
```
PokktAds.Debugging.shouldDebug(“”,);
```
4\. Set *GDPR consent* in Pokkt SDK. This must be called before calling any ad related API. Developers/Publishers must get the consent from user. For more information on GDPR please refer and . This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting.
```
PokktAds.ConsentInfo consentInfo = new PokktAds.ConsentInfo();
consentInfo.setGDPRApplicable(true);
//true if GDPR is applicable.
consentInfo.setGDPRConsentAvailable(false);
//false if user has given consent to use personal details for ad targeting.
PokktAds.setDataAccessConsent(consentInfo);
```
**Ad Types**
**FullScreen Ads**
* FullScreen Ads are of two types : Video and Interstitial.
* FullScreen ads can be rewarded or non-rewarded.
* FullScreen properties can be configured from the Pokkt dashboard.
* You can either cache the ad in advance or directly call show for it.
* We suggest you cache the ad in advance so as to give seamless play behaviour, In other case it will stream the video which may lead to unnecessary buffering delays depending on the network connection.
1\. To cache FullScreen ad call:
```
PokktAds.cacheAd("",);
```
2\. To show FullScreen ad call:
```
PokktAds.showAd("",,null);
```
3\. You can check if FullScreen ad is cached or not using
```
PokktAds.isAdCached("");
```
* Sample Screen Id for Video : 684ab1e66abeb060faa500136c4c6a74
* Sample Screen Id for Interstitial : 5e59028c8332c9583e742c183abbaafb
* Add PokktBannerView to your layout, we use it as a placeholder to populate banner ads into it.
```
```
* Load banner
```
PokktAds.showAd("",,);
```
* You can remove Banner using:
```
PokktAds.destroyBanner();
```
* Sample Screen Id for Banner : 129cc53b4666f5ae1ebad6a9bc942764
**Native Ads**
A native ad is a type of ad which contains ad assets and developer app displays the ad assets as per the format of the app UI. Normally, FullScreen ads are delivered on call to action by the user. Native ads eliminate this limitation and show ads without any user request.Native ads are also non intrusive as they will be automatically paused when the ad is out of the view by scrolling. A naIve ad may be served in feed or in between the developer content inside the app. The PokktNaIveAdLayout displays the media asset.
* Add Native Ad Layout to your Layout XML. The view hierarchy will be as below. You need to modify these as per your layout design.
```
```
* Request for native Ad.
```
PokktNativeAdConfig pokktNativeAdConfig = new PokktNativeAdConfig();
PokktAds.requestNativeAd(“”, , pokktnativeAdConfig);
```
* Once PokktNativeAd is received in the AdReady callback of NativeAdsDelegate implementaIon, ad assets present in PokktnativeAd should be used to populate the ad UI.
```
PokktNativeAdViewBinder pokktNativeAdViewBinder = new
PokktNativeAdViewBinder.Builder(rootView.findViewById(R.id.pokkt_native_ad_container))
.mediaLayoutId(R.id.pokkt_native_ad)
.ItleId(R.id.pokkt_native_ad_Itle)
.descripIonId(R.id.pokkt_native_ad_body)
.sponsoredTextId(R.id.pokkt_native_ad_sponsored)
.raIngId(R.id.pokkt_native_ad_raIng)
.iconImageId(R.id.pokkt_native_ad_icon)
.callToAcIonId(R.id.pokkt_native_ad_cta)
.priceTextId(R.id.pokkt_native_ad_price)
.likesId(R.id.pokkt_native_ad_likes)
.downloadsId(R.id.pokkt_native_ad_downloads)
.addressId(R.id.pokkt_native_ad_address)
.phoneId(R.id.pokkt_native_ad_number)
.salePriceTextId(R.id.pokkt_native_ad_saleprice)
.build();
pokktNativeAdViewBinder.populateView(pokktNativeAd);
```
* Developers must implement NativeAdsDelegate and supply POKKT SDK in requestNativeAd().
```
PokktAds.NativeAdsDelegate delegate = new PokktAds.NativeAdsDelegate()
{
@Override
public void adReady(screenId,pokktNativeAd) {
}
@Override
public void adFailed(screenId, String errorMessage) {
}
@Override
public void adClosed(String screenId, boolean isComplete) {
}
};
```
* Developers will have to do cleanup of Native Ad in onDestroy of activity life cycle.
```
pokktNativeAd.destroy();
```
Please refer to our Pokkt Ads Demo Source code for sample implementation of Native Ads in List, Scroll and WebView
* Sample Screen Id for Native Ad with Image asset : 377d86e7fae5f5714375824636468a42
* Sample Screen Id for Native Ad with video asset : fad058c08a41ef4506e759bce521bcbb
**Ad Delegates**
**FullScreen Ads**
Ad delegates are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
```
PokktAdDelegate pokktAdDelegate = new PokktAds.PokktAdDelegate() {
@Override
public void adCachingResult(screenId,isSuccess,reward,errorMessage) {
}
@Override
public void adDisplayedResult(screenId,isSuccess,errorMessage) {
}
@Override
public void adClosed(screenId,isComplete) {
}
@Override
public void adGratified(screenId,reward) {
}
@Override
public void adClicked(screenId) {
}
};
```
**Native Ads**
Developers should implement SDK Native Ad delegates and supply POKKT SDK in requestNativeAd().
```
PokktAds.NativeAdsDelegate delegate = new PokktAds.NativeAdsDelegate() {
@Override
public void adReady(screenId,pokktNativeAd) {
}
@Override
public void adFailed(screenId,errorMessage) {
}
@Override
public void adClosed(screenId,isComplete) {
}
};
```
Ad delegates are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
```
PokktAds.BannerAdDelegate adDelegate = new PokktAds.BannerAdDelegate() {
@Override
public void bannerExpanded(screenId) {
}
@Override
public void bannerResized(screenId) {
}
@Override
public void bannerCollapsed(screenId) {
}
@Override
public void adCachingResult(screenId,isSuccess,reward,errorMessage) {
}
@Override
public void adDisplayedResult(screenId,isSuccess,errorMessage) { //called when banner is loaded/failed to load
}
@Override
public void adClosed(screenId,isComplete) {
}
@Override
public void adGratified(screenId,reward) {
}
@Override
public void adClicked(screenId) {
//called when banner is clicked
}
};
```
**Pokkt ad player configuration**
Pokkt Ad player works the way App is configured at Pokkt dashboard, but we provide a way to override those settings using PokktAdViewConfig.
Application should prefer configuration provided through code by developer or what’s configured for the app in dashboard, can be controlled any time through the dashboard itself. If you want to make changes to this configuration after your app distribution, you can contact Pokkt Team to do the same for your app through admin console.
```
PokktAdViewConfig adViewConfig = new PokktAdViewConfig ();
// set properties values to adViewConfig
PokktAds.setAdPlayerViewConfig(adViewConfig );
```
Various setters for the properties that can be managed through this are:
1\. Back button\
Defines if user is allowed to close the Advertisement by clicking on back button or not.\
Setter Name: setBackButtonDisabled(boolean backButtonDisabled)\
Values:\
True = Back button is disabled and user cannot close the Ad.\
False = Back button is not disabled and user can close the Ad.
2\. Default skip time\
Defines the time after which user can skip the Ad.\
Setter name: setDefaultSkipTime(int defaultSkipTime)\
Values:\
Any Integer value.\
Default value is 10 seconds.
3\. Should allow skip\
Defines if user is allowed to skip the Ad or not.\
Setter name: setShouldAllowSkip(boolean shouldAllowSkip)\
Values:\
True = User can skip Ad.\
False = User can’t skip Ad.
4\. Should allow mute\
Defines if user is allowed to mute the Video Ad or not.\
Setter name: setShouldAllowMute(boolean shouldAllowMute)\
Values:\
True = User can mute video Ad.\
False = User can’t mute video Ad.
5\. Should confirm skip\
Defines if confirmation dialog is to be shown before skipping the Ad.\
Setter name: ShouldConfirmSkip\
Values:\
True = Confirmation dialog will be shown before skipping the video.\
False = Confirmation dialog will not be shown before skipping the video.
6\. Skip confirmation message\
Defines what confirmation message to be shown in skip dialog.\
Setter name: setShouldSkipConfirm(boolean shouldSkipConfirm)\
Values:\
Any String message.\
Default value is “Skipping this video will earn you NO rewards. Are you sure?”.
7\. Affirmative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Setter name: setSkipConfirmYesLabel(String skipConfirmYesLabel)\
Values:\
Any String message.\
Default value is “Yes”.
8\. Negative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Setter name: setSkipConfirmNoLabel(String skipConfirmNoLabel)\
Values:\
Any String message.\
Default value is “No”.
9\. Skip timer message\
Defines message to be shown before enabling skip button. Don’t forget to add placeholder “ ## ” in your custom message. This placeholder is replaced by property “Default skip time” assigned above.\
Setter name: setSkipTimerMessage(String skipTimerMessage)\
Values:\
Any String message.\
Default value is “You can skip video in ## seconds”
10\. Incentive message\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Setter name: setIncentiveMessage(String incentiveMessage)\
Values:\
Any String message\
Default value is “more seconds only for your reward !”
11\. Should collect feedback\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name setShouldCollectFeedback\
Values:\
True = If you want to collect feedback from the user for the Ad.\
False = If you don’t want to collect feedback from the user for the Ad.
12\. Audio Enabled\
Provides a medium to disable audio for video ad without user interaction.\
Property name setAudioEnabled\
Values:\
True = If you want to play audio for video ad.\
False = If you don’t want to play audio for video ad.
**User Details**
For better targeting of ads you can also provide user details to our SDK using.
```
PokktUserDetails pokktUserDetails = new PokktUserDetails();
pokktUserDetails.setName(" ");
pokktUserDetails.setAge(" ");
pokktUserDetails.setSex(" ");
pokktUserDetails.setMobileNumber(" ");
pokktUserDetails.setEmailAddress(" ");
pokktUserDetails.setLocation(" ");
pokktUserDetails.setBirthday(" ");
pokktUserDetails.setMaritalStatus(" ");
pokktUserDetails.setFacebookId(" ");
pokktUserDetails.setTwitterHandle(" ");
pokktUserDetails.setEducation(" ");
pokktUserDetails.setNationality(" ");
pokktUserDetails.setEmployment(" ");
pokktUserDetails.setMaturityRating(" ");
PokktAds.setUserDetails(pokktUserDetails);
```
**Pokkt Server Callback Params**
Developer can set some values in POKKT SDK that they need to be sent to their server via POKKT Server callbacks.
```
Map params = new HashMap<>();
params.put("testdata","{\"adnetwork\": \"pokkt\"}");
PokktAds.setCallbackExtraParams(params);
```
**Debugging**
Other than enabling debugging for Pokkt SDK, it can also be used to:
1\. When your application is under development and if you want to see Pokkt logs and other informatory messages, you can enable it by setting shouldDebug to true. Make sure to disable debugging before release.
```
PokktAds.Debugging.shouldDebug(“”,);
```
2\. Export log\
Export your log to your desired location, we generally have it in root directory of SD card, if permission for external storage is provided and in cache folder otherwise.
```
PokktAds.Debugging.exportLog(getActivity());
```
3\. Export log to cloud You can also export log to cloud.
```
PokktAds.Debugging.exportLogToCloud(getActivity());
```
**Proguard**
If you are using proguard in your app, add following rules to your proguard file.
```
# Pokkt SDK
-keep class com.pokkt.** { public *; }
-dontwarn com.pokkt.**
# moat
-keep class com.moat.** { *; }
-dontwarn com.moat.**
-keep class com.c.c.**{*;}
# OM
-keep class com.iab.omid.library.pokkt.**{*;}
-dontwarn com.iab.omid.**
# 360 if Pokktsdk360ext.jar or Pokktsdk360ext.aar is added
-keep class com.pokkt.sdk360ext.** { *; }
# For communication with Pokkt WebView
-keepclassmembers class * {
@android.webkit.JavascriptInterface ;
}
```
### Migration Note Guide v 8.1.0
* In case of any query regarding integration, refer “POKKT\_SDK\_Integration\_Guide(\_v8.1.0\_Native\_Android)” for this version provided inside “PokktSDK\_v8.1.0”.
**Screen ID**
ScreenId is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard. This replaced Screen Name used earlier.
**AdTypes**
Rewarded Video ads and Interstitial Ads are merged into full screen ad type and ad type can be changed in runtime by editing the screen id Ad type.
**Simpler APIs for full screen ads and banner ads.**
```
PokktAds.VideoAd.cacheRewarded("");
PokktAds.VideoAd.cacheNonRewarded("");
PokktAds.Interstitial.cacheRewarded("");
PokktAds.Interstitial.cacheNonRewarded("");
is now
PokktAds.cacheAd("",);
```
```
PokktAds.VideoAd.showRewarded("");
PokktAds.VideoAd.showNonRewarded("");
PokktAds.Interstitial.showRewarded("");
PokktAds.Interstitial.cacheNonRewarded("");
is now
PokktAds.showAd("",,null);
```
```
PokktAds.Banner.loadBanner(“”, );
is now
PokktAds.showAd("",,);
```
**Ad Delegates are changed. SetDelegate API is removed.**
```
PokktAds.VideoAd.setDelegate(new PokktAds.VideoAd.VideoAdDelegate() {
public void videoAdCachingCompleted(String screenName, boolean isRewarded, double reward) {}
public void videoAdCachingFailed(String screenName, boolean isRewarded, String errorMessage) {}
public void videoAdDisplayed(String screenName, boolean isRewarded) {}
public void videoAdFailedToShow(String screenName, boolean isRewarded, String errorMessage) {}
public void videoAdClosed(String screenName, boolean isRewarded) {}
public void videoAdClicked(String screenName, boolean isRewarded){}
public void videoAdSkipped(String screenName, boolean isRewarded) {}
public void videoAdCompleted(String screenName, boolean isRewarded) {}
public void videoAdGratified(String screenName, boolean isRewarded, double reward)
{}
});
is now
PokktAdDelegate pokktAdDelegate = new PokktAds.PokktAdDelegate() {
public void adCachingResult(screenId,isSuccess,reward,errorMessage) { }
public void adDisplayedResult(screenId,isSuccess,errorMessage) { }
public void adClosed(screenId,isComplete) { }
public void adGratified(screenId,reward) { }
public void adClicked(screenId) {} };
```
```
PokktAds.Interstitial.setDelegate(new PokktAds.Interstitial.InterstitialDelegate() {
public void interstitialCachingCompleted(String screenName, boolean isRewarded, double reward) {}
public void interstitialCachingFailed(String screenName, boolean isRewarded, String errorMessage) {}
public void interstitialDisplayed(String screenName, boolean isRewarded) {}
public void interstitialFailedToShow(String screenName, boolean isRewarded, String errorMessage) {}
public void interstitialClosed(String screenName, boolean isRewarded) {}
public void interstitialSkipped(String screenName, boolean isRewarded) {}
public void interstitialClicked(String screenName, boolean isRewarded){}
public void interstitialCompleted(String screenName, boolean isRewarded) {}
public void interstitialGratified(String screenName, boolean isRewarded, double reward) {}
});
is now
PokktAdDelegate pokktAdDelegate = new PokktAds.PokktAdDelegate() {
public void adCachingResult(screenId,isSuccess,reward,errorMessage) { }
public void adDisplayedResult(screenId,isSuccess,errorMessage) { }
public void adClosed(screenId,isComplete) { }
public void adGratified(screenId,reward) { }
public void adClicked(screenId) {} };
```
**isAdCached API is changed.**
```
PokktAds.VideoAd.isAdCached("", );
PokktAds.Interstitial.isAdCached("", );
is now
PokktAds.isAdCached("");
```
```
PokktAds.Banner.destroy();
is now
PokktAds.destroyBanner();
```
**Native Ad**
Native Ads are introduced which replaces OutStream ads. Please refer our documentation for details.
### Migration Note Guide v 7.6.0
**Note**
* In case of any query regarding integration, refer *POKKT\_SDK\_Integration\_Guide(\_v 7.6.0\_Native\_Android)* for this version provided inside PokktSDK\_v 7.6.0.
1\. Removed callbacks\
videoAdAvailabilityStatus and interstitialAvailabilityStatus are removed from the Video and Interstitial ads respectively and so are the checkAdAvailability API.
2\. PokktAdPlayerViewConfig\
PokktAdPlayerViewConfig is renamed to PokktAdViewConfig.
3\. Activity context required in setPokktConfig.
```
PokktAds.setPokktConfig("", "");
is now
PokktAds.setPokktConfig("", "",
“”);
```
4\. Context required in shouldDebug.
```
PokktAds.Debugging.shouldDebug();
is now
PokktAds.Debugging.shouldDebug(“”,);
```
# Native iOS
### Contents
* [1 CocoaPods (preferred)](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [2 Manual download](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [2.1 POKKT Native iOS SDK v8.1.0 (GDPR Compliance)](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [2.2 Pokkt iOS SDK Integration Guide v8.1.0](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [3 SDK Configuration](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [4 Full-Screen Ads](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [5 Banner Ads](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [6 Native Ads](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [7 Display Native Ad](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [8 Additional SDK Configuration](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [8.1 GDPR](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [9 Extra Parameter](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [10 ThirdPartyUser Id](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [11 User Detail](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [12 Pokkt AdPlayer Configuration](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [13 Migration Note Guide v 8.1.0](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [13.1 Screen ID](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [13.2 AdTypes](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [13.3 Simpler APIs for full screen ads and banner ads.](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [13.4 Ad Delegates are changed. SetDelegate API is removed.](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [13.5 Native Ad](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [13.6 isAdCached API is changed](broken://pages/VPaOuTi4FdZj15jrbkmF)
* [13.7 Destroy Banner API is changed](broken://pages/VPaOuTi4FdZj15jrbkmF)
### CocoaPods (preferred)
The simplest way to import the SDK into an iOS project is to use [CocoaPods](https://guides.cocoapods.org/using/getting-started). Open your project's Podfile and add this line to your app's target:
```
pod 'PokktAds'
```
Then from the command line run:
```
pod install
```
If you're new to CocoaPods, see their [official documentation](https://guides.cocoapods.org/using/using-cocoapods) for info on how to create and use Podfiles.
### Manual download
####
Last Update: 29th October, 2021
Download Latest Version Here
***
#### Pokkt iOS SDK Integration Guide v8.1.0
* Download the latest SDK. Here
* Unzip the downloaded file and drag the PokktSDK.framework directory into Xcode under Framework.
* Add the required compiler flags to 'Other Linker Flags' field in your project's Build Settings.
* -ObjC
* -lxml2
* Make sure that these frameworks are included to respect the library dependencies:
* Add Webkit.Framework.
* ARKit.framework
Error creating thumbnail: File missing
### SDK Configuration
1\. Set Application Id and Security key in Pokkt SDK. You can get it from the Pokkt dashboard from your account. We generally assign unique application-id and security-key.
```
[PokktAds setPokktConfigWithAppId:appId securityKey:securityKey];
```
2\. When your application is under development and if you want to see sdk logs and other informatory messages, you can enable it by setting setDebug to true . Make sure to disable debugging before release.
```
[PokktDebugger setDebug:];
```
### Full-Screen Ads
1. Full-screen ads can be rewarded or non-rewarded and video or interstitial. You can either cache the ad in advance or directly call show for it.
2. We suggest you cache the ad in advance so as to give seamless play behaviour, In other case it will stream the video which may lead to unnecessary buffering delays depending on the network connection.
3. Screen-Id: This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard. We will be referencing the PokktAdsDemo app provided with SDK during the course of explanation in this document. We suggest you go through the sample app for better understanding.
4. To cache Full-screen ad call:
```
[PokktAds cacheAd:screenId withDelegate:delegate];
```
5. To Show Video Ad:
```
[PokktAds showAd:screenId withDelegate:delegate presentingVC:viewcontroller];
```
\
You can check if an ad is available, before making a show request.
```
[PokktAds isAdCached:screenId];
```
6. Ad actions are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
```
/** Caching **/
- (void)adCachingResult:(NSString *)screenId
isSuccess:(BOOL)success
withReward:(double)reward
errorMessage:(NSString *)errorMessage;
/** Ad Display **/
- (void)adDisplayResult:(NSString *)screenId
isSuccess:(BOOL)success
errorMessage:(NSString *)errorMessage;
/** Ad Closed **/
- (void)adClosed:(NSString *)screenId adCompleted:(BOOL)adCompleted;
/** Ad Interaction **/
- (void)adClicked:(NSString *)screenId;
- (void)adGratified:(NSString *)screenId withReward:(double)reward;
```
###
1. Load banner Ad call:
```
PokktBannerView *banner = [PokktBanner initWithBannerAdSize:CGRectMake(0, 0, [UIScreen mainScreen].bounds.size.width, 50)];
[self.view addSubview:banner];
[PokktAds showAd:(NSString *)screenId withViewController:(UIViewController *)viewController bannerContainer:(PokktBannerView *)bannerView withDelegate:self];
```
2. Refresh banner: You can set banner refresh rate on pokkt dashboard. Refresh rate should be in range of 30 -100
3. Destroy banner
```
[PokktAds destroyBanner:(PokktBannerView *)bannerContainer];
```
4. Ad actions are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
```
- (void)bannerExpanded:(NSString *)screenId;
- (void)bannerResized:(NSString *)screenId;
- (void)bannerCollapsed:(NSString *)screenId;
```
### Native Ads
1. A native ad may be served in feed or in between the developer content inside the app. Normally, FullScreen ads are delivered on call to action by the user. Native ads eliminate this limitation and show ads without any user request.Native ads are also non intrusive as they will be automatically paused when the ad is out of the view by scrolling. The PokktNativeAdLayout will be part of developer application parent components which may be ListView, Layout in ScrollView or WebView.\
Load Native Ad:
```
[PokktAds requestNativeAd:(NSString *)screenId withDelegate:self withNativeAdConfig:(PokktNativeAdConfig*)nativeAdConfig];
//after calling ’requestNativeAd:withDelegate:’, Inside the -(void)adReady:(NSString *)screenId withNativeAd:(PokktNativeAd *)pokktNativeAd; method you will receive PokktNativeAd object and then extract your ad by calling below method.
UIView *adView = [pokktNativeAd getMediaView];
```
2. Ad actions are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
```
- (void)adReady:(NSString *)screenId withNativeAd:(PokktNativeAd *)pokktNativeAd;
- (void)adFailed
:(NSString *)screenId error:(NSString *)errorMessage;
```
### Display Native Ad
When a native ad loads, your app will receive a native ad object via adReady delegate messages. Your app is then responsible for displaying the ad.
The first step is to create a UIView subclass that will display native ad assets. The class also provides IBOutlets used to register the view used for each individual asset. Below are the header file and nib file format:
```
#import
@interface PokktNativeAdNibView : UIView
@property (weak, nonatomic) IBOutlet UIImageView *iconView;
@property (weak, nonatomic) IBOutlet UILabel *advertizerView;
@property (weak, nonatomic) IBOutlet UIImageView *starRatingView;
@property (weak, nonatomic) IBOutlet UILabel *starRatingLabel;
@property (weak, nonatomic) IBOutlet UILabel *bodyView;
@property (weak, nonatomic) IBOutlet UIButton *callToActionView;
@property (weak, nonatomic) IBOutlet UILabel *priceView;
@property (weak, nonatomic) IBOutlet UILabel *storeView;
@property (weak, nonatomic) IBOutlet UILabel *headlineView;
@property (weak, nonatomic) IBOutlet UIView *mediaView;
@property (weak, nonatomic) IBOutlet UILabel *nativeAd;
@property (weak, nonatomic) IBOutlet UILabel *likeLbl;
@property (weak, nonatomic) IBOutlet UILabel *CTALbl;
@property (weak, nonatomic) IBOutlet UILabel *downloadLbl;
@property (weak, nonatomic) IBOutlet UILabel *saleLbl;
@property (weak, nonatomic) IBOutlet UILabel *phoneNumLbl;
@property (weak, nonatomic) IBOutlet UILabel *address;
@property (weak, nonatomic) IBOutlet UILabel *additionalDescriptive;
@property (weak, nonatomic) IBOutlet UILabel *displayURL;
@end
```
Error creating thumbnail: File missing
Once the layout is complete and the outlets are linked, the last step is to add code to your app that displays an ad once it has loaded. Here's a method to display an ad in the view defined above:
Create a UIView class object in the class where you want to show native ads and pass that object properties to PokktNativeAdViewBinder class.
```
PokktNativeAdNibView *nativeAdView;
```
```
- (void)adReady:(NSString *)screenId withNativeAd:(PokktNativeAd *)pokktNativeAd
{
PokktNativeAdViewBinder *nativeBinder = [[PokktNativeAdViewBinder alloc]
initWithNativeRootView:nativeAdView mediaView:nativeAdView.mediaView
icon:nativeAdView.iconView title:nativeAdView.headlineView
ctaButton:nativeAdView.callToActionView body:nativeAdView.bodyView
sponsor:nativeAdView.advertizerView rating:nativeAdView.starRatingLabel
price:nativeAdView.priceView like:nativeAdView.likeLbl cta:nativeAdView.CTALbl
download:nativeAdView.downloadLbl salePrice:nativeAdView.saleLbl
phoneNumber:nativeAdView.phoneNumLbl address:nativeAdView.address
additionalDescriptive:nativeAdView.additionalDescriptive
displayURL:nativeAdView.displayURL];
[nativeBinder populateView:pokktNativeAd];
[containerView addSubview:nativeAdView];
}
```
Developers will have to do cleanup of Native Ad on viewController deInit.
```
[pokktNativeAd destroy];
```
### Additional SDK Configuration
####
As of May 25th, the General Data Protection Regulation (GDPR) will be enforced in the European Union.
Set *GDPR consent* in Pokkt SDK. This must be called before calling any ad related API. Developers/Publishers must get the consent from user. For more information on GDPR please refer and . This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting
```
PokktConsentInfo *consentInfo = [[PokktConsentInfo alloc] init];
consentInfo.isGDPRApplicable = true;
consentInfo.isGDPRConsentAvailable = false;
[PokktAds setPokktConsentInfo:consentInfo];
```
###
You can set extra parameters to POKKT SDK, to be passed back to your server via POKKT server callback. These Extra parameters will be in key-value pair.The key must be alphanumeric value. See the below example
```
NSMutableDictionary *dict = [[NSMutableDictionary alloc] initWithCapacity:0];
[dict setValue:@"value1" forKey:@"key1"];
[dict setValue:@"value2" forKey:@"key2"];
[dict setValue:@"value3" forKey:@"key3"];
[PokktAds setCallbackExtraParam:dict];
```
### ThirdPartyUser Id
If you are using server to server integration with Pokkt, you can also set Third Party UserId in PokktAds.
```
PokktAds.setThirdPartyUserId:(NSString*) userId
```
### User Detail
For better targeting of ads you can also provide user details to our SDK using
```
PokktUserDetails *pokktUserDetails = [PokktUserDetails alloc] init];
pokktUserDetails.Name = "";
pokktUserDetails.Age = "";
pokktUserDetails.Sex = "";
pokktUserDetails.MobileNo = "";
pokktUserDetails.EmailAddress = "";
pokktUserDetails.Location = "";
pokktUserDetails.Birthday = "";
pokktUserDetails.MaritalStatus = "";
pokktUserDetails.FacebookId = "";
pokktUserDetails.TwitterHandle = "";
pokktUserDetails.Education = "";
pokktUserDetails.Nationality = "";
pokktUserDetails.Employment = "";
pokktUserDetails.MaturityRating = "";
[PokktAds setPokktUserDetails: pokktUserDetails]
```
### Pokkt AdPlayer Configuration
Pokkt Ad player works the way App is configured at Pokkt dashboard, but we provide a way to override those settings using PokktAdPlayerViewConfig.
Application should prefer configuration provided through code by developer or what’s configured for the app in dashboard, can be controlled any time through the dashboard itself. If you want to make changes to this configuration after your app distribution, you can contact Pokkt Team to do the same for your app through admin console.
```
PokktAdPlayerViewConfig * adPlayerViewConfig = [[PokktAdPlayerViewConfig alloc] init];
// set properties values to adPlayerViewConfig
PokktAds.setAdPlayerViewConfig(adPlayerViewConfig );
```
Various properties that can be managed through this are:
1\. Default skip time\
Defines the time after which user can skip the Ad.\
Property name: DefaultSkipTime\
Values:\
Any Integer value.\
Default value is 10 seconds.
2\. Should allow skip\
Defines if user is allowed to skip the Ad or not.\
Property name: ShouldAllowSkip\
Values:\
True = User can skip Ad.\
False = User can’t skip Ad.
3\. Should allow mute\
Defines if user is allowed to mute the Video Ad or not.\
Property name: ShouldAllowMute\
Values:\
True = User can mute video Ad.\
False = User can’t mute video Ad.
4\. Should confirm skip\
Defines if confirmation dialog is to be shown before skipping the Ad.\
Property name: ShouldConfirmSkip\
Values:\
True = Confirmation dialog will be shown before skipping the video.\
False = Confirmation dialog will not be shown before skipping the video.
5\. Skip confirmation message\
Defines what confirmation message to be shown in skip dialog.\
Property name: SkipConfirmMessage\
Values:\
Any String message.\
Default value is “Skipping this video will earn you NO rewards. Are you sure?”.
6\. Affirmative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Property name: SkipConfirmYesLabel\
Values:\
Any String message.\
Default value is “Yes”.
7\. Negative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Property name: SkipConfirmNoLabel\
Values:\
Any String message.\
Default value is “No”.
8\. Skip timer message\
Defines message to be shown before enabling skip button. Don’t forget to add placeholder “ ## ” in your custom message. This placeholder is replaced by property “Default skip time” assigned above.\
Property name: setSkipTimerMessage\
Values:\
Any String message.\
Default value is “You can skip video in ## seconds”
9\. Incentive message\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name: setIncentiveMessage\
Values:\
Any String message\
Default value is “more seconds only for your reward !”
10\. AudioEnabled\
AudioEnabled set YES or NO to mute ad,if 'YES' ad will be mute. , default is NO.\
Property name: isAudioEnabled\
Values:\
True = If you want to mute Ad.\
False = If you don’t want to mute Ad.
11\. Should collect feedback\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name setShouldCollectFeedback\
Values:\
True = If you want to collect feedback from the user for the Ad.\
False = If you don’t want to collect feedback from the user for the Ad.
### Migration Note Guide v 8.1.0
* In case of any query regarding integration, refer “PokktSDK Integration Guide (iOS, v8.1.0)” for this version provided inside “PokktSDK\_v8.1.0”.
**Screen ID**
ScreenId is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard. This replaced Screen Name used earlier.
**AdTypes**
Rewarded Video ads and Interstitial Ads are merged into full screen ad type and ad type can be changed in runtime by editing the screen id Ad type.
**Simpler APIs for full screen ads and banner ads.**
```
[PokktVideoAds cacheRewardedVideoAd: (NSString*) screenName];
[PokktVideoAds cacheNonRewardedVideoAd: (NSString*) screenName];
[PokktInterstitial cacheRewarded (NSString*) screenName];
[PokktInterstitial cacheNonRewarded: (NSString*) screenName];
is now
[PokktAds cacheAd:screenId withDelegate:delegate];
```
```
[PokktVideoAds showRewardedVideoAd:(NSString*) screenName
viewController:(UIViewController*)viewController];
[PokktVideoAds showNonRewardedVideoAd:(NSString*)
screenName viewController:(UIViewController*)viewController];
[PokktInterstitial showRewarded :(NSString*)
screenName viewController:(UIViewController *)viewController];
[PokktInterstitial showNonRewarded :(NSString*)
screenName viewController:(UIViewController *)viewController];
is now
[PokktAds showAd:screenId withDelegate:delegate presentingVC:viewcontroller];
```
```
[PokktBanner loadBanner:banner withScreenName:(NSString*) screenName
rootViewContorller:(PokktBannerView *)bannerView];
is now
UIView *banner = [UIView initWithFrame:CGRectMake(0, 0, [UIScreen mainScreen].bounds.size.width, 50)];
[self.view addSubview:banner];
[PokktAds showAd:screenTF.text withDelegate:self
inContainer:banner];
```
**Ad Delegates are changed. SetDelegate API is removed.**
```
[PokktVideoAdsDelegate setPokktVideoAdsDelegate:self];
- (void)videoAdCachingCompleted: (NSString *)screenName isRewarded: (BOOL)isRewarded reward:
(float)reward;
- (void)videoAdCachingFailed: (NSString *)screenName isRewarded: (BOOL)isRewarded errorMessage: (NSString
*)errorMessage;
- (void)videoAdCompleted: (NSString *)screenName isRewarded: (BOOL)isRewarded;
- (void)videoAdDisplayed: (NSString *)screenName isRewarded: (BOOL)isRewarded;
- (void)videoAdClicked: (NSString *)screenName isRewarded: (BOOL)isRewarded;
- (void)videoAdGratified: (NSString *)screenName reward:(float)reward;
- (void)videoAdSkipped: (NSString *)screenName isRewarded: (BOOL)isRewarded;
- (void)videoAdClosed:(NSString *)screenName isRewarded: (BOOL)isRewarded;
- (void)videoAdFailedToShow: (NSString *)screenName isRewarded: (BOOL)isRewarded errorMessage: (NSString
*)errorMessage;
is now
- (void)adCachingResult:(NSString *)screenId
isSuccess:(BOOL)success
withReward:(double)reward
errorMessage:(NSString *)errorMessage;
- (void)adDisplayResult:(NSString *)screenId
isSuccess:(BOOL)success
errorMessage:(NSString *)errorMessage;
- (void)adClosed:(NSString *)screenId
adCompleted:(BOOL)adCompleted;
- (void)adClicked:(NSString *)screenId;
- (void)adGratified:(NSString *)screenId
withReward:(double)reward;
- (void)adReady:(NSString *)screenId
withNativeAd:(PokktNativeAd *)pokktNativeAd;
- (void)adFailed:(NSString *)screenId
error:(NSString *)errorMessage;
```
```
[PokktInterstitial setPokktInterstitialDelegate:self];;
- (void)interstitialCachingCompleted: (NSString *)screenName isRewarded: (BOOL)isRewarded reward:
(float)reward;
- (void)interstitialCachingFailed: (NSString *)screenName isRewarded: (BOOL)isRewarded errorMessage:
(NSString *)errorMessage;
- (void)interstitialCompleted: (NSString *)screenName isRewarded: (BOOL)isRewarded;
check
- (void)interstitialDisplayed: (NSString *)screenName isRewarded: (BOOL)isRewarded;
- (void)interstitialClicked: (NSString *)screenName isRewarded: (BOOL)isRewarded;
- (void)interstitialGratified: (NSString *)screenName reward:(float)reward;
- (void)interstitialSkipped: (NSString *)screenName isRewarded: (BOOL)isRewarded;
- (void)interstitialClosed:(NSString *)screenName isRewarded: (BOOL)isRewarded;
- (void)interstitialFailedToShow: (NSString *)screenName isRewarded: (BOOL)isRewarded errorMessage:
(NSString *)errorMessage;
is now
- (void)adCachingResult:(NSString *)screenId
isSuccess:(BOOL)success
withReward:(double)reward
errorMessage:(NSString *)errorMessage;
- (void)adDisplayResult:(NSString *)screenId
isSuccess:(BOOL)success
errorMessage:(NSString *)errorMessage;
- (void)adClosed:(NSString *)screenId
adCompleted:(BOOL)adCompleted;
- (void)adClicked:(NSString *)screenId;
- (void)adGratified:(NSString *)screenId
withReward:(double)reward;
- (void)adReady:(NSString *)screenId
withNativeAd:(PokktNativeAd *)pokktNativeAd;
- (void)adFailed:(NSString *)screenId
error:(NSString *)errorMessage;
```
**Native Ad**
Native Ads are introduced which replaces OutStream ads. Please refer to our documentation for details.
**isAdCached API is changed**
```
[PokktVideoAds isAdCached:(NSString *)screenName isRewarded:(BOOL)isRewarded];
[PokktInterstitial
isAdCached:(NSString *)screenName isRewarded:(BOOL)isRewarded];
is now
[PokktAds isAdCached:screenId];
```
```
[PokktBanner destroyBanner:];
is now
[PokktAds dismissAd: screenId];
```
# Native TvOS
### Contents
* [1 Pokkt SDK for tvOS (v4.0) Integration Guide](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2 Getting Started with Pokkt SDK v4.0](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.1 Pokkt SDK for tvOS Integration Guide v4.0](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.1.1 Overview](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.2 Project Configuration](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.2.1 Dependencies](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3 Implementation Steps.](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.1 SDK Configuration](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.2 Ad Types](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.2.1 Video](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.2.2 Rewarded](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.2.3 Non Rewarded](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.3 Ad Delegates](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.3.1 Video](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.4 OutStream Ads](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.5 Pokkt ad player configuration](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.6 User Details](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.7 Debugging](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.8 Analytics](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.8.1 Google Analytics](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.8.2 Flurry Analytics](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.8.3 MixPanel Analytics](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.8.4 Fabric Analytics](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.9 IAP(In App Purchase)](broken://pages/I33nAKybuVsSoqlK3l5n)
* [2.3.10 Limitation](broken://pages/I33nAKybuVsSoqlK3l5n)
### Pokkt SDK for tvOS (v4.0) Integration Guide
Last Update: 11th February, 2019
Download Latest Version Here with PDF Documentation v4.0.
***
### Getting Started with Pokkt SDK v4.0
1\. Add *"PokktSDK.framework"* to your project.
2\. Set *Application Id* and *Security Key* in Pokkt SDK. You can get it from Pokkt dashboard from your account. These are unique per app registered.
```
[PokktAds setPokktConfigWithAppId:(NSString*)appId
securityKey:(NSString*)securityKey];
```
3\. Set the following to enable or disable omission of Pokkt logs and other informatory messages. Make sure to set it to false before release.
```
[PokktDebugger setDebug:[YES/NO]];
```
4\. Show Video Ad with one of the followings:
```
[PokktVideoAds showRewardedVideoAd:(NSString*) screenName
viewController:(UIViewController *)viewController];
[PokktVideoAds showNonRewardedVideoAd:(NSString*) screenName
viewController:(UIViewController *)viewController];
```
5\. Implement *\[PokktVideoAdsDelegate setPokktVideoAdsDelegate:]* to listen to video-ad related messages.
***
#### Pokkt SDK for tvOS Integration Guide v4.0
**Overview**
Thank you for choosing Pokkt SDK for iOS. This document contains all the information required to set up the SDK with your project. Before implementing it is mandatory to go through project configuration and implementation steps , as these sections contain mandatory steps for basic SDK integration.
You can download our SDK from pokkt.com.
In the package downloaded above you will find::
1. Docs
* Contains documentations for step wise step integration for SDK.
2. PokktAds Demo
* Source code for *PokktAds Demo*(Sample app) which showcase implementation of Pokkt SDK through code for better understanding.
3. PokktSDK
* *PokktSDK.framework* add in to your project
ScreenName: This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
We will be referencing PokktAds Demo app provided with SDK during the course of explanation in this document. We suggest you go through the sample app for better understanding.
#### Project Configuration
**Dependencies**
* Add PokktSDK.framework to your project’s settings at “Build Phases -> Link Binary with Libraries and add the PokktSDK.framework.
Frameworks Required
```
CoreData.framework
Foundation.framework
MediaPlayer.framework
SystemConfiguration.framework
UIKit.framework
CoreTelephony.framework
EventKit.framework
AdSupport.framework
CoreGraphics.framework
CoreMotion.framework
MessageUI.framework
EventKitUI.framework
CoreLocation.framework
AVFoundation.framework
libc++.tbd
```
Info.plist
Add the below exceptions to your application’s info.plist.
```
NSAppTransportSecurityNSExceptionDomainspokkt.comNSIncludesSubdomainsNSExceptionAllowsInsecureHTTPLoadsNSExceptionRequiresForwardSecrecyNSExceptionMinimumTLSVersionTLSv1.2NSThirdPartyExceptionAllowsInsecureHTTPLoadsNSThirdPartyExceptionRequiresForwardSecrecyNSThirdPartyExceptionMinimumTLSVersionTLSv1.2NSRequiresCertificateTransparencycloudfront.netNSIncludesSubdomainsNSExceptionAllowsInsecureHTTPLoadsNSExceptionRequiresForwardSecrecyNSExceptionMinimumTLSVersionTLSv1.2NSThirdPartyExceptionAllowsInsecureHTTPLoadsNSThirdPartyExceptionRequiresForwardSecrecyNSThirdPartyExceptionMinimumTLSVersionTLSv1.2NSRequiresCertificateTransparency
```
Other Settings
* Please make sure that your app project has *-ObjC* set as Other linker flag in Build Settings.
***
#### Implementation Steps.
**SDK Configuration**
1\. Set Application Id and Security key in Pokkt SDK. You can get it from Pokkt dashboard from your account. We generally assign unique application Id and Security key.
```
PokktAds.setPokktConfigWithAppId:(NSString*) appId securityKey:(NSString*)securityKey
```
2\. If you are using server to server integration with Pokkt, you can also set Third Party UserId in PokktAds.
```
PokktAds.setThirdPartyUserId:(NSString*) userId
```
3\. When your application is under development and if you want to see Pokkt logs and other informatory messages, you can enable it by setting shouldDebug to true . Make sure to disable debugging before release.
```
[PokktDebugger setDebug: YES/ NO];
```
**Ad Types**
**Video**
* Video ad can be rewarded or non-rewarded. You can directly call show for it.
* it will stream the video which may lead to buffering delays depending on the network connection.
**Rewarded**
1. To show rewarded ad call:
```
[PokktVideoAds showRewardedVideoAd:(NSString*) screenName viewController:(UIViewController *)viewController];
```
**Non Rewarded**
1. To show non-rewarded ad call:
```
[PokktVideoAds showNonRewardedVideoAd:(NSString*) screenName viewController:(UIViewController *)viewController];
```
**Ad Delegates**
Ad actions are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
**Video**
```
[PokktVideoAdsDelegate setPokktVideoAdsDelegate:self];
```
**OutStream Ads**
1. OutStream ad will be non-rewarded only.
2. Ad will play only if Ad is visible in bound, if it is not visible on the screen it will in pause state.
3. OutStream Ad contain 3 states as Play, Pause & Replay. After completing the video Replay button will be enable.
4. If You are requesting for full screen ad then you have to destroy OutStream ad.
5. OutStream Ad allows only for the following format.
* ScrollView
1. Load OutStream Ad Call:
```
+(void)loadOutstreamAd:(NSString*) screenName placeHolder:(UIView *)container scrollView:(UIScrollView *)scrollView withDelegate: (PokktOutStreamsAdsDelegate*) delegate
```
2. Destroy OutStream Ad Call:
```
+(void)disappearScrollViewOutStreamAd:(NSString *)screenName inContainer:(UIView *)container
```
* Tableview
1. Load Ad
```
+(void)loadOutstreamAd:(NSString*) screenName atIndexPath:(NSIndexPath*)indexPath tableView:(UITableView *)tableView withDelegate:(PokktOutStreamsAdsDelegate*) delegate
```
2. Destroy Ad
```
+(void)disappearTableViewOutStreamAd:(NSString *)screenName inContainer:(UITableView *)tableView
```
**Pokkt ad player configuration**
Pokkt Ad player works the way App is configured at Pokkt dashboard, but we provide a way to override those settings using PokktAdPlayerViewConfig.
Application should prefer configuration provided through code by developer or what’s configured for the app in dashboard, can be controlled any time through the dashboard itself. If you want to make changes to this configuration after your app distribution, you can contact Pokkt Team to do the same for your app through admin console.
```
PokktAdPlayerViewConfig * adPlayerViewConfig = [[PokktAdPlayerViewConfig alloc] init];
// set properties values to adPlayerViewConfig
PokktAds.setAdPlayerViewConfig(adPlayerViewConfig );
```
Various properties that can be managed through this are:
1\. Default skip time\
Defines the time after which user can skip the Ad.\
Property name: DefaultSkipTime\
Values:\
Any Integer value.\
Default value is 10 seconds.
2\. Should allow skip\
Defines if user is allowed to skip the Ad or not.\
Property name: ShouldAllowSkip\
Values:\
True = User can skip Ad.\
False = User can’t skip Ad.
3\. Should allow mute\
Defines if user is allowed to mute the Video Ad or not.\
Property name: ShouldAllowMute\
Values:\
True = User can mute video Ad.\
False = User can’t mute video Ad.
4\. Should confirm skip\
Defines if confirmation dialog is to be shown before skipping the Ad.\
Property name: ShouldConfirmSkip\
Values:\
True = Confirmation dialog will be shown before skipping the video.\
False = Confirmation dialog will not be shown before skipping the video.
5\. Skip confirmation message\
Defines what confirmation message to be shown in skip dialog.\
Property name: SkipConfirmMessage\
Values:\
Any String message.\
Default value is “Skipping this video will earn you NO rewards. Are you sure?”.
6\. Affirmative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Property name: SkipConfirmYesLabel\
Values:\
Any String message.\
Default value is “Yes”.
7\. Negative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Property name: SkipConfirmNoLabel\
Values:\
Any String message.\
Default value is “No”.
8\. Skip timer message\
Defines message to be shown before enabling skip button. Don’t forget to add placeholder “ ## ” in your custom message. This placeholder is replaced by property “Default skip time” assigned above.\
Property name: setSkipTimerMessage\
Values:\
Any String message.\
Default value is “You can skip video in ## seconds”
9\. Incentive message\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name: setIncentiveMessage\
Values:\
Any String message\
Default value is “more seconds only for your reward !”
10\. Should collect feedback\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name setShouldCollectFeedback\
Values:\
True = If you want to collect feedback from the user for the Ad.\
False = If you don’t want to collect feedback from the user for the Ad.
**User Details**
For better targeting of ads you can also provide user details to our SDK using.
```
PokktUserDetails *pokktUserDetails = [PokktUserDetails alloc] init];
pokktUserDetails.Name = "";
pokktUserDetails.Age = "";
pokktUserDetails.Sex = "";
pokktUserDetails.MobileNo = "";
pokktUserDetails.EmailAddress = "";
pokktUserDetails.Location = "";
pokktUserDetails.Birthday = "";
pokktUserDetails.MaritalStatus = "";
pokktUserDetails.FacebookId = "";
pokktUserDetails.TwitterHandle = "";
pokktUserDetails.Education = "";
pokktUserDetails.Nationality = "";
pokktUserDetails.Employment = "";
pokktUserDetails.MaturityRating = "";
[PokktAds setPokktUserDetails: pokktUserDetails]
```
**Debugging**
Other than enabling debugging for Pokkt SDK, it can also be used to:
**Analytics**
We support various analytics in Pokkt SDK.
Below is mentioned how to enable various analytics with Pokkt SDK.
**Google Analytics**
Google analytics Id can be obtained from Google dashboard.
```
PokktAnalyticsDetails *analyticsDetail = [[PokktAnalyticsDetails alloc] init];
analyticsDetail.eventType = GOOGLE_ANALYTICS;
analyticsDetail.googleTrackerID = @"xyz";
[PokktAds setPokktAnalyticsDetail:analyticsDetail];
```
**Flurry Analytics**
Flurry application key can be obtained from Flurry dashboard.
```
PokktAnalyticsDetails *analyticsDetail = [[PokktAnalyticsDetails alloc] init];
analyticsDetail.eventType = FLURRY_ANALYTICS;
analyticsDetail.flurryTrackerID = @"xyz";
[PokktAds setPokktAnalyticsDetail:analyticsDetail];
```
**MixPanel Analytics**
MixPanel project token can be obtained from MixPanel dashboard.
```
PokktAnalyticsDetails *analyticsDetail = [[PokktAnalyticsDetails alloc] init];
analyticsDetail.eventType = MIXPANNEL_ANALYTICS;
analyticsDetail.mixPanelTrackerID = @"xyz";
[PokktAds setPokktAnalyticsDetail:analyticsDetail];
```
**Fabric Analytics**
Analytics Id is not required in case of Fabric.
```
PokktAnalyticsDetails *analyticsDetail = [[PokktAnalyticsDetails alloc] init];
analyticsDetail.eventType = FABRIC_ANALYTICS;
analyticsDetail.fabricTrackerID = @"xyz";
[PokktAds setPokktAnalyticsDetail:analyticsDetail];
```
**IAP(In App Purchase)**
Call trackIAP to send any In App purchase information to Pokkt.
```
InAppPurchaseDetails * inAppPurchaseDetails = [ InAppPurchaseDetails alloc]init];
inAppPurchaseDetails.ProductId = "";
inAppPurchaseDetails.PurchaseData = "";
inAppPurchaseDetails.PurchaseSignature = "";
inAppPurchaseDetails.PurchaseStore = IAPStoreType.GOOGLE;
inAppPurchaseDetails.Price = <100.00>;
[PokktAds trackIAP: inAppPurchaseDetails]
```
**Limitation**
* Any web-enabled ad content is not supported, such as MRAID/VPAID/HTML ads etc.
* Currently caching for video/images is not possible.
* There is no close-button for video, start & end cards.
* No mute-button for video ads.
# Native Windows Phone
### Contents
* [1 Pokkt SDK v1.0 for Windows Phone 8.1 Integration Guide](broken://pages/k0zcRgrLB5RGqG7iJVmD)
* [1.1 Introduction:](broken://pages/k0zcRgrLB5RGqG7iJVmD)
* [1.2 Installation:](broken://pages/k0zcRgrLB5RGqG7iJVmD)
* [1.3 Code Integration:](broken://pages/k0zcRgrLB5RGqG7iJVmD)
* [1.3.1 Implementation Steps](broken://pages/k0zcRgrLB5RGqG7iJVmD)
* [1.3.1.1 Common:](broken://pages/k0zcRgrLB5RGqG7iJVmD)
* [1.3.1.2 Session:](broken://pages/k0zcRgrLB5RGqG7iJVmD)
* [1.3.1.3 Video:](broken://pages/k0zcRgrLB5RGqG7iJVmD)
* [1.3.1.4 Optional Parameters:](broken://pages/k0zcRgrLB5RGqG7iJVmD)
* [1.4 Video-ad Functionalities:](broken://pages/k0zcRgrLB5RGqG7iJVmD)
* [1.5 Debugging and Logging](broken://pages/k0zcRgrLB5RGqG7iJVmD)
### Pokkt SDK v1.0 for Windows Phone 8.1 Integration Guide
Last Update: July 31, 2015
Download Latest Version Here v3.0.0.
***
#### Introduction:
Thank you for choosing Pokkt SDK for Windows Phone 8.1. This document contains all the information that is needed by you to setup the SDK with your project.
There is a sample app provided along with the SDK. We will be referencing to this app during the course of explanation in this document. It is suggested that you examine that app to understand the following process in detail. We assume that you are using Visual Studio 2013.
You can download our sample app (PokktSampleApp) on your Windows Phone 8.1 device. Follow the link mentioned below:
***
#### Installation:
The SDK comes in a zip file: PokktSDK\_1.0\_WP81.zip
Once you extract it, you will find two folders inside:
a. SDK
b. SampleApp
The ‘SDK’ folder contains the main SDK library (PokktSDK.dll) along with supporting files. You will be using these for your project. Add PokktSDK.dll in your project Reference.
The ‘SampleApp’ folder contains the Visual Studio 2013 solution (.sln) and project for the sample app, along with the source. You will be using this as reference.
Important: Please do not copy the code snippets from this PDF file as it may introduce unwanted characters and space in your code. Instead always refer to the sample app source code provided.
***
#### Code Integration:
**Implementation Steps**
**Common:**
1. For all invocation of Pokkt SDK functionalities, the developer will make use of methods available in `PokktManager` class. This is a static class, thus, have static methods only.
2. Make sure to call `PokktManager`.`InitPokkt` method before you make any other method calls, except session related methods (`PokktManager.StartSession` or `EndSession`).
3. Make note of `PokktConfig` class! This holds all the values required by the SDK which you will be assigning to it. Then you will have to provide a properly filled instance of `PokktConfig` for almost every method calls that you will be making.
4. In `PokktConfig`, you must assign the `ApplicationId, SecurityKey and IntegrationType`. These values are must for all type of integration.
5. If you are doing a server-to-server integration with Pokkt, you can also mention `ThirdPartyUserId` in `PokktConfig`.
6. Apart from above mentioned values/parameters, you can assign additional value/parameters based on your integration type.
7. During the course of development, you can call `PokktManager.SetDebug(true)` to omit the SDK debug logs. Make sure to set it `false` for production build.
**Session:**
1. You should call `PokktManager`.`StartSession` at the start of your application and once only. You will have to provide your duly assigned PokktConfig object/instance for this method.
2. You should call `PokktManager`.`EndSession` at the end of your application and once only.
**Video:**
1. These are video-ad related values/parameters that you can set:
* `AutoCacheVideo`: You can set it to true/false to control video caching on user’s device. If you set it to true, the video will be cached automatically. Set it to false to disable auto-caching of video, but you have to manually call `PokktManager.CacheVideoCampaign` to cache the available video campaign.This is set to ‘true’ by default.
* `DefaultSkipTime`: Set this value (in seconds) to make it compulsory for a user to watch a video-ad for the given amount of time you have mentioned.A user then, may be able to skip the remaining video-ad if there is a ‘skip’ button available. It is recommended to set it to 10 or less.
* `SkipEnabled`: You can set it to true/false to show a ‘skip’ button over the video. A user can click this to skip the video-ad playback. You can control the time when you want to show it by setting above mentioned `DefaultSkipTime` parameter.
* `BackButtonDisabled`: You can disabled the device’s back-button by setting this false, while the video-ad playback is it progress.
* `ScreenName`: It has a default value ‘default’. It can be used by you to give different screen-name for different locations in your app where you want to show video-ads. You will control ad-targeting based on these screen-names which should match exactly with the screen-names defined in the Dashboard. Screen-names cannot contains whitespaces and only allowed special characters are: ‘hyphen’ and ‘underscores’.
* `Incentivised`: Set this value to ‘true/false’ to control the incentives that are being presented to the user after watching a video-ad. Video Gratification will happen only if you have set it to ‘true’.
2. You will need to listen to the events mentioned in `VideoCampaignDelegate` to get all video-campaign related messages. This is discussed further is this document.
3. You can call `PokktManager.IsVideoAvailable` to check whether a video is available ‘locally’ for playback or not.
4. In order to play an available video, you have to call `PokktManager.PlayVideo`. You will have to provide your duly filled `PokktConfig` instance along with a reference to the `Page` control. This `Page` control will act as a parent container for the video.
**Optional Parameters:**
`PokktConfig` also has provision for developers to provide extra user data available with them to pokkt.We currently support following data points: name, age, sex, mobileNo, emailAddress, location, birthday, maritalStatus, facebookId, twitterHandle, education, nationality, employment and maturityRating.
***
#### Video-ad Functionalities:
There are 7 events to manage the video caching and its playback, these are:
1. VideoClosedEvent
2. VideoDisplayedEvent
3. VideoSkippedEvent
4. VideoCompletedEvent
5. VideoGratifiedEvent
6. DownloadCompletedEvent
7. DownloadFailedEvent
Reference on how to consume them:
```
VideoCampaignDelegate.DownloadCompletedEvent += (float vc)
{
};
VideoCampaignDelegate.DownloadFailedEvent += (string message)
{
};
VideoCampaignDelegate.VideoDisplayedEvent += ()
{
};
VideoCampaignDelegate.VideoCompletedEvent += ()
{
};
VideoCampaignDelegate.VideoClosedEvent += (bool backPress)
{
};
VideoCampaignDelegate.VideoSkippedEvent += ()
{
};
VideoCampaignDelegate.VideoGratifiedEvent += (VideoResponse response)
{
string coins = response.Coins;
};
```
Remarks:
A video file is cached on user’s device. You can set the auto-caching option in the beginning, as mentioned earlier in this document. In case of manual caching, call the following to start video caching: PokktManager.CacheVideoCampaign(pokktConfig);
Before playing video or showing button to play video, Application should check whether video is cached or not by calling the following: PokktManager.IsVideoAvailable();
You should listen to “DownloadCompletedEvent” to check whether download is completed or not, you can show the play buttons once you receive this event.\
Furthermore, Application can decide to play video as incentivised (user will be gratified after watching complete video) or non- incentivised (user will not be gratified after watching complete video). You must provide the screen-name parameter for it. Followings are the method calls to me made:
```
pokktConfig.Incentivised = true/false;
pokktConfig.ScreenName = "your_screen_name";
PokktManager.PlayVideo(pokktConfig, containerPage);
```
Next, you can listen to `VideoGratifiedEvent` to get the coins earned, if at all, by watching the last video.
***
#### Debugging and Logging
You can enable the SDK logs by setting the debugging option to true anytime. Ref.: `PokktManager.SetDebug(true/false);` You can use the following command to log some debug messages: `Logger.Log("pokkt init...");`
Export Log File:
In order to export the log file generated by the SDK, two utility methods have been provided:
1. PokktManager.ExportLogFile();
2. PokktManager.FinishExportingLogFile(file); // file is StorageFile
You have to use these two in continuation. The first method is straightforward. When you call the `PokktManager.ExportLogFile()`, you are presented with a `FileSavePicker` message-box, select the desired location where you want to save the file and confirm it. Once you confirm, you will arrive at your application again and inside your app-entry class, override its `OnActivated` method and access the eventargs parameter of this method. You will find a `StorageFile` object inside it. Take this and pass it to the second method mentioned above: `PokktManager.FinishExportingLogFile(file)`. Code Snippet:
```
protected override void OnActivated(IActivatedEventArgs args)
{
base.OnActivated(args);
try
{
FileSavePickerContinuationEventArgs fsArgs =
args as FileSavePickerContinuationEventArgs;
if (fsArgs != null)
{
StorageFile file = fsArgs.File;
PokktManager.FinishExportingLogFile(file); // file is StorageFile
}
}
catch (Exception e)
{
Logger.LogNoSave("failed to save file: " + e);
}
}
```
Please check the implementation inside the provided SampleApp for better understanding of it.
Clearing Log File: You can call `PokktManager.ClearLogFile()` to clear the log file.
# Unity3D
### Contents
* [1 POKKT SDK v8.1.0 (GDPR Compliance) Unity3d](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2 Integration Guide v8.1.0](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.1 Overview](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.2 Implementation Steps](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.2.1 SDK Configuration](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.2.2 Ad Types](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.2.2.1 FullScreen Ads](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.2.2.2 Banner](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.2.2.3 IGA (In Game Ad)](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.2.2.3.1 Types of Ads:](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.2.2.3.2 How to use InGame Ad Units:](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.2.2.3.3 Note:](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.3 Additional SDK Configuration](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.3.1 GDPR](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.3.2 ThirdPartyUser Id](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.3.3 Pokkt ad player configuration](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.3.4 User Details](broken://pages/pLWq8Riv5Yz078FNg3Ga)
* [2.3.5 iOS Framework and build settings configuration](broken://pages/pLWq8Riv5Yz078FNg3Ga)
###
Last Update: 10th December, 2021
Download Latest Version Here.
***
### Integration Guide v8.1.0
#### Overview
Thank you for choosing Pokkt SDKfor Unity. This document contains all the information required to set up the SDK with your project. We also support mediation for various third party networks. To know the supported third party networks and their integration process go to mediation section .
You can download our SDK from pokkt.com
We will be referencing PokktAds Demo( Sample App ) provided inside the SDK downloaded above during the course of explanation in this document. We suggest you go through the sample app for better understanding.
***
#### Implementation Steps
**SDK Configuration**
1. Set Application Id and Security key in Pokkt SDK. You can get it from the Pokkt dashboard from your account. We generally assign unique application-id and security-key.
```
PokktAds.SetPokktConfig(string appId, string securityKey, INativeExtension nativeExtension, bool isDebuggingEnabled = false);
```
2. When your application is under development and if you want to see Pokkt logs and other informatory messages, you can enable it by setting ShouldDebug to true . Make sure to disable debugging before release.
```
PokktAds.ShouldDebug(bool value);
PokktAds.ShowLog(string message);
PokktAds.ShowToast(string message);
```
**Ad Types**
**FullScreen Ads**
1. Full-screen ads can be rewarded or non-rewarded and video or interstitial. You can either cache the ad in advance or directly call show for it.
2. We suggest you cache the ad in advance so as to give seamless play behaviour, In other case it will stream the video which may lead to unnecessary buffering delays depending on the network connection.
3. ScreenId: This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard. We will be referencing the PokktAds Demo app provided with SDK during the course of explanation in this document. We suggest you go through the sample app for better understanding.
4. To cache Full-screen ad call:
```
PokktAds.CacheAd(string screenId);
```
5. To Show Video Ad:
```
PokktAds.ShowAd(string screenId);
```
You can check if an ad is available, before making a show request.
```
PokktAds.IsAdCached(string screenId);
```
6. Ad actions are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
```
public static event Action AdCachedEvent;
public static event Action AdFailedToCacheEvent;
public static event Action AdDisplayedEvent;
public static event Action AdFailedToShowEvent;
public static event Action AdClosedEvent;
public static event Action AdClickedEvent;
public static event Action AdGratifiedEvent;
public static event Action BannerLoadedEvent;
public static event Action BannerLoadFailedEvent;
```
There are two ways to load banners:
1. Load banner
```
PokktAds.LoadBanner(string screenId, int position);
```
There are predefined positions for banner positioning inside BannerPosition( Com. Pokkt.Plugin.Common.BannerPosition ) .
TOP\_LEFT.\
TOP\_CENTER.\
TOP\_RIGHT.\
MIDDLE\_LEFT.\
MIDDLE\_CENTER.\
MIDDLE\_RIGHT.\
BOTTOM\_LEFT.\
BOTTOM\_CENTER.\
BOTTOM\_RIGHT.
2. Load banner with rect
```
PokktAds.LoadBannerWithRect(string screenId, int height, int width, float x, float y);
```
Height : Custom height for banner.\
Width: Custom width for banner.\
x: Point x on screen to show banner.\
y: Point y on screen to show banner.
3. You can remove Banner using:
```
PokktAds.RemoveBanner();
```
**IGA (In Game Ad)**
Introducing a new way to monetize the game. Currently it works only for Android but soon will be available for iOS. Using Pokkt IGA (In-Game Ads) you can use your in-game objects to display ads. Pokkt IGA use a less intrusive way to achieve this. Refer our sample for a better understanding. Our existing SDK + Unity Plugin has this feature from version 6.0.
**Types of Ads:**
We support three different types of Ad:
1. Banner Ads: These are image-based advertisements that can be placed anywhere in your game.
2. Hoarding Ads: These are also image-based advertisements but larger in size as compared to the banners. These can also be placed anywhere in your game but we suggest you to place them in game objects like hoarding, as these are large and serves better purpose there.
3. Floating Ads: This Ad Unit itself consists of two image sources unlike its counterparts.
* Icon: It shows a small interactive image of the size of standard icons. On clicking on this icon it will open a full screen image
* Full Screen Image: It shows a full screen image with close button on its top right corner. The content of this image will further describe what that icon was about. This image has a “click through” assigned to it which will take the user to browser for further action or interaction if user wish to.
**How to use InGame Ad Units:**
1. Banner Ads:
* Using Pokkt Menu: Select your game object on which you want to add banner as highlighted in below image. We suggest to use “Quad” as “GameObject” as placement for banner although it’s not mandatory.
Error creating thumbnail: File missing
As a result of above step “Pokkt IGA Container” script gets attached to your “GameObject” with “Banner” selected as AdType. You can assign “Player Camera” also if required but it’s optional.
Error creating thumbnail: File missing
* Programmatically:
```
PokktIGAContainer.AddIGABanner(yourIGAGameObject)
```
2. Hoarding Ads:
* Using Pokkt Menu: Select your game object on which you want to add banner as highlighted in below image. We suggest to use “Quad” as “GameObject” as placement for hoarding although it’s not mandatory.
Error creating thumbnail: File missing
As a result of above step “Pokkt IGA Container” script gets attached to your “GameObject” with “Hoarding” selected as AdType. You can assign “Player Camera” also if required but it’s optional.
Error creating thumbnail: File missing
* Programmatically:
```
PokktIGAContainer. AddIGAHoarding (yourIGAGameObject)
```
3. Floating Ads:
* Using Pokkt Menu: Select your game object on which you want to add Floating Unit as highlighted in below image. We highly recommend you to add “ Button” as '“GameObject” as placement for floating unit.
Error creating thumbnail: File missing
As a result of above step “Pokkt IGA Container” script gets attached to your “GameObject” with “Floating Unit” selected as AdType. You can assign “Player Camera” also if required but it’s optional.
Error creating thumbnail: File missing
* Programmatically:
```
PokktIGAContainer. AddIGAFloatingButton (yourIGAGameObject)
```
IGA Collectibles and Boosts can only be assigned programmatically. Collectibles are in-game objects that a player collects during a gameplay, for example “Coins”, “Gems” etc. Boosts are collectibles with instant bonuses, powerups can be put in this category. Collectibles and Boosts are smaller textures compared to IGA Banners and hoardings.
```
PokktIGAContainer.AddIGACollectible(yourIGAGameObject);
PokktIGAContainer.AddIGABoost(yourIGAGameObject);
```
**Note:**
You still need to set your *App ID* and *Security Key* before you can fetch IGA Assets.\
To fetch assets call:
```
PokktAds.InGameAd.Fetch(<””>);
```
#### Additional SDK Configuration
As of May 25th, the General Data Protection Regulation (GDPR) will be enforced in the European Union. Set GDPR consent in Pokkt SDK. This must be called before calling any ad related API. Developers/Publishers must get the consent of the user. For more information on GDPR please refer and . This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting
```
ConsentInfo consentInfo = new ConsentInfo();
consentInfo.isGDPRApplicable = true;
consentInfo.isGDPRConsentAvailable = false;
ConsentInfo.SetDataAccessConsent(consentInfo);
```
**ThirdPartyUser Id**
If you are using server to server integration with Pokkt, you can also set Third Party UserId in PokktAds.
```
PokktAds.SetThirdPartyUserId(string userId)
```
**Pokkt ad player configuration**
Pokkt Ad player works the way App is configured at Pokkt dashboard, but we provide a way to override those settings using PokktAdPlayerViewConfig.
Application should prefer configuration provided through code by developer or what’s configured for the app in dashboard, can be controlled any time through the dashboard itself. If you want to make changes to this configuration after your app distribution, you can contact Pokkt Teamto do the same for your app through admin console.
```
PokktAdPlayerViewConfig adPlayerViewConfig = new PokktAdPlayerViewConfig ();
// set properties values to adPlayerViewConfig
PokktAds.SetAdPlayerViewConfig(adPlayerViewConfig );
```
Various properties that can be managed through this are:
1. Back button\
Defines if user is allowed to close the Advertisement by clicking on back button or not.\
Property Name: BackButtonDisabled\
Values:\
True = Back button is disabled and user cannot close the Ad.\
False = Back button is not disabled and user can close the Ad.
2. Default skip time\
Defines the time after which user can skip the Ad.\
Property name:DefaultSkipTime\
Values:\
Any Integer value.\
Default value is 10 seconds.
3. Should allow skip\
Defines if user is allowed to skip the Ad or not.\
Property name:ShouldAllowSkip\
Values:\
True = User can skip Ad.\
False = User can’t skip Ad.
4. Should allow mute\
Defines if user is allowed to mute the Video Ad or not.\
Property name:ShouldAllowMute\
Values:\
True = User can mute video Ad.\
False = User can’t mute video Ad.
5. Should confirm skip\
Defines if confirmation dialog is to be shown before skipping the Ad.\
Property name:ShouldConfirmSkip\
Values:\
True = Confirmation dialog will be shown before skipping the video.\
False = Confirmation dialog will not be shown before skipping the video.
6. Skip confirmation message\
Defines what confirmation message to be shown in skip dialog.\
Property name:SkipConfirmMessage\
Values:\
Any String message.\
Default value is “Skipping this video will earn you NO rewards. Are you sure?”.
7. Affirmative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Property name:SkipConfirmYesLabel\
Values:\
Any String message.\
Default value is “Yes”.
8. Negative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Property name:SkipConfirmNoLabel\
Values:\
Any String message.\
Default value is “No”.
9. Skip timer message\
Defines message to be shown before enabling skip button. Don’t forget to add placeholder “ ## ” in your custom message.\
This placeholder is replaced by property “Default skip time” assigned above.\
Property name:SkipTimerMessage\
Values:\
Any String message.\
Default value is “You can skip video in ## seconds”
10. Incentive message\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name:IncentiveMessage\
Values:\
Any String message\
Default value is “more seconds only for your reward !”
11. Should collect feedback\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name:setShouldCollectFeedback\
Values:\
True = If you want to collect feedback from the user for the Ad.\
False = If you don’t want to collect feedback from the user for the Ad.
12. Audio Enabled\
Provides a medium to disable audio for video ad without user interaction.\
Property name:IsAudioEnabled\
Values:\
True = If you want to play audio for video ad.\
False = If you don’t want to play audio for video ad.
**User Details**
For better targeting of ads you can also provide user details to our SDK using.
```
PokktUserDetails pokktUserDetails = new PokktUserDetails();
pokktUserDetails.Name = "";
pokktUserDetails.Age = "";
pokktUserDetails.Sex = "";
pokktUserDetails.MobileNo = "";
pokktUserDetails.EmailAddress = "";
pokktUserDetails.Location = "";
pokktUserDetails.Birthday = "";
pokktUserDetails.MaritalStatus = "";
pokktUserDetails.FacebookId = "";
pokktUserDetails.TwitterHandle = "";
pokktUserDetails.Education = "";
pokktUserDetails.Nationality = "";
pokktUserDetails.Employment = "";
pokktUserDetails.MaturityRating = "";
PokktAds.SetUserDetails(pokktUserDetails);
```
**iOS Framework and build settings configuration**
The iOS frameworks required are shown below:
Error creating thumbnail: File missing
Also, please change your project settings to use the New Build System when creating iOS build. For other iOS build related configurations, please follow the iOS documentation for POKKT SDK.
# Unity3D (Windows Phone)
### Contents
* [1 POKKT SDK v4.1 Integration Guide for Unity3d 5.2+ (Windows)](broken://pages/K6NYkPTPogdB6ZdEjiUc)
* [1.1 Overview:](broken://pages/K6NYkPTPogdB6ZdEjiUc)
* [1.2 Configuration Steps:](broken://pages/K6NYkPTPogdB6ZdEjiUc)
* [1.3 3.Implementation Steps](broken://pages/K6NYkPTPogdB6ZdEjiUc)
* [1.3.1 Common:](broken://pages/K6NYkPTPogdB6ZdEjiUc)
* [1.3.2 Session:](broken://pages/K6NYkPTPogdB6ZdEjiUc)
* [1.3.3 Rewarded/Non-Rewarded Ads:](broken://pages/K6NYkPTPogdB6ZdEjiUc)
* [1.3.4 Export Logs (Only for Windows Phone Plugin):](broken://pages/K6NYkPTPogdB6ZdEjiUc)
* [1.3.5 Clearing Log File:](broken://pages/K6NYkPTPogdB6ZdEjiUc)
* [1.3.6 Optional Parameters:](broken://pages/K6NYkPTPogdB6ZdEjiUc)
### POKKT SDK v4.1 Integration Guide for Unity3d 5.2+ (Windows)
Last Update: July 1st, 2016
Download Latest Version Here v4.1.1.
***
#### Overview:
Thank you for choosing Pokkt SDK Plugin v4.1 for Unity3d. Pokkt SDK Video/Interstitial-Ad campaigns feature. This document contains all the information that is needed by you to setup the SDK with your project.
Kindly note that these instructions are for Unity3d Version 5.2 and above, older versions of Unity3d are not supported.
There is a sample app provided with the SDK. We will be referencing this app during the course of explanation in this document. It is suggested that you should check that app to understand the following process in detail.
Note: Please do not copy the code points from this PDF file as it may introduce unwanted characters and space in your code. Instead please refer to sample app source code provided with the sample app.
***
#### Configuration Steps:
All we need is the file provided: PokktUnityDemo\_Windows.unitypackage
Step 1: Export the content of this package onto your Unity project. The contents of “Plugin/Pokkt” and the “Plugins/Android” directories are mandatory. You can safely ignore all the other stuff, they are provided here to demonstrate the integration of Pokkt-SDK, this document uses snippets from those files.
Step 2: Ensure that you have PWPUnity.dllfile directly inside the Assets/Pluginsfolder. This is the editor’s “placeholder” plugin for the original Windows plugin. Select the PWPUnity.dlland set the following on the Inspector Panel (reference the following image):
Select platforms for plugin: Uncheck “Any Player” and then check only “Editor”
Step 3: Next, ensure that you have another PWPUnity.dlland a PWPUnity.pdbinside Assets/Plugins/WSAfolder, along with PokktSDK.dll, PokktSDK.pdband a PokktSDKfolder with some resources (you will use these resources later on). Now select PokktSDK.dlland set the following on the Inspector Panel (reference the following image):
Select platforms for plugin: Check “WSAPlayer”\
SDK: PhoneSDK8.1 or Any SDK\
CPU: Any CPU\
Don’t Process: \[CHECK]\
Placeholder: \[EMPTY]
Step 4: Select UnityWindowsExtension.dllinside Assets/Plugins/WSAfolder and set the following on the Inspector Panel (reference the image below):
Select platforms for plugin: Check “WSAPlayer”\
SDK: PhoneSDK8.1 or Any SDK\
CPU: Any CPU\
Don’t Process: \[CHECK]\
Placeholder: \[MAP TO: Assets/Plugins/ PWPUnity.dll]
*Note: Ignore any exception (System.Reflection.TargetInvocationException) you encounter while importing this DLL file.*
Step 5: Once you have built/generated the C# Project, manually add and include the PokktSDK folder inside Assets/Plugins/WSAfolder to the project. This PokktSDKfolder should have a UI folder inside it. Once added to the generated C# Project, select each of the XBF files inside the UI folder and set the following in the Properties Window (reference the image below):
Build Action: Content\
Copy to Output Directory: Copy Always
This should integrate the Plugin with your project.
***
#### 3.Implementation Steps
**Common:**
1. For all invocation of Pokkt SDK developer will make use of methods available in PokktManager class. This class only have static methods.
2. Setup your PokktConfig, provide ApplicationId and SecurityKey, these are must for initializing Pokkt.
3. Once you have you PokktConfigready, invoke InitPokkt method before you invoke any other methods from the PokktManager. This does not apply to session related methods namely StartSessionand EndSessionand few utility methods.
4. In order to know whether Pokkt is initialized or not, listen to PokktInitialisedEvent, if the provided Boolean parameter is true only then move ahead with other operations.
5. If you are doing server to server integration with Pokkt you can also set ThirdPartyUserIdin PokktConfig.
6. While in development, you can call PokktManager.SetDebug(true) to see Pokkt debug logs and toast messages. please make sure to change this to false for production build.
7. Call PokktManager.NotifyAppInstall() to log your application installation information with Pokkt.
8. Call PokktManager.TrackIAP(details) to log any in-app purchase details with Pokkt.
**Session:**
1. Invoke PokktManager.StartSession() at the start of his application and once only.
2. You should call PokktManager.EndSession()at the end of his application and once only.
**Rewarded/Non-Rewarded Ads:**
1. You will have to configure an AdConfig object to request for any ad to be displayed. It also provides options for customizing your ad-screen. It is recommended to have different AdConfig objects for each screens. Followings are the values that you can set with AdConfig:
* ScreenName (Required): This controls the placement of ads and can be created on Pokkt Dashboard.
* IsRewarded (Required):Requested ad type. Ad gratification will happen only for rewarded ads.
* BackButtonDisabled: Disable ‘back’ button press while on ad-screen.
* DefaultSkipTime:If ad-skipping is allowed, this provides the seconds it will wait before the skip button appears.
* ShouldAllowSkip: Whether skipping-ad is allowed or not. If set to ‘false’, user will be forced to watch the ad till it finishes.
* ShouldAllowMute: Whether to allow sound-mute while on ad-screen, it controls the ‘mute’ button. Cannot contains whitespaces and only special characters allowed are hyphens (-) and underscores (\_).
* ShouldConfirmSkip: Controls whether to show the skip-confirmation dialog box. If set to ‘false’, the ad will be silently closed without prompting for confirmation
* SkipConfirmMessage:The message that will appear on skip-confirmation dialog box.
* SkipConfirmYesLabel: ‘Yes’ Label of skip-confirmation dialog box.
* SkipConfirmNoLabel:‘No’ Label of skip-confirmation dialog box.
* SkipTimerMessage:The message on countdown-timer before the skip button appears. The message must contain a ‘##’-placeholder to show timer value.
* IncentiveMessage:If set, the message will be displayed while prompting user to watch the ad for certain time before it can be rewarded.
2. Invoke PokktManager.CacheAd(adConfig)to cache the ad on device. Cached-ads provide better user experience than streaming-ads
3. You can call PokktManager.CheckAdAvailability(adConfig)to check if the adcampaigns are available or not. The result will be notified via AdAvailabilityEvent.
4. Invoke PokktManager.ShowAd(adConfig)to show ad.
5. Following are ad-related events, you can refer to the provided sample-code to understand the ideal implementation on how to consume these:
* AdCachingCompletedEvent
* AdCachingFailedEvent
* AdDisplayedEvent
* AdSkippedEvent
* AdCompletedEvent
* AdClosedEvent
* AdGratifiedEvent
* AdAvailabilityEvent
6. Reward user ONLY from the AdGratifiedEvent.
**Export Logs (Only for Windows Phone Plugin):**
1. Call PokktManager.ExportLog()to export the Pokkt SDK logs to folder of your choice.
2. This API shows a folder chooser dialog where user can choose a particular folder.
3. User can also create a new folder where user wants to export the logs.
4. You will also have to modify the exported Visual Studio Project and locate the App.xaml.cs file. Then find the method called OnActivated(create one if not there). Next call PokktNativeExtension.OnAppActivated(param).This ensures log file export.
```
protected override void OnActivated(IActivatedEventArgs args)
{
PokktNativeExtension.OnAppActivated(args);
// some other stuff
}
```
**Clearing Log File:**
You can call PokktNativeExtension.ClearLogFile()to clear the log file.
**Optional Parameters:**
PokktConfigalso has provision for developers to provide extra user data available with them to Pokkt. We currently support following data points: Name, Age, Sex, MobileNo, EmailAddress, Location, Birthday, MaritalStatus, FacebookId, TwitterHandle, Education, Nationality, Employmentand MaturityRating.
# Cocos2d-x V3
### Contents
* [1 POKKT SDK v7.6.0 (GDPR Compliance) Cocos2D-3x](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [2 Getting Started with Pokkt SDK v7.6.0](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3 Integration Guide v7.6.0](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.1 Overview](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2 Implementation Steps](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.1 SDK Configuration](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.2 Ad Types](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.2.1 Video](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.3 Interstitial](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.4 Banner](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.5 Ad Listeners](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.5.1 Video](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.5.2 Interstitial](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.5.3 Banner](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.6 Pokkt ad player configuration](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.7 User Details](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.8 Pokkt Server Callback Params](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.9 Debugging](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.10 Analytics](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.10.1 Google Analytics](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.10.2 Flurry Analytics](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.10.3 MixPanel Analytics](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.10.4 Fabric Analytics](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.2.11 IAP(In App Purchase)](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3 Project Configuration](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3.1 Android](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3.2 Dependencies](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3.3 Manifest](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3.3.1 Permissions Declarations](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3.3.2 Activity Declaration](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3.3.3 Service Declaration](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3.4 iOS](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3.5 Dependencies](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3.6 Framework](broken://pages/QkQEbSFJxiUaVSZjEa03)
* [3.3.7 Info.plist](broken://pages/QkQEbSFJxiUaVSZjEa03)
###
Last Update: 22nd November, 2019
Download Latest Version Here.
***
### Getting Started with Pokkt SDK v7.6.0
1\. Add *"pokktsdk"* available inside the *"Pokkt\_Cocos2dx\_Plugin\_v7.6.0.zip"* to your project.
2\. Set *Application Id* and *Security Key* in Pokkt SDK. You can get it from Pokkt dashboard from your account. These are unique per app registered.
```
PCPokktAds::setPokktConfig("", "");
```
3\. Set the following to enable or disable omission of Pokkt logs and other informatory messages. Make sure to set it to false before release.
```
PCPokktAds::Debugging.shouldDebug();
```
4\. Set *GDPR consent* in Pokkt SDK. This must be called before calling any ad related API. Developers/Publishers must get the consent from user. For more information on GDPR please refer and . This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting.
```
pokkt::PCPokktConsentInfo info;
info.GDPRApplicable = value;
info.GDPRConsentAvailable = value;
PCPokktAds::setPokktConsentInfo(info);
```
5\. You can check if Ad is cached or not using
```
PCPokktAds::isVideoAdCached(“screen_name”, isRewarded);
PCPokktAds::isInterstitialCached(“screen_name”, isRewarded);
```
6\. Show Video Ad with one of the followings:
```
PCPokktAds::showRewardedVideoAd("");
PCPokktAds::showNonRewardedVideoAd("");
```
7\. Show Interstitial Ad with one of the followings:
```
PCPokktAds::showRewardedInterstitialAd("");
PCPokktAds::showNonRewardedInterstitialAd("");
```
8\. For Banner Ad
```
PCPokktAds::loadBanner(, );
PCPokktAds::initWithBannerAdSize(,, Width>, ,);
PCPokktAds::destroyBanner()
```
9\. Ad delegates are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
10\. We recommend caching of video-ads for better user experience, you can cache an ad using the followings:
```
PCPokktAds::cacheRewardedVideoAd("");
PCPokktAds::cacheNonRewardedVideoAd("");
```
### Integration Guide v7.6.0
#### Overview
Thank you for choosing Pokkt SDKfor Cocos2d-3x. This document contains all the information required to set up the SDK with your project. We also support mediation for various third party networks. To know the supported third party networks and their integration process go to mediation section.
Before implementing plugins it is mandatory to go through project configuration and implementation steps , as these sections contain mandatory steps for basic SDK integration and are followed by every plugin.
You can download our SDK from pokkt.com
ScreenName: This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
We will be referencing PokktAds Demo app provided with SDK during the course of explanation in this document. We suggest you go through the sample app for better understanding.
***
#### Implementation Steps
**SDK Configuration**
1. Set Application Idand Security keyin Pokkt SDK. You can get it from Pokkt dashboard from your account. These are unique per app registered.
```
PCPokktAds::setPokktConfig("", "");
```
2. If you are using server to server integration with Pokkt, you can also set Third Party UserIdin PokktAds.
```
PCPokktAds::setThirdPartyUserId("");
```
3. When your application is under development and if you want to see Pokkt logs and other informatory messages, you can enable it by setting shouldDebugto true . Make sure to disable debugging before release.
```
PCPokktAds::Debugging.shouldDebug();
```
4. Set *GDPR consent* in Pokkt SDK. This must be called before calling any ad related API. Developers/Publishers must get the consent from user. For more information on GDPR please refer and . This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting.
```
pokkt::PCPokktConsentInfo info;
info.GDPRApplicable = value;
info.GDPRConsentAvailable = value;
PCPokktAds::setPokktConsentInfo(info);
```
**Ad Types**
**Video**
* Video ad can be rewarded or non-rewarded. You can either cache the ad in advance or directly call show for it.
* We suggest you to cache the ad in advance so as to give seamless play behaviour, In other case it will stream the video which may lead to unnecessary buffering delays depending on the network connection.
1. To cache rewarded ad call:
```
PCPokktAds::cacheRewardedVideoAd("");
```
2. To show rewarded ad call:
```
PCPokktAds::showRewardedVideoAd("");
```
3. To cache non-rewarded ad call:
```
PCPokktAds::cacheNonRewardedVideoAd("");
```
4. To show non-rewarded ad call:
```
PCPokktAds::showNonRewardedVideoAd("");
```
5. You can check if ad is cached or not using
```
PCPokktAds::isVideoAdCached(“screen_name”, isRewarded);
```
**Interstitial**
1. To cache rewarded ad call:
```
PCPokktAds::cacheRewardedInterstitialAd("");
```
2. To show rewarded ad call:
```
PCPokktAds::showRewardedInterstitialAd("");
```
3. To cache non-rewarded ad call:
```
PCPokktAds::cacheNonRewardedInterstitialAd("");
```
4. To show non-rewarded ad call:
```
PCPokktAds::showNonRewardedInterstitialAd("");
```
5. You can check if ad is cached or not using
```
PCPokktAds::isInterstitialCached(“screen_name”, isRewarded);
```
There are two ways to load banners:
1. Load banner
```
PCPokktAds::loadBanner(”, );
```
There are predefined positions for banner positioning inside BannerPosition ( Com. Pokkt.Plugin.Common.BannerPosition ).
* TOP\_LEFT.
* TOP\_CENTER.
* TOP\_RIGHT.
* MIDDLE\_LEFT.
* MIDDLE\_CENTER.
* MIDDLE\_RIGHT.
* BOTTOM\_LEFT.
* BOTTOM\_CENTER.
* BOTTOM\_RIGHT.
2. Load banner with rect
```
PCPokktAds::initWithBannerAdSize(, ,,,);
```
Height : Custom height for banner.\
Width: Custom width for banner.\
x: Point x on screen to show banner.\
y: Point y on screen to show banner.
3. You can remove Banner using:
```
PCPokktAds::destroyBanner()
```
**Ad Listeners**
Ad listeners are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
**Video**
```
PCPokktAds::setAdEventListener(AD_CACHING_COMPLETED_EVENT,PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdCachingCompleted), this);
PCPokktAds::setAdEventListener(AD_CACHING_FAILED_EVENT,PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdCachingFailed), this);
PCPokktAds::setAdEventListener(AD_DISPLAYED_EVENT,PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdDisplayed), this);
PCPokktAds::setAdEventListener(AD_SKIPPED_EVENT,PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdSkipped), this);
PCPokktAds::setAdEventListener(AD_COMPLETED_EVENT,PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdCompleted), this);
PCPokktAds::setAdEventListener(AD_CLOSED_EVENT,PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdClosed), this);
PCPokktAds::setAdEventListener(EVENT_INTERSTITIAL_CLICKED,PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdClicked), this);
PCPokktAds::setAdEventListener(AD_GRATIFIED_EVENT,PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdGratified), this);
```
**Interstitial**
```
PCPokktAds::setAdEventListener(AD_CACHING_COMPLETED_EVENT,PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdCachingCompleted), this);
PCPokktAds::setAdEventListener(AD_CACHING_FAILED_EVENT,PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdCachingFailed), this);
PCPokktAds::setAdEventListener(AD_DISPLAYED_EVENT,PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdDisplayed), this);
PCPokktAds::setAdEventListener(AD_SKIPPED_EVENT,PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdSkipped), this);
PCPokktAds::setAdEventListener(AD_COMPLETED_EVENT,PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdCompleted), this);
PCPokktAds::setAdEventListener(AD_CLOSED_EVENT,PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdClosed), this);
PCPokktAds::setAdEventListener(EVENT_INTERSTITIAL_CLICKED,PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdClicked), this);
PCPokktAds::setAdEventListener(AD_GRATIFIED_EVENT,PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdGratified), this);
```
```
PCPokktAds::setAdEventListener(BANNER_LOADED_OP,PC_ADS_EVENT_SELECTOR(BannerAdsView::handleBannerLoadSuccessfuly), this);
PCPokktAds::setAdEventListener(BANNER_LOAD_FAILED_OP,PC_ADS_EVENT_SELECTOR(BannerAdsView::handleBannerLoadFailed), this);
PCPokktAds::setAdEventListener(EVENT_BANNER_CLICKED_OP,PC_ADS_EVENT_SELECTOR(BannerAdsView::handleBannerClicked), this);
```
**Pokkt ad player configuration**
Pokkt Ad player works the way App is configured at Pokkt dashboard, but we provide a way to override those settings using PokktAdPlayerViewConfig.
Application should prefer configuration provided through code by developer or what’s configured for the app in dashboard, can be controlled any time through the dashboard itself. If you want to make changes to this configuration after your app distribution, you can contact Pokkt Teamto do the same for your app through admin console.
```
PokktAdPlayerViewConfig adPlayerViewConfig = new PokktAdPlayerViewConfig ();
// set properties values to adPlayerViewConfig
PCPokktAds::setAdPlayerViewConfig(adPlayerViewConfig);
```
Various setters for the properties that can be managed through this are:
1. Back button\
Defines if user is allowed to close the Advertisement by clicking on back button or not.\
Setter Name: setBackButtonDisabled(boolean backButtonDisabled)\
Values:\
True = Back button is disabled and user cannot close the Ad.\
False = Back button is not disabled and user can close the Ad.
2. Default skip time\
Defines the time after which user can skip the Ad.\
Setter name:setDefaultSkipTime(int defaultSkipTime)\
Values:\
Any Integer value.\
Default value is 10 seconds.
3. Should allow skip\
Defines if user is allowed to skip the Ad or not.\
Setter name:setShouldAllowSkip(boolean shouldAllowSkip)\
Values:\
True = User can skip Ad.\
False = User can’t skip Ad.
4. Should allow mute\
Defines if user is allowed to mute the Video Ad or not.\
Setter name:setShouldAllowMute(boolean shouldAllowMute)\
Values:\
True = User can mute video Ad.\
False = User can’t mute video Ad.
5. Should confirm skip\
Defines if confirmation dialog is to be shown before skipping the Ad.\
Setter name:ShouldConfirmSkip\
Values:\
True = Confirmation dialog will be shown before skipping the video.\
False = Confirmation dialog will not be shown before skipping the video.
6. Skip confirmation message\
Defines what confirmation message to be shown in skip dialog.\
Setter name:setShouldSkipConfirm(boolean shouldSkipConfirm)\
Values:\
Any String message.\
Default value is “Skipping this video will earn you NO rewards. Are you sure?”.
7. Affirmative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Setter name:setSkipConfirmYesLabel(String skipConfirmYesLabel)\
Values:\
Any String message.\
Default value is “Yes”.
8. Negative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Setter name:setSkipConfirmNoLabel(String skipConfirmNoLabel)\
Values:\
Any String message.\
Default value is “No”.
9. Skip timer message\
Defines message to be shown before enabling skip button. Don’t forget to add placeholder “ ## ” in your custom message.\
This placeholder is replaced by property “Default skip time” assigned above.\
Setter name:setSkipTimerMessage(String skipTimerMessage)\
Values:\
Any String message.\
Default value is “You can skip video in ## seconds”
10. Incentive message\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Setter name:setIncentiveMessage(String incentiveMessage)\
Values:\
Any String message\
Default value is “more seconds only for your reward !”
11. Should collect feedback\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name:setShouldCollectFeedback\
Values:\
True = If you want to collect feedback from the user for the Ad.\
False = If you don’t want to collect feedback from the user for the Ad.
12. isAudioEnabled\
Defines if user is allowed to mute the Video Ad or not.\
Setter name:setIsAudioEnabled(boolean isAudioEnabled)\
Values:\
True = Video Ad will be mute.\
False = Video Ad will not be mute.
**User Details**
For better targeting of ads you can also provide user details to our SDK using.
```
PCPokktUserDetails* pokktUserDetails = new PokktUserDetails();
pokktUserDetails -> name =" ";
pokktUserDetails -> age = " ";
pokktUserDetails -> sex = " ";
pokktUserDetails -> mobileNumber = " ";
pokktUserDetails -> emailAddress = " ";
pokktUserDetails -> location = " ";
pokktUserDetails -> birthday = " ";
pokktUserDetails -> maritalStatus = " ";
pokktUserDetails -> facebookId = " ";
pokktUserDetails -> twitterHandle = " ";
pokktUserDetails -> education = " ";
pokktUserDetails -> nationality = " ";
pokktUserDetails -> employment = " ";
pokktUserDetails -> maturityRating = " ";
PokktAds::setUserDetails(pokktUserDetails);
```
**Pokkt Server Callback Params**
Developer can set some values in POKKT SDK that they need to be sent to their server via POKKT Server callbacks. These Extra parameters will be in key-value pair.The key must be alphanumeric value. See the below example:
```
String params = “{\"adnetwork\":\"pokkt\"}”
PCPokktAds::setCallBackExtraParam("");
String format should be same as like:
“{\"Key 1\":\"value 1\",\"Key 2\":\"value 2\",\"Key 3\":\"value 3\",\"Key 4\":\"value 4\"}”
```
**Debugging**
Other than enabling debugging for Pokkt SDK, it can also be used to:
1. Export log
Export your log to your desired location, we generally have it in root directory of SD card, if permission for external storage is provided and in cache folder otherwise.
```
PCPokktAds::exportLog();
```
**Analytics**
We support various analytics in Pokkt SDK.
Below is mentioned how to enable various analytics with Pokkt SDK.
**Google Analytics**
Google analytics Id can be obtained from Google dashboard.
```
PCPokktAnalyticsDetails* analyticsDetail = new AnalyticsDetails();
analyticsDetail->eventType = “GOOGLE_ANALYTICS”;
analyticsDetail->googleAnalyticsID( "");
PCPokktAds::setAnalyticDetail(analyticsDetail);
```
**Flurry Analytics**
Flurry application key can be obtained from Flurry dashboard.
```
PCPokktAnalyticsDetails* analyticsDetail = new AnalyticsDetails();
analyticsDetail->eventType = ”FLURRY”;
analyticsDetail->flurryApplicationKey("");
PCPokktAds::setAnalyticDetail(analyticsDetail);
```
**MixPanel Analytics**
MixPanel project token can be obtained from MixPanel dashboard.
```
PCPokktAnalyticsDetails* analyticsDetail = new AnalyticsDetails();
aanalyticsDetail->eventType = “MIXPANEL”;
analyticsDetail->mixPanelProjectToken( "");
PCPokktAds::setAnalyticDetail(analyticsDetail);
```
**Fabric Analytics**
Analytics Id is not required in case of Fabric.
```
PCPokktAnalyticsDetails* analyticsDetail = new AnalyticsDetails();
analyticsDetail->eventType = “FABRIC”;
PCPokktAds::setAnalyticDetail(analyticsDetail);
```
**IAP(In App Purchase)**
Call trackIAP to send any In App purchase information to Pokkt.
```
PCIAPDetails* pcIAPDetails = new PCIAPDetails();
pcIAPDetails -> productId("");
pcIAPDetails -> purchaseData("");
pcIAPDetails -> purchaseSignature("");
pcIAPDetails -> purchaseStore(IAPStoreType.GOOGLE);
pcIAPDetails -> price(<100.00>);
PCPokktAds::setTrackIAP(pcIAPDetails );
```
***
#### Project Configuration
**Android**
In the package downloaded above you will find:
1. Docs: Contains documentations for step wise step integration for SDK.
2. android\_plugin
* AndroidManifest.xml: mentions
* libs
* android-support-v4.jar
* google-play-services.jar
* PAPCocos2dx.jar
* PokktSDK\_v7.6.0.jar
* pokktsdk360ext.jar
3. ios\_plugin
* PokktSDK.framework.
4. pokkt\_demo\_app: Source code for PokktAds Demo (Sample app) which showcase implementation of Pokkt SDK through code for better understanding.
5. pokktsdk: Extension for pokkt SDK.
minSdkVersionsupported is 11 .
**Dependencies**
* Extract the *PokktSDK\_Native\_Extension.zip*file and put the content inside your C++ project, preferably directly inside the *Classes*folder.
* Add *moat.jar, comscore.jar, PokktSDK\_v7.6.0.jar, android-support-v4.jar*and *PAPCocos2dx.jar*to your project.
* We expect Google play servicesintegrated in project, although it;s optional but we recommend you to integrate it, as it’s required to fetch AdvertisingIDfor device,which is useful to deliver targeted advertising to Android users.
**Manifest**
**Permissions Declarations**
Add the following permissions to your project manifest
1. Mandatory permissions.
```
```
* android.permission.INTERNET = Required for SDK communication with server.
* android.permission.ACCESS\_NETWORK\_STATE = Required to detect changes in network, like if WIFI is available or not.
2. Optional permissions.
```
```
* android.permission.WAKE\_LOCK = Required to prevent device from going into the sleep mode during video play.
* android.permission.WRITE\_EXTERNAL\_STORAGE = Required to store media files related to ads in external SD card, if not provided we will use app cache folder to store media files, which will result in unnecessary increase in application’s size. It is recommended to ask for this permission as low end devices generally have less internally memory available.
* android.permission.WRITE\_CALENDAR = Some Ads create events in calendar.
* android.permission.ACCESS\_FINE\_LOCATION = Some Ads show content based on user’s location
* android.permission.VIBRATE = Some Ads provide haptic feedback, so as to maintain their behavior we need this permission
**Activity Declaration**
Add the following activity in your AndroidManifest for Pokkt SDK integration.
```
```
You can change the android:screenOrientation="landscape"to of your choice, the way you want to display the ads.
**Service Declaration**
Add the following service in your AndroidManifest for receiving InApp notifications. How to set up InApp notifications.
```
```
**iOS**
In the package downloaded above you will find:
**Dependencies**
* Extract the *pokktsdk.zip* file and put the content inside your C++ project, preferably directly inside the Classes folder.
* Extract the *libpokkt.zip* and add its content to your project. And add the *PokktSDK.framework*. Just to make sure, go to your project’s settings *"Build Phases -> Link Binary with Libraries"*. If *PokktSDK.framework* is not present then make an entry there and you are good to go.
* Ensure that *"-ObjC"* flag is set inside project setting’s “Build Settings -> Other Linker Flags”.
In order to use PokktSDK’s background fetch functionality, enable "Capabilities -> Background Modes -> Background Fetch" inside project settings. Then write the following code-snippet inside
*"didFinishLaunchingWithOptions"* method of app-delegate class:
```
[application setMinimumBackgroundFetchInterval:
UIApplicationBackgroundFetchIntervalMinimum];
```
Further, implement/update the background-fetch delegate methods in app-delegate class. Invoke
*"callBackgroundTaskCompletionHandler"* method from *"performFetchWithCompletionHandler"*. Observe the following code-snippet for reference:
```
-(void)application:(UIApplication *) application
performFetchWithCompletionHandler:
(void(^)(UIBackgroundFetchResult))completionHandler
{
[PokktAds callBackgroundTaskCompletedHandler:
^(UIBackgroundFetchResult result)
{
completionHandler(result);
}];
}
```
In order to enable local notifications for InApp Notifications , mention the following inside
*"didFinishLaunchingWithOptions"* method of the app-delegate class:
```
[application setMinimumBackgroundFetchInterval:
UIApplicationBackgroundFetchIntervalMinimum];
UIUserNotificationSettings *settings =
[UIUserNotificationSettings settingsForTypes:
(UIRemoteNotificationTypeBadge | UIRemoteNotificationTypeSound | UIRemoteNotificationTypeAlert)
categories:nil];
[application registerUserNotificationSettings:settings];
```
Invoke *"inAppNotificationEvent"* if the user taps on local notification, do this in the *"didReceiveLocalNotification"* inside app-delegate class. Check the following reference:
```
-(void)application:(UIApplication*) application
didReceiveLocalNotification:(UILocalNotification*) notification
{
[PokktAds inAppNotificationEvent:notification];
}
```
**Framework**
Add Following frameworks to your project:
```
CoreData.framework
ARKit.framework
Foundation.framework
MediaPlayer.framework
SystemConfiguration.framework
UIKit.framework
CoreTelephony.framework
EventKit.framework
AdSupport.framework
CoreGraphics.framework
CoreMotion.framework
MessageUI.framework
EventKitUI.framework
CoreLocation.framework
AVFoundation.framework
libc++.tbd
```
**Info.plist**
Add the below exceptions to your application info.plist.
```
NSAppTransportSecurityNSExceptionDomainspokkt.comNSIncludesSubdomainsNSExceptionAllowsInsecureHTTPLoadsNSExceptionRequiresForwardSecrecyNSExceptionMinimumTLSVersionTLSv1.2NSThirdPartyExceptionAllowsInsecureHTTPLoadsNSThirdPartyExceptionRequiresForwardSecrecyNSThirdPartyExceptionMinimumTLSVersionTLSv1.2NSRequiresCertificateTransparencycloudfront.netNSIncludesSubdomainsNSExceptionAllowsInsecureHTTPLoadsNSExceptionRequiresForwardSecrecyNSExceptionMinimumTLSVersionTLSv1.2NSThirdPartyExceptionAllowsInsecureHTTPLoadsNSThirdPartyExceptionRequiresForwardSecrecyNSThirdPartyExceptionMinimumTLSVersionTLSv1.2NSRequiresCertificateTransparency
```
# Adobe AIR
### Contents
* [1 POKKT SDK v5.0 Integration Guide for AIR (Android)](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.1 1. Overview](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.2 2. Configuration Steps](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.2.1 Android Manifest xml update:](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.3 3. Implementation Steps](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.3.1 Common](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.3.2 Session](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.3.3 AdConfig (used for reward / non-reward ad)](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.3.4 Rewarded Ad/Non-Rewarded Ad](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.3.5 Banner Ad](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.3.6 Mediation Info](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.3.7 Optional Parameters](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.4 In-App Notifications](broken://pages/esy8rMcmvxl4CTNELfGc)
* [1.5 4. Important Points](broken://pages/esy8rMcmvxl4CTNELfGc)
### POKKT SDK v5.0 Integration Guide for AIR (Android)
Last Update: October 20th, 2016
Download Latest Version Here with PDF Documentation v5.0.
***
#### 1. Overview
Thank you for choosing Pokkt SDK Plugin v5.0for AIR. Pokkt SDK supports Reward Ad, Non-Reward Ad, Banner Ad and Offerwal campaigns feature. This document contains all the information which is needed to setup the SDK with project. Please follow these steps as per your integration requirement (Reward/Non- Reward/Banner/Offerwal). The current plugin supports mediation for various third party ad-networks. These are:
* AdColony
* AppLovon
* Chartboost
* Fyber
* InMobi
* SuperSonic
* UnityAds
* TapJoy
* Vungle
* AdMob
* Facebook
A separate set of documents is provided for each of these, explaining the implementation process.
There is a sample app provided with the SDK. We will be referencing this app during the course of explanation in this document. It is suggested that you should check that app to understand the following process in detail.
***
#### 2. Configuration Steps
All we need is the file provided PluginExtension.zip file which contains three files\
PokktExtensionAndroid.ane, PokktGooglePlayService\_ANE.ane and PokktMediation.ane.
Add .ane file in your project properties and also please read [here](http://www.adobe.com/devnet/air/articles/ane-android-devices.html#articlecontentAdobe_numberedheader_2)to understand how AIR ane works.
**Android Manifest xml update:**
1. Add following permissions in your App xml under android manifest, If not already there.
```
```
2. Add the following activity in your App xml under android manifest for OfferWall Integration
```
```
3. Add the following activity in your App xml under android manifest for Video Integration
```
```
4. Add the following VPAID ads activity in App xml under android manifest.
```
```
5. Add the following interstitial ads activity in App xml under android manifest for Pokkt Interstitial Integration.
```
```
6. Add Following Broadcast receiver for OfferWall Integration in App xml under android manifest
```
```
7. Add Following meta tag for google play services (Goole play services is required and should be part of your project, if not, please add the GooglePlayService component in project).
```
```
8. Add a meta data tag for offerwall campaign. you will have to implement the IOfferwallDelegateinterface in your project to listen for all offerwall related events. (refer to pokkt sample for example).
```
```
9. Add following Service and receiver in manifest for google analytics (Optional).
```
```
10. Add following Service and receiver in manifest for google analytics (Optional).
```
```
Note:Please do not copy the code points from this PDF file as it may introduce unwanted characters and space in your code. Instead please refer to sample app source code provided with the sample app.
***
#### 3. Implementation Steps
**Common**
1. For all invocation of Pokkt SDK developer will make use of methods available in PokktManagerclass. This class only have static methods.
2. In PokktConfigyou can set ApplicationId, SecurityKey, IntegrationType. which are must for all type of integrations. Please check the sample app.
3. Before calling any other methods from the PokktManager, please make sure that you have called the InitPokktwith passing PokktConfigobject.
4. IIf you are doing server to server integration with POKKT you can also set ThirdPartyUserIdin PokktConfig.
5. Apart from above mentioned parameters you can assign additional ones based on your integration type (please refer to OfferWall and Reward sections below).
6. While in development, please call PokktManager.setDebug(true);to see pokkt debug logs and toast messages. please make sure to change this to PokktManager.setDebug(false); for production build.
7. Android MinSDKVersion should be >= 14.
8. To use google analytics, please set AnalyticsType and Analytics ID in PokktConfig.
```
pokktConfig.selectedAnalyticsType = AnalyticsType.GOOGLE_ANALYTICS;
pokktConfig.googleAnalyticsID = “Id”;
```
9. To use flurry analytics please set AnalyticsType and Flurry Application Key in PokktConfig.
```
pokktConfig.selectedAnalyticsType = AnalyticsType.FLURRY;
pokktConfig.flurryApplicationKey = “key”;
```
10. To use mix panel analytics please set AnalyticsType and Mix PanelProject Token in PokktConfig
```
pokktConfig.selectedAnalyticsType = AnalyticsType.FLURRY;
pokktConfig.mixPanelProjectToken = “token”;
```
11. To use mix panel analytics please set AnalyticsType and Fabric Token in PokktConfig
```
pokktConfig.selectedAnalyticsType = AnalyticsType.FABRIC
```
12. Please call trackIAP(InAppPurchaseDetail) to send any in-app purchase information to Pokkt. Like below you can do this.
```
// create object of InAppPurchaseDetails and set properties for purchaseDetail s and pass object
PokktManager.trackIAP (InAppPurchaseDetails);
```
**Session**
1. We have option to start session for tracking: startSession and endSession methods in PokktManager.
2. You should call startSessionat the start of his application if you want to use this but this is the optional and call it after setting application id and security key.
3. You should call endSessionat the end of his application.
OfferWall
1. In PokktConfigfor OfferWall you can set two additional parameters which are OfferWallAssetValueand closeOnSuccessFlag. OfferWallAssetValue is only required if you only want to show campaign of certain value on offerwall. closeOnSuccessFlagis required if you wish to close the OfferWall after user has completed one offer. It’s default value is false.
2. Before calling another method for offerWall in PokktManager, please make sure that you have already called initPokkt first.
3. You need to add event listener as below or also please check the OfferwallScreen class in sample app.
```
PokktManager.dispatcher.addEventListener(PokktEvent.POKKT_INITIALISED_EVENT, onPokktInitialised);
PokktManager.dispatcher.addEventListener(PokktEvent.COIN_RESPONSE_EVENTS, onCoinResponseSuccess);
PokktManager.dispatcher.addEventListener(PokktEvent.COIN_RESPONSE_WITH_TRANS_ID_EVENTS, onCoinResponseWithTransID);
PokktManager.dispatcher.addEventListener(PokktEvent.COIN_RESPONSE_FAILED_EVENTS, onCoinResponseFailed);
PokktManager.dispatcher.addEventListener(PokktEvent.OFFERWALL_CAMPAIGN_AVAILABLITY_EVENT, onOfferwallAvailability);
PokktManager.dispatcher.addEventListener(PokktEvent.OFFERWALL_CLOSE_EVENT, onOfferwallClosed);
```
4. To show OfferWall you can call PokktManager.getCoins(pokktConfig).
5. Please register native application to handle for resume and call\
PokktManager.getPendingCoins(pokktConfig); this method so that you get a callback to award points to the user after user has come back to your game after finishing with OfferWall.
6. You can call PokktManager.checkOfferWallCampaign(pokktConfig); to check whether the campaigns are available before showing OfferWall button to user. You will get a callback for this call.
**AdConfig (used for reward / non-reward ad)**
1. In AdConfigyou should set screenNameand isRewarded. This screen name will be created on pokkt dashboard.
Screen Name:For screen name, you will have to create in Pokkt dashboard. Please check below screen. This will help you to understand how to create new screen name in Pokkt dashboard.
2. In AdConfig, developer can also set shouldAllowSkip, defaultSkipTime, skipConfirmMessage, backButtonDisabled, shouldAllowMute, shouldSkipConfirm, skipConfirmYesLabel, skipConfirmNoLabel, skipTimerMessageand incentiveMessage. These values can be used to configure the behaviour of ad.
3. If you want to enable/disable the skip button on video screen please set shouldAllowSkipas true/false.The default value for shouldAllowSkip is true.
4. If you have enabled skipped button by setting shouldAllowSkipas true then you can control after how many seconds the skip button will be visible in video by setting defaultSkipTimeto appropriate value.Since most videos will be 30 sec or less please set defaultSkipTimeas 10 or less.You can also give your own skip message by setting skipConfirmMessage on AdConfig
5. The screenNamehas default value as default and can be used by you to give different screen name for different places in your app where you are showing ads. You will control ad targeting based on these screen names which should match exactly with screen names defined in dashboard. ScreenName can not contain white spaces and only special characters allowed are hyphen and underscore.
6. You can choose to show ad with or without incentive to user by setting isRewardedas true or false. Ad gratification will only happen for incentivised playback.
7. You can disable the back button while video is playing by setting backButtonDisabledon AdConfig.
8. You can configure the ad skip dialog yes/no labels by setting skipConfirmYesLabel and skipConfirmNoLabel.
9. You can configure the ad incentive message by setting incentiveMessage.
10. You can configure the ad skip timer message by setting skipTimerMessage. The message must contain a ## placeholder to show skip time value, which will keep changing as per the time.
**Rewarded Ad/Non-Rewarded Ad**
1. You need to set true/false for rewarded or non-rewarded ad like below:
```
adConfig.isRewarded = true/false;
```
2. You will have to call cache ad to start caching ads on device.
```
PokktManager.cacheAd(adConfig)
```
3. You will need to register event for getting callback for Ad related like below and also please check given sample app PlayVideoScreen class.
```
PokktManager.dispatcher.addEventListener(PokktEvent.POKKT_INITIALISED_EVENT, onPokktInitialised);
PokktManager.dispatcher.addEventListener(PokktEvent.AD_AVAILABILITY_STATUS_EVENT, onAdAvailability);
PokktManager.dispatcher.addEventListener(PokktEvent.AD_CACHING_COMPLETED_EVENTS, onAdCachingCompleted);
PokktManager.dispatcher.addEventListener(PokktEvent.AD_CACHING_FAILED_EVENTS, onAdCachingFailed);
PokktManager.dispatcher.addEventListener(PokktEvent.AD_CLOSED_EVENTS, onAdClosed);
PokktManager.dispatcher.addEventListener(PokktEvent.AD_COMPLETED_EVENTS, onAdCompleted);
PokktManager.dispatcher.addEventListener(PokktEvent.AD_SKIPPED_EVENTS, onAdSkipped);
PokktManager.dispatcher.addEventListener(PokktEvent.AD_DISPLAYED_EVENTS, onAdDisplayed);
PokktManager.dispatcher.addEventListener(PokktEvent.AD_GRATIFIED_EVENTS, onAdGratified);
```
4. You can call checkAdAvailability to check if the campaign are available for a particular adConfig before you try to show ad.
```
PokktManager.checkAdAvailability(adConfig)
```
5. You can call showAd method to show ad.
```
PokktManager.showAd(adConfig);
```
6. Please reward user only when AdGratified event gets triggered.
Pokkt SDK allows to show banner ad on your screen. You can set any custom size or any position for banner. There are few fixed position already given in BannerPosition class. But you can customise that also.
1. Load Banner:Use loadBanner to show banner ad like below:
```
PokktManager.loadBanner(ScreenName, BannerPosition.TOP_CENTER);
```
2. Remove Banner:Use removeBanner to remove banner ad from screen like below:
```
PokktManager.removeBanner(ScreenName);
```
3. Auto Refresh Banner:Use setBannerAutoRefresh method to disable or enable auto refresh. Default it is true and it will refresh automatically based on given time on Pokkt dashboard for particular screen name.
```
PokktManager.setBannerAutoRefresh(false/true);
```
4. Banner Position::Use BannerPosition class properties for banner position.
5. Custom Banner:There are also option is given to custom banner size and set custom position by using below method:
```
PokktManager.loadBannerWithRect(ScreenName, width, height, x, y);
```
6. Banner Event:Register event to get banner related callback like below:
```
//Register event
PokktManager.dispatcher.addEventListener(PokktEvent.BANNER_LOADED, onBannerLoaded);
PokktManager.dispatcher.addEventListener(PokktEvent.BANNER_LOAD_FAILED, onBannerLoadFailed);
// Handler method
protected function onBannerLoaded(event:PokktEvent):void {
//event.screenName: same scree name for what banner ad request was done
}
protected function onBannerLoadFailed(event:PokktEvent):void {
//event.screenName: same scree name for what banner ad request was done
//event.message: Reason why banner load failed
}
```
7. Screen Name:For screen name, you will have to create in Pokkt dashboard. Please check below screen. This will help you to understand how to create new screen name in Pokkt dashboard.
**Mediation Info**
1. Pokkt SDK now supports 11 ad networks which you can integrate in your application for better monetisation.
2. To integrate these networks through Pokkt, please visit the mediation menu on downloads page and download AIR mediation zipand documentation zipfiles.
3. Please follow the mediation integration documents shipped for each network.
4. You will need to create account on these networks and add the network details in your Pokkt dashboard after login into your account on pokkt website.
5. You will also need to do the mapping of Pokkt screens with the corresponding ad networks’ placement id/zone id/ad unit etc in the dashboard.
Export Logs
1. Developer should call PokktManager.exportLog()to export the Pokkt SDK logs to folder of your choice.
2. This API shows a folder chooser dialog where user can choose a particular folder.
3. User can also create a new folder where user wants to export the logs.
**Optional Parameters**
PokktConfigalso has provision for developers to provide extra user data available with them to pokkt. We currently support following data points: name, age, sex, mobileNo, emailAddress, location, birthday, maritalStatus, facebookId, twitterHandle, setEducation, setNationality, setEmploymentand setMaturityRating.
***
#### In-App Notifications
Developer can add In-App notifications in their dashboard.
\
Repeat schedule can be daily, weekly monthly. Daily Repeat can have options like frequency of repeat and time in hours of notification.
\
Weekly repeat can have options like frequency of repeat in weeks, days of repeat and time in hours of notification.
\
Monthly repeat can have options like frequency of repeat in months dates of repeat and time in hours for notification.
\
For don't repeat case, there are options like dates and time in hour for notification.
The notifications are listed and can be edited. Notifications can also be deactivated/activated
***
#### 4. Important Points
PPlease do not copy the code points from this pdf as it may introduce unwanted characters and space in your code. Instead please refer to sample app source code in pokkt bundle. Please also refer to sample app source code for better understanding of implementation.
# Marmalade
### Contents
* [1 POKKT SDK v6.0 Integration Guide for Marmalade (Android)](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.1 Overview](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.2 Project Configuration](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.2.1 Dependencies](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.2.2 Manifest](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.2.2.1 Permissions Declarations](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.2.2.2 Activity Declaration](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.2.2.3 Service Declaration](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3 Implementation Steps](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.1 SDK Configuration](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.2 Ad Types](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.2.1 Video](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.2.1.1 Rewarded](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.2.1.2 Non Rewarded](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.2.2 Interstitial](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.2.2.1 Rewarded](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.2.2.2 Non Rewarded](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.2.3 Banner](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.3 Ad Actions](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.3.1 Video](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.3.2 Interstitial](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.3.3 Banner](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.4 Pokkt ad player configuration](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.5 User Details](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.6 Debugging](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.7 Analytics](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.7.1 Google Analytics](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.7.2 Flurry Analytics](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.7.3 MixPanel Analytics](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.7.4 Fabric Analytics](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.3.8 IAP(In App Purchase)](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.4 Pokkt Dashboard](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.4.1 InApp Notifications](broken://pages/noTH8R1kC1J14WOXDNuW)
* [1.4.1.1 Create notifications](broken://pages/noTH8R1kC1J14WOXDNuW)
### POKKT SDK v6.0 Integration Guide for Marmalade (Android)
Last Update: 24th February, 2017
Download Latest Version Here with PDF Documentation v6.0.
***
#### Overview
Thank you for choosing Pokkt SDKfor Maramalade. This document contains all the information required to set up the SDK with your project. We also support mediation for various third party networks. To know the supported third party networks and their integration process go to mediation section .
Before implementing plugins it is mandatory to go through project configuration and implementation steps, as these sections contain mandatory steps for basic SDK integration and are followed by every plugin.
You can download our SDK from pokkt.com.
In the package *PokktNativeExtension.zip*downloaded above you will find:
1. Docs:
Contains documentations for step wise step integration for SDK.
2. PokktAds Demo:
Source code for PokktAds Demo(Sample app) which showcase implementation of Pokkt SDK through code for better understanding.
3. PokktAds Demo.apk:
Application package of PoktkAds Demo, so that you can directly install this apk on your device and have a look how our SDK works instead of compiling the source code.
4. Pokkt Native Extension:
It is the extension project for Pokkt SDK which will be added in main project as sub project in .mkb file
minSdkVersionsupported is 11 .
ScreenName:This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
We will be referencing PokktAds Demoapp provided with SDK. We will be referencing this app during the course of explanation in this document. We suggest you go through the sample app for better understanding.
***
#### Project Configuration
**Dependencies**
* Add Pokkt Native Extension to your project to your *"subprojects"*.
* We expect Google play servicesintegrated in project, although it;s optional but we recommend you to integrate it, as it’s required to fetch AdvertisingIDfor device,which is useful to deliver targeted advertising to Android users.
**Manifest**
**Permissions Declarations**
Add the following permissions to your project manifest
1. Mandatory permissions.
```
```
* android.permission.INTERNET = Required for SDK communication with server.
* android.permission.READ\_PHONE\_STATE = Required for creating unique identifier for you application based on the unique id of the device like IMEI.
2. Optional permissions.
```
```
* android.permission.ACCESS\_NETWORK\_STATE = Required to detect changes in network, like if WIFI is available or not.
* android.permission.ACCESS\_WIFI\_STATE = Required to detect changes in network, like if WIFI is available or not.
* android.permission.CHANGE\_WIFI\_STATE = Required to detect changes in network, like if WIFI is available or not.
* android.permission.WAKE\_LOCK = Required to prevent device from going into the sleep mode during video play.
* android.permission.WRITE\_EXTERNAL\_STORAGE = Required to store media files related to ads in external SD card, if not provided we will use app cache folder to store media files, which will result in unnecessary increase in application’s size. It is recommended to ask for this permission as low end devices generally have less internally memory available.
* android.permission.WRITE\_CALENDAR = Some Ads create events in calendar.
* android.permission.ACCESS\_COARSE\_LOCATION" = Some Ads show content based on user’s location.
* android.permission.ACCESS\_FINE\_LOCATION = Some Ads show content based on user’s location.
* android.permission.CALL\_PHONE = Some Ads are interactive and they provide you a way to call directly from the content.
* android.permission.SEND\_SMS = Some Ads are interactive and they provide you a way to send message.
**Activity Declaration**
Add the following activity in your AndroidManifest for Pokkt SDK integration.
```
```
You can change the android:screenOrientation="landscape"to of your choice, the way you want to display the ads.
**Service Declaration**
Add the following service in your AndroidManifest for receiving InApp notifications. How to set up InApp notifications.
```
```
***
#### Implementation Steps
**SDK Configuration**
1. You need to set extension before calling any method like below. This should be the first call.
```
PCPokktAds::hookCallbackReceiver();
```
2. Set Application Idand Security keyin Pokkt SDK. You can get it from Pokkt dashboard from your account. We generally assign unique application Id and Security key.
```
PCPokktAds::setPokktConfig("", "");
```
3. If you are using server to server integration with Pokkt, you can also set Third Party UserIdin PCPokktAds.
```
PCPokktAds::setThirdPartyUserId("");
```
4. When your application is under development and if you want to see Pokkt logs and other informatory messages, you can enable it by setting shouldDebugto true. Make sure to disable debugging before release.
```
PCPokktAds::shouldDebug();
```
**Ad Types**
**Video**
* Video ad can be rewarded or non-rewarded. You can either cache the ad in advance or directly call show for it.
* We suggest you to cache the ad in advance so as to give seamless play behaviour, In other case it will stream the video which may lead to unnecessary buffering delays depending on the network connection.
**Rewarded**
1. To cache rewarded ad call:
```
PCPokktAds::cacheRewardedVideoAd("");
```
2. To show rewarded ad call:
```
PCPokktAds::showRewardedVideoAd("");
```
**Non Rewarded**
1. To cache non-rewarded ad call:
```
PCPokktAds::cacheNonRewardedVideoAd("");
```
2. To show non-rewarded ad call:
```
PCPokktAds::showNonRewardedVideoAd("");
```
You can check if ad is available or not before making c ache or show request.
```
PCPokktAds::checkRewardedVideoAdAvailability("");
PCPokktAds::checkNonRewardedVideoAdAvailability("");
```
**Interstitial**
**Rewarded**
1. To cache rewarded ad call:
```
PCPokktAds::cacheRewardedInterstitialAd("");
```
2. To show rewarded ad call:
```
PCPokktAds::showNonRewardedInterstitialAd("");
```
**Non Rewarded**
1. To cache non-rewarded ad call:
```
PCPokktAds::cacheNonRewardedInterstitialAd("");
```
2. To show non-rewarded ad call:
```
PCPokktAds::showNonRewardedInterstitialAd("");
```
You can check if ad is available or not before making c ache or show request.
```
PCPokktAds::checkRewardedInterstitialAdAvailability("");
PCPokktAds::checkNonRewardedInterstitialAdAvailability("");
```
There are two ways to load banners:
1. Load banner
```
PCPokktAds::loadBanner(”, );
```
There are predefined positions for banner positioning inside BannerPosition( Com. Pokkt.Plugin.Common.BannerPosition ).
* TOP\_LEFT.
* TOP\_CENTER.
* TOP\_RIGHT.
* MIDDLE\_LEFT.
* MIDDLE\_CENTER.
* MIDDLE\_RIGHT.
* BOTTOM\_LEFT.
* BOTTOM\_CENTER.
* BOTTOM\_RIGHT.
2. Load banner with rect
```
PCPokktAds::initWithBannerAdSize(,,,,,);
```
Height: Custom height for banner.\
Width: Custom width for banner.\
x: Point x on screen to show banner.\
y: Point y on screen to show banner.
3. You can remove Banner using:
```
PCPokktAds::destroyBanner()
```
4. You can also set banner to auto-refresh using:
```
PCPokktAds::setBannerAutoRefresh()
```
**Ad Actions**
Ad actions are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
**Video**
```
PCPokktAds::setAdEventListener(AD_AVAILABILITY_EVENT,
PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdAvailability), this);
PCPokktAds::setAdEventListener(AD_CACHING_COMPLETED_EVENT,PC_ADS_EVENT_
SELECTOR(VideoAdsView::handleAdCachingCompleted), this);
PCPokktAds::setAdEventListener(AD_CACHING_FAILED_EVENT,
PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdCachingFailed), this);
PCPokktAds::setAdEventListener(AD_DISPLAYED_EVENT,
PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdDisplayed), this);
PCPokktAds::setAdEventListener(AD_SKIPPED_EVENT,
PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdSkipped), this);
PCPokktAds::setAdEventListener(AD_COMPLETED_EVENT,
PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdCompleted), this);
PCPokktAds::setAdEventListener(AD_CLOSED_EVENT,
PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdClosed), this);
PCPokktAds::setAdEventListener(AD_GRATIFIED_EVENT,
PC_ADS_EVENT_SELECTOR(VideoAdsView::handleAdGratified), this);
```
**Interstitial**
```
PCPokktAds::setAdEventListener(AD_AVAILABILITY_EVENT,
PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdAvailability), this);
PCPokktAds::setAdEventListener(AD_CACHING_COMPLETED_EVENT,PC_ADS_EVENT_
SELECTOR(InterstitialAdsView::handleAdCachingCompleted), this);
PCPokktAds::setAdEventListener(AD_CACHING_FAILED_EVENT,PC_ADS_EVENT_SELE
CTOR(InterstitialAdsView::handleAdCachingFailed), this);
PCPokktAds::setAdEventListener(AD_DISPLAYED_EVENT,
PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdDisplayed), this);
PCPokktAds::setAdEventListener(AD_SKIPPED_EVENT,
PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdSkipped), this);
PCPokktAds::setAdEventListener(AD_COMPLETED_EVENT,
PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdCompleted), this);
PCPokktAds::setAdEventListener(AD_CLOSED_EVENT,
PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdClosed), this);
PCPokktAds::setAdEventListener(AD_GRATIFIED_EVENT,
PC_ADS_EVENT_SELECTOR(InterstitialAdsView::handleAdGratified), this);
```
```
PCPokktAds::setAdEventListener(BANNER_LOADED_OP,
PC_ADS_EVENT_SELECTOR(BannerAdsView::handleBannerLoadSuccessfuly), this);
PCPokktAds::setAdEventListener(BANNER_LOAD_FAILED_OP,
```
**Pokkt ad player configuration**
Pokkt Ad player works the way App is configured at Pokkt dashboard, but we provide a way to override those settings using PokktAdPlayerViewConfig.
Application should prefer configuration provided through code by developer or what’s configured for the app in dashboard, can be controlled any time through the dashboard itself. If you want to make changes to this configuration after your app distribution, you can contact Pokkt Teamto do the same for your app through admin console.
```
PokktAdPlayerViewConfig adPlayerViewConfig = new PokktAdPlayerViewConfig ();
// set properties values to adPlayerViewConfig
PCPokktAds::setAdPlayerViewConfig(adPlayerViewConfig);
```
Various properties that can be managed through this are:
1. Back button\
Defines if user is allowed to close the Advertisement by clicking on back button or not.\
Property Name: BackButtonDisabled\
Values:\
True = Back button is disabled and user cannot close the Ad.\
False = Back button is not disabled and user can close the Ad.
2. Default skip time\
Defines the time after which user can skip the Ad.\
Property name:DefaultSkipTime\
Values:\
Any Integer value.\
Default value is 10 seconds.
3. Should allow skip\
Defines if user is allowed to skip the Ad or not.\
Property name:ShouldAllowSkip\
Values:\
True = User can skip Ad.\
False = User can’t skip Ad.
4. Should allow mute\
Defines if user is allowed to mute the Video Ad or not.\
Property name:ShouldAllowMute\
Values:\
True = User can mute video Ad.\
False = User can’t mute video Ad.
5. Should confirm skip\
Defines if confirmation dialog is to be shown before skipping the Ad.\
Property name:ShouldConfirmSkip\
Values:\
True = Confirmation dialog will be shown before skipping the video.\
False = Confirmation dialog will not be shown before skipping the video.
6. Skip confirmation message\
Defines what confirmation message to be shown in skip dialog.\
Property name:SkipConfirmMessage\
Values:\
Any String message.\
Default value is “Skipping this video will earn you NO rewards. Are you sure?”.
7. Affirmative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Property name:SkipConfirmYesLabel\
Values:\
Any String message.\
Default value is “Yes”.
8. Negative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Property name:SkipConfirmNoLabel\
Values:\
Any String message.\
Default value is “No”.
9. Skip timer message\
Defines message to be shown before enabling skip button. Don’t forget to add placeholder “ ## ” in your custom message.\
This placeholder is replaced by property “Default skip time” assigned above.\
Property name:SkipTimerMessage\
Values:\
Any String message.\
Default value is “You can skip video in ## seconds”
10. Incentive message\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name:IncentiveMessage\
Values:\
Any String message\
Default value is “more seconds only for your reward !”
11. Should collect feedback\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name:setShouldCollectFeedback\
Values:\
True = If you want to collect feedback from the user for the Ad.\
False = If you don’t want to collect feedback from the user for the Ad.
**User Details**
For better targeting of ads you can also provide user details to our SDK using.
```
PCPokktUserDetails* pokktUserDetails = new PokktUserDetails();
pokktUserDetails -> name =" ";
pokktUserDetails -> age = " ";
pokktUserDetails -> sex = " ";
pokktUserDetails -> mobileNumber = " ";
pokktUserDetails -> emailAddress = " ";
pokktUserDetails -> location = " ";
pokktUserDetails -> birthday = " ";
pokktUserDetails -> maritalStatus = " ";
pokktUserDetails -> facebookId = " ";
pokktUserDetails -> twitterHandle = " ";
pokktUserDetails -> education = " ";
pokktUserDetails -> nationality = " ";
pokktUserDetails -> employment = " ";
pokktUserDetails -> maturityRating = " ";
PokktAds::setUserDetails(pokktUserDetails);
```
**Debugging**
Other than enabling debugging for Pokkt SDK, it can also be used to:
1. Export log
Export your log to your desired location, we generally have it in root directory of SD card, if permission for external storage is provided and in cache folder otherwise.
```
PCPokktAds::exportLog();
```
2. Export log to cloud
You can also export log to cloud.
```
PCPokktAds::exportLogToCloud();
```
**Analytics**
We support various analytics in Pokkt SDK.
Below is mentioned how to enable various analytics with Pokkt SDK.
**Google Analytics**
Google analytics Id can be obtained from Google dashboard.
```
PCPokktAnalyticsDetails* analyticsDetail = new AnalyticsDetails();
analyticsDetail->eventType = “GOOGLE_ANALYTICS”;
analyticsDetail->googleAnalyticsID( "");
PCPokktAds::setAnalyticDetail(analyticsDetail);
```
**Flurry Analytics**
Flurry application key can be obtained from Flurry dashboard.
```
PCPokktAnalyticsDetails* analyticsDetail = new AnalyticsDetails();
analyticsDetail->eventType = ”FLURRY”;
analyticsDetail->flurryApplicationKey("");
PCPokktAds::setAnalyticDetail(analyticsDetail);
```
**MixPanel Analytics**
MixPanel project token can be obtained from MixPanel dashboard.
```
PCPokktAnalyticsDetails* analyticsDetail = new AnalyticsDetails();
aanalyticsDetail->eventType = “MIXPANEL”;
analyticsDetail->mixPanelProjectToken( "");
PCPokktAds::setAnalyticDetail(analyticsDetail);
```
**Fabric Analytics**
Analytics Id is not required in case of Fabric.
```
PCPokktAnalyticsDetails* analyticsDetail = new AnalyticsDetails();
analyticsDetail->eventType = “FABRIC”;
PCPokktAds::setAnalyticDetail(analyticsDetail);
```
**IAP(In App Purchase)**
Call trackIAP to send any In App purchase information to Pokkt.
```
PCIAPDetails* pcIAPDetails = new PCIAPDetails();
pcIAPDetails -> productId("");
pcIAPDetails -> purchaseData("");
pcIAPDetails -> purchaseSignature("");
pcIAPDetails -> purchaseStore(IAPStoreType.GOOGLE);
pcIAPDetails -> price(<100.00>);
PCPokktAds :: setTrackIAP(pcIAPDetails );
```
***
#### Pokkt Dashboard
**InApp Notifications**
Open developer dashboard -> Manage App -> Notifications
**Create notifications**
1. Basic notification information required.
1. Name:
A friendly name for notification. It will help you to distinguish between different notifications.
2. App:
Select your app for which you want to assign notifications.
3. Platform:
Select OS platform for which you want to target notifications.
4. Countries:
Select countries where this notifications will be shown to users. Let’s say if you have users in multiple countries, you can selectively target notifications to them.
5. App version:
Enter your app version for which you want to show notifications. Let’s say you have multiple version installed among users and you want to send different notifications to different users based on their versions.
6. Last seen:
Set minimum and maximum limit in days for which user can remain away from the app.\
Let’s say if min = 2 and max = 4, and user hasn’t open your app for atleast 2 days, you can remind by showing notification, but if 4 days have passed app will not show any more notifications to user.
7. Message:
Message you want to show in notifications bar.
8. Title:
Title for the notification to be shown in notification bar.
2. Schedule notification
Daily
Weekly
Monthly
# Shiva3d
### Contents
* [1 POKKT SDK v4.1.1 Integration Guide for ShiVa (Android)](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.1 1. Introduction](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.2 2. Configuration Steps](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.2.1 Android Manifest xml update](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.3 3. Implementation Steps](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.3.1 Common](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.3.2 Session](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.3.3 OfferWall](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.3.4 AdConfig](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.3.5 Rewarded/Non-Rewarded Ad](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.3.6 Mediation Info](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.3.7 Export Logs](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.3.8 Optional Parameters](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.4 In-App Notifications](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
* [1.5 Important Points](broken://pages/1XRL1nnY0wt06O0Z1ZCV)
### POKKT SDK v4.1.1 Integration Guide for ShiVa (Android)
Last Update: 24th May, 2016
Download Latest Version Here with PDF Documentation v4.1.1.
***
#### 1. Introduction
Thank you for choosing Pokkt SDK Plugin v4.1.1 for ShiVa. Pokkt SDK supports Offerwall as well as Reward-Ad campaigns feature. This document contains all the information that is needed by you to setup the SDK with your project. Please follow these steps as per your integration requirement (Reward/Offerwall/Both). The current plugin supports mediation for various third party ad-networks.
These are:
* AdColony
* AppLovon
* Chartboost
* Fyber
* InMobi
* SuperSonic
* TapJoy
* Vungle
* AdMob
* Facebook
A separate set of documents is provided for each of these, explaining the implementation process.
There is a sample app provided with the SDK. We will be referencing this app during the course of explanation in this document. It is suggested that you should check that app to understand the following process in detail.
***
#### 2. Configuration Steps
The Pokkt SDK v4.1.0 for ShiVa comes in two file. One is ".ste" files and 2nd is ".zip" file. Here is the details
1. com.pokkt.extension\_4.1.ste: This is the plugin which you need to import in project from ShiVa editor (Data Explorer->Import->Archive).
2. PokktSample.ste: This is the Sample Project and it contains few AIModel and HUD. This sample project will show the video campaign and offerwall campaign. One of the AI\_Model (which is AI\_POKKT) from this sample is very important to mplement PokktSDK.
3. res.zip:This is the resource file which is needed. This contains drawable, layoutand valuesfolder. You need to copy in your android project which gets exported from ShiVa tool.
**Android Manifest xml update**
1. Add following permissions in your App xml under android manifest, If not already there.
```
```
2. Add the following activity in your App xml under android manifest for OfferWall Integration
```
```
3. Add the following activity in your App xml under android manifest for Video Integration
```
```
4. Add Following Broadcast receiver for OfferWall Integration in App xml under android manifest
```
```
5. Add the following activity in your App xml under android manifest for Pokkt Interstitial Integration
```
```
6. Add Following meta tag for google play services (Goole play services is required and should be part of your project, if not, please add the GooglePlayService component in project.)
```
```
7. Add a meta data tag for offerwall campaign. you will have to implement the IOfferwallDelegate interface in your project to listen for all offerwall related events. (refer to pokkt sample for example).
```
" />
```
8. Add following Service and receiver in manifest for google analytics (Optional).
```
```
9. Add following Service in manifest for in-app notification.
```
```
Note:Please do not copy the code points from this PDF file as it may introduce unwanted characters and space in your code. Instead please refer to sample app source code provided with the sample app.
***
#### 3. Implementation Steps
Import the POKKT extension (com.pokkt.extension\_4.1.ste) and follow the below steps:
* Import com.pokkt.extension\_4.1.ste in ShiVa Editor from Data Explorer. Now drag this plugin from Data Explorer into Game Editor under plugin section.
* Now import PokktSample.ste where you will see multiple AIModel and HUD. This sample project contains one important AIModel which is AI\_POKKT. This is mandatory to use in your project. This sample project contains few more AIModel which listen event and those gets trigger from AI\_POKKThandler. So update the AI\_POKKT AIModel handler according to your AIModel.\
Here is the example how to do that:
This is one of the event ("onCachingCompletedHandle") from AI\_POKKT.
```
user.sendEvent ( application.getCurrentUser ( ), "AI_PlayVideo", "onCachingCompletedHandle", screenName,isRewarded,backButtonDisabled,defaultSkipTime,shouldAllowSkip,shouldAllowMute,shouldSkipConfirm,skipConfirmMessage,skipConfirmYesLabel,skipConfirmNoLabel,
skipTimerMessage,incentiveMessage,rewardAmount)
```
and handling this event in AI\_PlayVideo AIModel. Please check our given sample.
* Now export the game from Data Explore. On clicking export button will show one popup where select "Runtime Package (.stk)" and select Android as option and then export it. Then will generate .stk file.
* Now export android project of your ShiVa .stk file using ShiVa Authoring tools and do the all required setting for Android in Settings option. There you need to assign path for Android SDK, Android NDK and Cygwin path.
Once it is done then follow the below steps:
1. Select Content tab and give the path of ".stk" file.
2. Select Authoring tab and choose Authoring type as "Project". Also give the Bundle identifier which will be the package ID and Version and Version code.
Once all these two steps are done then click on Build button which will export the Android Project and which you can easily import in Android ID like Eclipse or other ID After importing the project in eclipse or android editor, need to do some changes. Here is the steps:
1. First update AndroidManifest.xml as suggested in 3rd point of this document.
2. Check the downloaded folder which you got from POKKT and get the res.zip. This res.zip contains values, layoutand drawablefolder. So extract the zip file and add it in imported project.
**Common**
1. First we need to set SET\_APPLICATION\_IDand SET\_SECURITY\_KEYwhich you will get once you create new App in Pokkt.com and then call INIT\_POKKT. Please check AI\_MainMenuin our given example.
2. If you are doing server to server integration then please perform operation:
```
PokktNativeExtension.SET_THIRD_PARTY_USER_ID.
```
3. While in development please call
```
PokktNativeExtension.performOperation ( PokktNativeExtension.SET_DEBUG, "true" )
```
to see Pokkt debug log and for showing toast please call
```
PokktNativeExtension.performOperation ( PokktNativeExtension .SHOW_TOAST, "message" ).
```
please make sure to change this for production build.
```
PokktNativeExtension.performOperation ( PokktNativeExtension.SET_DEBUG, "false" ).
```
4. Android MinSDKVersion should be >= 14.
5. To use google analytics, please set AnalyticsType and Analytics ID:
```
PokktNativeExtension.performOperation(PokktNativeExtension.SET_SELECTED_ANALYTICS_TYPE, PokktNativeExtension.GOOGLE_ANALYTICS )
PokktNativeExtension.performOperation(PokktNativeExtension.SET_GOOGLE_ANALYTICS_ID, "ID" )
```
6. To use flurry analytics please set AnalyticsType and Flurry Application Key:
```
PokktNativeExtension.performOperation(PokktNativeExtension.SET_SELECTED_ANALYTICS_TYPE, PokktNativeExtension.ANALYTICS_TYPE_FLURRY)
PokktNativeExtension.performOperation(PokktNativeExtension.SET_FLURRY_APPLICATION_KEY, "ID" )
```
7. To use mix panel analytics please set AnalyticsType and Mix PanelProject Token:
```
PokktNativeExtension.performOperation(PokktNativeExtension.SET_SELECTED_ANALYTICS_TYPE, PokktNativeExtension. ANALYTICS_TYPE_MIXPANEL)
PokktNativeExtension.performOperation(PokktNativeExtension.SET_MIX_PANEL_PROJECT_ID, "ID" )
```
8. To use mix panel analytics please set AnalyticsType and Fabric Token:
```
PokktNativeExtension.performOperation(PokktNativeExtension.SET_SELECTED_ANALYTICS_TYPE, PokktNativeExtension. ANALYTICS_TYPE_FABRIC)
```
9. Please call TRACK\_IAPto send any in-app purchase information to Pokkt. Like below you can do this.
```
PokktNativeExtension.performOperation(PokktNativeExtension.IAP_STORE_SET_CURRENCY_CODE, "" )
PokktNativeExtension.performOperation(PokktNativeExtension.IAP_STORE_SET_DESCRIPTION, "" )
PokktNativeExtension.performOperation(PokktNativeExtension.IAP_STORE_SET_PRICE, "" )
PokktNativeExtension.performOperation(PokktNativeExtension.IAP_STORE_SET_PRODUCT_ID, "" )
PokktNativeExtension.performOperation(PokktNativeExtension.IAP_STORE_SET_PURCHASE_DATE, "" )
PokktNativeExtension.performOperation(PokktNativeExtension.IAP_STORE_SET_PURCHASE_SIGNATURE, "purchaseSignature" )
PokktNativeExtension.performOperation(PokktNativeExtension.IAP_STORE_SET_TITLE, "title" )
PokktNativeExtension.performOperation(PokktNativeExtension.IAP_STORE_SET_PURCHASE_STORE, PokktNativeExtension.IAP_STORE_TYPE_AMAZON )
PokktNativeExtension.performOperation(PokktNativeExtension.TRACK_IAP, "" )
```
**Session**
1. We have option to start session for tracking: startSession and endSession so call these like below:
```
PokktNativeExtension.performOperation(PokktNativeExtension.START_SESSION, "" )
PokktNativeExtension.performOperation(PokktNativeExtension.END_SESSION, "" )
```
2. You should call startSession at the start of his application if you want to use this but this is the optional and call it after setting application id and security key.
3. You should call endSession at the end of his application.
**OfferWall**
1. For OfferWall, you can set two additional parameters which are SET\_OFFERWALL\_ASSETS\_VALUE and SET\_CLOSE\_ON\_SUCCESS\_FLAG. SET\_OFFERWALL\_ASSETS\_VALUEis required if you only want to show campaigns of certain value on OfferWall. So when you call show offerwall campaign, there if you pass the value then it will show such campaign which contains certain value. And if you don't pass then It has default value as empty. SET\_CLOSE\_ON\_SUCCESS\_FLAGis required if you wish to close the OfferWall after user has completed one offer. It’s default value is false.
2. Before calling another method for offerWall, please make sure that you have already called InitPokkt.
3. To show OfferWall please call
```
PokktNativeExtension.performOperation ( PokktNativeExtension.GET_COINS, "" );
```
4. In the screen or activity where you have button to show offerwall, in that activity onResume you should call GET\_PENDING\_COINS so that you get a callback to award points to the user after he has come back to game/app after finishing with OfferWall. You will get a callback for this call in your AI\_POKKTAIModel where onCoinResponseor onCoinResponseWithTrIdwill trigger in case of success otherwise onCoinResponseFailedwill trigger in case of failure.
5. You can call PokktNativeExtension.performOperation ( PokktNativeExtension. CHECK\_OFFERWALL\_CAMPAIGN, "" )to check whether the campaigns are available before showing OfferWall button to user. You will get a callback for this call in your AI\_POKKT.onCampaignAvailabilityimplementation.
**AdConfig**
1. There are few extra setting which need to do for caching/showing Ad. There are few constants are available which need to call using PerformOperation method like below: PokktNativeExtension.performOperation(PokktNativeExtension.ADCONFIG\_IS\_SCREEN\_NAME, "start" ). So set ADCONFIG\_SCREEN\_NAME and ADCONFIG\_IS\_REWARDED. This screen name will be created on pokkt dashboard.
2. developer can also ADCONFIG\_DEFAULT\_SKIP\_TIME, ADCONFIG\_SKIP\_CONFIRMATION\_MESSAGE, ADCONFIG\_BACK\_BUTTON\_DISABLED, ADCONFIG\_SHOULD\_ALLOW\_MUTE, ADCONFIG\_SHOULD\_SKIP\_CONFIRM, ADCONFIG\_SKIP\_CONFIRM\_YES\_LABEL, ADCONFIG\_SKIP\_CONFIRM\_NO\_LABEL, ADCONFIG\_SKIP\_TIMER\_MESSAGE, ADCONFIG\_INCENTIVE\_MESSAGE. These values can be used to configure the behaviour ad.
3. If you want to enable/disable the skip button on video screen please set set ADCONFIG\_SHOULD\_ALLOW\_SKIP as "true"/"false". The default value for set ADCONFIG\_SHOULD\_ALLOW\_SKIP is "true"
4. If you have enabled skipped button by setting ADCONFIG\_SHOULD\_ALLOW\_SKIP as true then you can control after how many seconds the skip button will be visible in video by setting ADCONFIG\_DEFAULT\_SKIP\_TIME to appropriate value. Since most videos will be 30 sec or less please set ADCONFIG\_DEFAULT\_SKIP\_TIME as 10 or less. You can also give your own skip message by setting ADCONFIG\_SKIP\_CONFIRMATION\_MESSAGE.
5. The ADCONFIG\_SCREEN\_NAME has default value as default and can be used by you to give different screen name for different places in your app where you are showing ads. You will control ad targeting based on these screen names which should match exactly with screen names defined in dashboard. ADCONFIG\_SCREEN\_NAME can not contain white spaces and only special characters allowed are hyphen and underscore.
6. You can choose to show ad with or without incentive to user by setting ADCONFIG\_IS\_REWARDED as true or false. Ad gratification will only happen for incentivized playback
7. You can disable the back button while video is playing by setting ADCONFIG\_BACK\_BUTTON\_DISABLED by passing "true"/"false"
8. You can configure the ad skip dialog yes/no labels by setting ADCONFIG\_SKIP\_CONFIRM\_YES\_LABEL and ADCONFIG\_SKIP\_CONFIRM\_NO\_LABEL.
9. You can configure the ad incentive message by setting ADCONFIG\_INCENTIVE\_MESSAGE.
10. You can configure the ad skip timer message by setting ADCONFIG\_SKIP\_TIMER\_MESSAGE. The message must contain a ## placeholder to show skip time value, which will keep changing as per the time.
**Rewarded/Non-Rewarded Ad**
1. You need to set "true"/"false" for rewarded or non-rewarded ad in ADCONFIG\_IS\_REWARDED".
2. You will have to call PokktNativeExtension.performOperation ( PokktNativeExtension.CACHE\_AD\_CAMPAIGN, "" )to start caching ads on device.
3. You can call PokktNativeExtension.performOperation ( PokktNativeExtension.CHECK\_AD\_AVAILABILITY, "" )to check if the campaign are available for a particular adConfig before you try to show ad.
4. You can call PokktNativeExtension.performOperation ( PokktNativeExtension.SHOW\_AD, "" )to show ad.
5. Please reward user only from the OnAdGratifiedcallback method.
**Mediation Info**
Pokkt SDK now supports 10 ad networks which you can integrate in your application for better monetisation.
Please download mediation documentation from Pokkt and follow the process for each mediation network.
**Export Logs**
1. Developer should call PokktNativeExtension.performOperation ( PokktNativeExtension.EXPORT\_LOG, "" ) to export the Pokkt SDK logs to folder of your choice.
2. This API shows a folder chooser dialog where user can choose a particular folder.
3. User can also create a new folder where user wants to export the logs.
**Optional Parameters**
There are also provision for developers to provide extra user data available with them to pokkt. We currently support following data points: name, age, sex, mobileNo, emailAddress, location, birthday, maritalStatus, facebookId, twitterHandle, education, nationality, employment andmaturityRating. For reference, please check testAllMethods in AI\_MainMenuAIModel.
***
#### In-App Notifications
Developer can add In-App notifications in their dashboard.
\
Repeat schedule can be daily, weekly monthly. Daily Repeat can have options like frequency of repeat and time in hours of notification.
\
Weekly repeat can have options like frequency of repeat in weeks, days of repeat and time in hours of notification.
\
Monthly repeat can have options like frequency of repeat in months dates of repeat and time in hours for notification.
\
For don't repeat case, there are options like dates and time in hour for notification.
The notifications are listed and can be edited. Notifications can also be deactivated/activated
***
#### Important Points
Please do not copy the code points from this pdf as it may introduce unwanted characters and space in your code. Instead please refer to sample app source code in pokkt bundle.
Please also refer to sample app source code for better understanding of implementation.
# Xamarin
### Contents
* [1 POKKT SDK v7.5.0 (GDPR Compliance) Integration Guide for Xamarin](broken://pages/we53E1I9zrTwk7QHEl2T)
* [2 Getting Started with Pokkt SDK v7.5.0](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3 Integration Guide v7.5.0](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.1 Overview](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2 Implementation Steps](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.1 SDK Configuration](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.2 Ad Types](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.2.1 Video](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.2.2 Interstitial](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.2.3 Banner](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.3 Ad Actions](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.3.1 Video](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.3.2 Interstitial](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.3.3 Banner](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.4 Pokkt ad player configuration](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.5 User Details](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.6 Pokkt Server Callback Params](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.7 Debugging](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.8 Analytics](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.8.1 Google Analytics](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.8.2 Flurry Analytics](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.8.3 MixPanel Analytics](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.8.4 Fabric Analytics](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.2.9 IAP(In App Purchase)](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3 Project Configuration](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3.1 Android](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3.2 Dependencies](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3.3 Manifest](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3.3.1 Permissions Declarations](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3.3.2 Activity Declaration](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3.3.3 Service Declaration](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3.4 iOS](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3.4.1 Dependencies](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3.4.2 Framework](broken://pages/we53E1I9zrTwk7QHEl2T)
* [3.3.4.3 Info.plist](broken://pages/we53E1I9zrTwk7QHEl2T)
* [4 Migration Note Guide v7.5.0](broken://pages/we53E1I9zrTwk7QHEl2T)
* [4.1 Note](broken://pages/we53E1I9zrTwk7QHEl2T)
###
Last Update: 13th March, 2019
Download Latest Version Here.
***
### Getting Started with Pokkt SDK v7.5.0
1\. Add “ ( PokktExtension.dll, PokktExtension.Droid.dll ) / ( PokktExtension.dll, PokktExtension.iOS.dll ) ” to your project.
2\. Set native extension
```
PokktAds.SetNativeExtentions(new AndroidExtension(this));
PokktAds.SetNativeExtentions(new IosExtension(this));
```
3\. Set *Application Id* and *Security Key* in Pokkt SDK. You can get it from Pokkt dashboard from your account. These are unique per app registered.
```
PokktAds.SetPokktConfig("", "");
```
4\. Set *GDPR consent* in Pokkt SDK. This must be called before calling any ad related API. Developers/Publishers must get the consent from user. For more information on GDPR please refer and . This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting.
```
PokktAds.ConsentInfo consentInfo = new PokktAds.ConsentInfo();
consentInfo. GDPRApplicable = true;
//true if GDPR is applicable.
consentInfo. GDPRConsentAvailable = true;
//true if user has given consent to use personal details for ad targeting.
PokktAds. SetDataAccessConsent (consentInfo);
```
5\. Set the following to enable or disable omission of Pokkt logs and other informatory messages. Make sure to set it to false before release.
```
PokktAds.Debugging.ShouldDebug();
```
6\. You can check if Ad is cached or not using
```
PokktAds.VideoAd.IsAdCached("", );
PokktAds.Interstitial.IsAdCached("", );
```
7\. Show Video Ad with one of the followings:
```
PokktAds.VideoAd.ShowRewarded("");
PokktAds.VideoAd.ShowNonRewarded("");
```
8\. Show Interstitial Ad with one of the followings:
```
PokktAds.Interstitial.ShowRewarded("");
PokktAds.Interstitial.ShowNonRewarded("");
```
9\. For Banner Ad
```
PokktAds.Banner.LoadBanner(, );
PokktAds.Banner.LoadBannerWithRect(,, Width>, ,);
PokktAds.Banner.RemoveBanner();
```
10\. Implement '*Actions* provided in *PokktAds.VideoAd* to listen to video-ad related messages.
11\. Implement *Actions* provided in *PokktAds.Interstitial* to listen to interstitial-ad related messages.
12\. Implement *Actions* provided in *PokktAds.Banner* to listen to banner-ad related messages.
13\. We recommend caching of video-ads for better user experience, you can cache an ad using the followings:
```
PokktAds.VideoAd.cacheRewarded("");
PokktAds.VideoAd.cacheNonRewarded("");
```
### Integration Guide v7.5.0
#### Overview
Thank you for choosing Pokkt SDKfor Xamarin. This document contains all the information required to set up the SDK with your project. We also support mediation for various third party networks. To know the supported third party networks and their integration process go to mediation section .
Before implementing plugins it is mandatory to go through project configuration and implementation steps, as these sections contain mandatory steps for basic SDK integration and are followed by every plugin.
You can download our SDK from pokkt.com.
ScreenName:This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
We will be referencing PokktAds Demoapp provided with SDK. We will be referencing this app during the course of explanation in this document. We suggest you go through the sample app for better understanding.
***
#### Implementation Steps
**SDK Configuration**
1. You need to set extension before calling any method like below. This should be the first call.
```
PokktAds.SetNativeExtentions(new AndroidExtension(this));
PokktAds.SetNativeExtentions(new IosExtension(this));
```
2. Set Application Idand Security keyin Pokkt SDK. You can get it from Pokkt dashboard from your account. We generally assign unique application Id and Security key.
```
PokktAds.SetPokktConfig("", "");
```
3. If you are using server to server integration with Pokkt, you can also set Third Party UserIdin PokktAds.
```
PokktAds.SetThirdPartyUserId("");
```
4. Set *GDPR consent* in Pokkt SDK. This must be called before calling any ad related API. Developers/Publishers must get the consent from user. For more information on GDPR please refer and . This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting.
```
PokktAds.ConsentInfo consentInfo = new PokktAds.ConsentInfo();
consentInfo. GDPRApplicable = true;
//true if GDPR is applicable.
consentInfo. GDPRConsentAvailable = false;
//false if user has given consent to use personal details for ad targeting.
PokktAds. SetDataAccessConsent (consentInfo);
```
5. When your application is under development and if you want to see Pokkt logs and other informatory messages, you can enable it by setting shouldDebugto true. Make sure to disable debugging before release.
```
PokktAds.Debugging.ShouldDebug();
```
**Ad Types**
**Video**
* Video ad can be rewarded or non-rewarded. You can either cache the ad in advance or directly call show for it.
* We suggest you to cache the ad in advance so as to give seamless play behaviour, In other case it will stream the video which may lead to unnecessary buffering delays depending on the network connection.
1. To cache rewarded ad call:
```
PokktAds.VideoAd.CacheRewarded("");
```
2. To show rewarded ad call:
```
PokktAds.VideoAd.ShowRewarded("");
```
3. To cache non-rewarded ad call:
```
PokktAds.VideoAd.CacheNonRewarded("");
```
4. To show non-rewarded ad call:
```
PokktAds.VideoAd.ShowNonRewarded("");
```
5. Check if Ad is already cached
```
PokktAds.VideoAd.isAdCached("", );
```
**Interstitial**
1. To cache rewarded ad call:
```
PokktAds.Interstitial.CacheRewarded("");
```
2. To show rewarded ad call:
```
PokktAds.Interstitial.ShowRewarded("");
```
3. To cache non-rewarded ad call:
```
PokktAds.Interstitial.CacheNonRewarded("");
```
4. To show non-rewarded ad call:
```
PokktAds.Interstitial.ShowNonRewarded("");
```
5. Check if Ad is already cached
```
PokktAds.Interstitial.isAdCached("", );
```
There are two ways to load banners:
1. Load banner
```
PokktManager.LoadBanner(“”, );
```
TThere are predefined positions for banner positioning inside BannerPosition (Com.Pokkt.Plugin.Common.BannerPosition) .
* TOP\_LEFT.
* TOP\_CENTER.
* TOP\_RIGHT.
* MIDDLE\_LEFT.
* MIDDLE\_CENTER.
* MIDDLE\_RIGHT.
* BOTTOM\_LEFT.
* BOTTOM\_CENTER.
* BOTTOM\_RIGHT.
2. Load banner with rect
```
PokktAds.Banner.LoadBannerWithRect(,,,,);
```
Height : Custom height for banner.\
Width: Custom width for banner.\
x: Point x on screen to show banner.\
y: Point y on screen to show banner.
3. You can remove Banner using:
```
PokktAds.Banner.RemoveBanner();
```
**Ad Actions**
Ad actions are optional, but we suggest to implement them as it will help you to keep track of the status of your ad request.
**Video**
```
PokktAds.VideoAd.AdAvailabilityEvent += AdAvailabilityStatus;
PokktAds.VideoAd.AdCachingCompletedEvent += AdCachingCompleted;
PokktAds.VideoAd.AdCachingFailedEvent += AdCachingFailed;
PokktAds.VideoAd.AdDisplayedEvent += AdDisplayed;
PokktAds.VideoAd.AdFailedToShowEvent += AdFailedToShow;
PokktAds.VideoAd.AdSkippedEvent += AdSkipped;
PokktAds.VideoAd.AdCompletedEvent += AdCompleted;
PokktAds.VideoAd.AdClosedEvent += AdClosed;
PokktAds.VideoAd.AdGratifiedEvent += AdGratified;
PokktAds.VideoAd. AdClickedEvent += AdClicked ;
```
**Interstitial**
```
PokktAds.Interstitial.AdAvailabilityEvent += AdAvailabilityStatus;
PokktAds.Interstitial.AdCachingCompletedEvent += AdCachingCompleted;
PokktAds.Interstitial.AdCachingFailedEvent += AdCachingFailed;
PokktAds.Interstitial.AdDisplayedEvent += AdDisplayed;
PokktAds.Interstitial.AdFailedToShowEvent += AdFailedToShow;
PokktAds.Interstitial.AdSkippedEvent += AdSkipped;
PokktAds.Interstitial.AdCompletedEvent += AdCompleted;
PokktAds.Interstitial.AdClosedEvent += AdClosed;
PokktAds.Interstitial.AdGratifiedEvent += AdGratified;
PokktAds.Interstitial. AdClickedEvent += AdClicked
```
```
PokktAds.Banner.BannerLoadedEvent += bannerLoaded;
PokktAds.Banner.BannerLoadFailedEvent += bannerLoadFailed;
PokktAds.Banner. BannerClickedEvent += AdClicked
```
**Pokkt ad player configuration**
Pokkt Ad player works the way App is configured at Pokkt dashboard, but we provide a way to override those settings using PokktAdPlayerViewConfig.
Application should prefer configuration provided through code by developer or what’s configured for the app in dashboard, can be controlled any time through the dashboard itself. If you want to make changes to this configuration after your app distribution, you can contact Pokkt Teamto do the same for your app through admin console.
```
PokktAdPlayerViewConfig adPlayerViewConfig = new PokktAdPlayerViewConfig ();
// set properties values to adPlayerViewConfig
PokktAds.SetAdPlayerViewConfig(adPlayerViewConfig );
```
Various properties that can be managed through this are:
1. Back button\
Defines if user is allowed to close the Advertisement by clicking on back button or not.\
Property Name: BackButtonDisabled\
Values:\
True = Back button is disabled and user cannot close the Ad.\
False = Back button is not disabled and user can close the Ad.
2. Default skip time\
Defines the time after which user can skip the Ad.\
Property name:DefaultSkipTime\
Values:\
Any Integer value.\
Default value is 10 seconds.
3. Should allow skip\
Defines if user is allowed to skip the Ad or not.\
Property name:ShouldAllowSkip\
Values:\
True = User can skip Ad.\
False = User can’t skip Ad.
4. Should allow mute\
Defines if user is allowed to mute the Video Ad or not.\
Property name:ShouldAllowMute\
Values:\
True = User can mute video Ad.\
False = User can’t mute video Ad.
5. Should confirm skip\
Defines if confirmation dialog is to be shown before skipping the Ad.\
Property name:ShouldConfirmSkip\
Values:\
True = Confirmation dialog will be shown before skipping the video.\
False = Confirmation dialog will not be shown before skipping the video.
6. Skip confirmation message\
Defines what confirmation message to be shown in skip dialog.\
Property name:SkipConfirmMessage\
Values:\
Any String message.\
Default value is “Skipping this video will earn you NO rewards. Are you sure?”.
7. Affirmative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Property name:SkipConfirmYesLabel\
Values:\
Any String message.\
Default value is “Yes”.
8. Negative label for skip dialog\
Defines what should be the label for affirmative button in skip dialog.\
Property name:SkipConfirmNoLabel\
Values:\
Any String message.\
Default value is “No”.
9. Skip timer message\
Defines message to be shown before enabling skip button. Don’t forget to add placeholder “ ## ” in your custom message.\
This placeholder is replaced by property “Default skip time” assigned above.\
Property name:SkipTimerMessage\
Values:\
Any String message.\
Default value is “You can skip video in ## seconds”
10. Incentive message\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name:IncentiveMessage\
Values:\
Any String message\
Default value is “more seconds only for your reward !”
11. Should collect feedback\
Defines message to be shown during video progress, that after what time user will be incentivised.\
Property name:setShouldCollectFeedback\
Values:\
True = If you want to collect feedback from the user for the Ad.\
False = If you don’t want to collect feedback from the user for the Ad.
12. Audio Enabled\
Provides a medium to disable audio for video ad without user interaction.\
Property name:IsAudioEnabled\
Values:\
True = If you want to play audio for video ad.\
False = If you don’t want to play audio for video ad.
**User Details**
For better targeting of ads you can also provide user details to our SDK using.
```
PokktUserDetails pokktUserDetails = new PokktUserDetails();
pokktUserDetails.Name = "";
pokktUserDetails.Age = "";
pokktUserDetails.Sex = "";
pokktUserDetails.MobileNo = "";
pokktUserDetails.EmailAddress = "";
pokktUserDetails.Location = "";
pokktUserDetails.Birthday = "";
pokktUserDetails.MaritalStatus = "";
pokktUserDetails.FacebookId = "";
pokktUserDetails.TwitterHandle = "";
pokktUserDetails.Education = "";
pokktUserDetails.Nationality = "";
pokktUserDetails.Employment = "";
pokktUserDetails.MaturityRating = "";
PokktAds.SetUserDetails(pokktUserDetails);
```
**Pokkt Server Callback Params**
Developer can set some values in POKKT SDK that they need to be sent to their server via POKKT Server callbacks.
```
Dictionary extraParam = new Dictionary();
extraParam.put("testdata","{\"adnetwork\": \"pokkt\"}");
PokktAds.SetCallbackExtraParams(extraParam);
```
**Debugging**
Other than enabling debugging for Pokkt SDK, it can also be used to:
1. Export log
Export your log to your desired location, we generally have it in root directory of SD card, if permission for external storage is provided and in cache folder otherwise.
```
PokktAds.Debugging.ExportLog();
```
2. Export log to cloud
You can also export log to cloud.
```
PokktAds.Debugging.ExportLogToCloud();
```
**Analytics**
We support various analytics in Pokkt SDK.
Below is mentioned how to enable various analytics with Pokkt SDK.
**Google Analytics**
Google analytics Id can be obtained from Google dashboard.
```
AnalyticsDetails analyticsDetail = new AnalyticsDetails();
analyticsDetail.SelectedAnalyticsType = AnalyticsType.GOOGLE_ANALYTICS;
analyticsDetail.GoogleAnalyticsId = "Google Analytics Id";
PokktAds.Analytics.SetAnalyticsDetails(analyticsDetail);
```
**Flurry Analytics**
Flurry application key can be obtained from Flurry dashboard.
```
AnalyticsDetails analyticsDetail = new AnalyticsDetails();
analyticsDetail.SelectedAnalyticsType = AnalyticsType.FLURRY;
analyticsDetail.FlurryApplicationKey = "Flurry Application Key";
PokktAds.Analytics.SetAnalyticsDetails(analyticsDetail);
```
**MixPanel Analytics**
MixPanel project token can be obtained from MixPanel dashboard.
```
AnalyticsDetails analyticsDetail = new AnalyticsDetails();
analyticsDetail.SelectedAnalyticsType = AnalyticsType.MIXPANEL;
analyticsDetail.MixPanelProjectToken = "MixPanel Project Token";
PokktAds.Analytics.SetAnalyticsDetails(analyticsDetail);
```
**Fabric Analytics**
Analytics Id is not required in case of Fabric.
```
AnalyticsDetails analyticsDetail = new AnalyticsDetails();
analyticsDetail.SelectedAnalyticsType = AnalyticsType.FABRIC;
analyticsDetail.FabricAnalyticsId = "Fabric Analytics Id";
PokktAds.Analytics.SetAnalyticsDetails(analyticsDetail);
```
**IAP(In App Purchase)**
Call trackIAP to send any In App purchase information to Pokkt.
```
InAppPurchaseDetails inAppPurchaseDetails = new InAppPurchaseDetails();
inAppPurchaseDetails.ProductId = "";
inAppPurchaseDetails.PurchaseData = "";
inAppPurchaseDetails.PurchaseSignature = "";
inAppPurchaseDetails.PurchaseStore = IAPStoreType.GOOGLE;
inAppPurchaseDetails.Price = <100.00>;
PokktAds.Analytics.trackIAP(inAppPurchaseDetails);
```
***
#### Project Configuration
**Android**
In the package downloaded above you will find:
1. Docs:
Contains documentations for step wise step integration for SDK.
2. PokktAds Demo
Source code for *PokktAds Demo*(Sample app) which showcase implementation of Pokkt SDK through code for better understanding.
3. Extensions:
*PokktExtension.dll*, *PokktExtension.Droid.dll* and *PokktExtension.iOS.dll* both of these are required by Pokkt SDK and should be added to project
minSdkVersionsupported is 11 .
**Dependencies**
* Add PokktExtension.dll and PokktExtension.Droid.dll with analytics to your project as *"Reference"*.
* Add *support-v4.jar*
* We expect Google play services integrated in project, although it;s optional but we recommend you to integrate it, as it’s required to fetch AdvertisingID for device,which is useful to deliver targeted advertising to Android users.
**Manifest**
**Permissions Declarations**
Add the following permissions to your project manifest
1. Mandatory permissions.
```
```
* android.permission.INTERNET = Required for SDK communication with server.
* android.permission.ACCESS\_NETWORK\_STATE = Required to detect changes in network, like if WIFI is available or not.
2. Optional permissions.
```
```
* android.permission.WAKE\_LOCK = Required to prevent device from going into the sleep mode during video play.
* android.permission.WRITE\_EXTERNAL\_STORAGE = Required to store media files related to ads in external SD card, if not provided we will use app cache folder to store media files, which will result in unnecessary increase in application’s size. It is recommended to ask for this permission as low end devices generally have less internally memory available.
* android.permission.WRITE\_CALENDAR = Some Ads create events in calendar.
* android.permission.ACCESS\_FINE\_LOCATION = Some Ads show content based on user’s location
* android.permission.VIBRATE = Some Ads provide haptic feedback, so as to maintain their behaviorwe need this permission
**Activity Declaration**
Add the following activity in your AndroidManifest for Pokkt SDK integration.
```
```
You can change the android:screenOrientation="landscape" to of your choice, the way you want to display the ads.
**Service Declaration**
Add the following service in your AndroidManifest for receiving InApp notifications. How to set up InApp notifications see “Pokkt Dashboard” document.
```
```
**iOS**
**Dependencies**
* Add PokktExtension.dll and PokktExtension.iOS.dll with analytics to your project as *"Reference"*.
* If you are using Visual Studio Code\
Navigate to "Select iOS project -> Project Options -> Build -> iOS Build" and then enter following arguments in "Additional m touch arguments" text box:
```
-gcc_flags "-ObjC -framework CoreMotion -framework CoreData -framework Foundation -framework MediaPlayer -framework SystemConfiguration -framework UIKit -framework CoreTelephony -framework EventKit -framework AdSupport -framework CoreGraphics -framework CoreMotion -framework MessageUI -framework EventKitUI -framework CoreLocation -framework AVFoundation" to Additional mtouch arguments
```
**Framework**
```
CoreData.framework
ARKit.framework
Foundation.framework
MediaPlayer.framework
SystemConfiguration.framework
UIKit.framework
CoreTelephony.framework
EventKit.framework
AdSupport.framework
CoreGraphics.framework
CoreMotion.framework
MessageUI.framework
EventKitUI.framework
CoreLocation.framework
AVFoundation.framework
libc++.tbd
libsqlite3.tbd
```
**Info.plist**
Add the below exceptions to your application info.plist.
```
NSAppTransportSecurityNSExceptionDomainspokkt.comNSIncludesSubdomainsNSExceptionAllowsInsecureHTTPLoadsNSExceptionRequiresForwardSecrecyNSExceptionMinimumTLSVersionTLSv1.2NSThirdPartyExceptionAllowsInsecureHTTPLoadsNSThirdPartyExceptionRequiresForwardSecrecyNSThirdPartyExceptionMinimumTLSVersionTLSv1.2NSRequiresCertificateTransparencycloudfront.netNSIncludesSubdomainsNSExceptionAllowsInsecureHTTPLoadsNSExceptionRequiresForwardSecrecyNSExceptionMinimumTLSVersionTLSv1.2NSThirdPartyExceptionAllowsInsecureHTTPLoadsNSThirdPartyExceptionRequiresForwardSecrecyNSThirdPartyExceptionMinimumTLSVersionTLSv1.2NSRequiresCertificateTransparency
```
***
### Migration Note Guide v7.5.0
**Note**
* In case of any query regarding integration, refer\
*"POKKT\_SDK\_Integration\_Guide(\_v7.5.0\_Xamarin\_Android)"* for this version provided inside "Pokkt\_SDK\_7.5.0\_Xamarin\_Android".
1. Removed callbacks\
videoAdAvailabilityStatus and interstitialAvailabilityStatus are removed from the Video and Interstitial ads respectively and so are the CheckAdAvailability API.
2. PokktAdPlayerViewConfig\
PokktAdPlayerViewConfig is renamed to PokktAdViewConfig.
# Cordova/PhoneGap
### Contents
* [1 POKKT SDK v7.6.0 (GDPR Compliance) Integration Guide for Cordova](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.1 Overview](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2 Project Configuration](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2.1 Android](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2.2 Dependencies](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2.3 Manifest](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2.3.1 Permissions Declarations](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2.3.2 Activity Declaration](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2.3.3 Service Declaration](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2.4 iOS](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2.5 Dependencies](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2.6 Framework](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.2.7 Info.plist](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3 Implementation Steps](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.1 SDK Configuration](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.2 Ad Types](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.2.1 Video](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.2.2 Interstitial](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.2.3 Banner](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.3 Ad Delegates](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.3.1 Video](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.3.2 Interstitial](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.3.3 Banner](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.4 Pokkt ad player configuration](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.5 User Details](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.6 Pokkt Server Callback Params](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.7 Debugging](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.8 Analytics](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.8.1 Google Analytics](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.8.2 Flurry Analytics](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.8.3 MixPanel Analytics](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.8.4 Fabric Analytics](broken://pages/0kKAA0CezrL0o6eUe6RB)
* [1.3.8.5 IAP(In App Purchase)](broken://pages/0kKAA0CezrL0o6eUe6RB)
###
Last Update: 22nd November, 2019
Download Latest Version Here.
***
#### Overview
Thank you for choosing Pokkt SDK for Cordova. This document contains all the information required to set up the SDK with your project. We also support mediation for various third party networks. To know the supported third party networks and their integration process go to mediation section.
Before implementing plugins it is mandatory to go through project configuration and implementation steps, as these sections contain mandatory steps for basic SDK integration and are followed by every plugin.
minSdkVersionsupported is 11 .
ScreenName:This one parameter is accepted by almost all API’s of Pokkt SDK. This controls the placement of ads and can be created on Pokkt Dashboard.
We will be referencing PokktAds Demo app provided with SDK during the course of explanation in this document. We suggest you go through the sample app for better understanding.
***
#### Project Configuration
**Android**
In the package downloaded above you will find:
1. Docs:
Contains step wise step integration for SDK.
2. PokktCordovaDemo app code.
3. PokktCordovaDemo.apk:
Application package of Pokkt Cordova Demo, so that you can directly install this apk on your device and have a look how our SDK works instead of compiling the source code.
4. SDK + Plugin:
1. JAR
* PokktSDK\_v7.6.0.jar
* PAPCordova.jar
* pokktsdk360ext.jar
2. Dependencies
* Android-support-v4.jar
* google-play-services.jar
minSdkVersionsupported is 11.
**Dependencies**
* Extract the provided file "cordova-plugin-pokkt.zip" into a directory. Execute the following command from your terminal:\
$cordova plugin add */ \ /cordova-plugin-pokkt/*
* We expect Google play services integrated in project, although it is optional but we recommend you to integrate it, as it is required to fetch AdvertisingID for device,which is useful to deliver targeted advertising to Android users.
**Manifest**
**Permissions Declarations**
We have already added the following mandatory permissions to the manifest via plugin.xml
1. Mandatory permissions.
```
```
* android.permission.INTERNET = Required for SDK communication with server.
* android.permission.ACCESS\_NETWORK\_STATE = Required to detect changes in network, like if WIFI is available or not.
2. Optional permissions. We have commented out these in plugin.xml. Please uncomment those for better ad delivery and ad experience.
```
```
* android.permission.WAKE\_LOCK = Required to prevent device from going into the sleep mode during video play.
* android.permission.WRITE\_EXTERNAL\_STORAGE = Required to store media files related to ads in external SD card, if not provided we will use app cache folder to store media files, which will result in unnecessary increase in application’s size. It is recommended to ask for this permission as low end devices generally have less internally memory available.
* android.permission.WRITE\_CALENDAR = Some Ads create events in calendar.
* android.permission.ACCESS\_FINE\_LOCATION = Some Ads show content based on user’s location
* android.permission.VIBRATE = Some Ads provide haptic feedback, so as to maintain their behavior we need this permission
**Activity Declaration**
We have already added the following activity in your AndroidManifest for Pokkt SDK integration via plugin.xml
```
```
You can change the android:screenOrientation="landscape"to of your choice, the way you want to display the ads.
**Service Declaration**
We have already added the following service in your AndroidManifest for receiving InApp notifications. How to set up InApp notifications see “Pokkt Dashboard” document.
```
```
**iOS**
In the package downloaded above you will find:
1. Docs:
Contains documentations for step wise step integration for SDK.
2. PokktSDK\_v7.6.0:
1. PokktSDK.framework
**Dependencies**
* Extract the provided file "cordova-plugin-pokkt.zip" into a directory. Execute the following command from your terminal:\
$cordova plugin add */ \ /cordova-plugin-pokkt/*
**Framework**
```
CoreData.framework
ARKit.framework
Foundation.framework
MediaPlayer.framework
SystemConfiguration.framework
UIKit.framework
CoreTelephony.framework
EventKit.framework
AdSupport.framework
CoreGraphics.framework
CoreMotion.framework
MessageUI.framework
EventKitUI.framework
CoreLocation.framework
AVFoundation.framework
libc++.tbd
```
**Info.plist**
Add the below exceptions to your application info.plist.
```
NSAppTransportSecurityNSExceptionDomainspokkt.comNSIncludesSubdomainsNSExceptionAllowsInsecureHTTPLoadsNSExceptionRequiresForwardSecrecyNSExceptionMinimumTLSVersionTLSv1.2NSThirdPartyExceptionAllowsInsecureHTTPLoadsNSThirdPartyExceptionRequiresForwardSecrecyNSThirdPartyExceptionMinimumTLSVersionTLSv1.2NSRequiresCertificateTransparencycloudfront.netNSIncludesSubdomainsNSExceptionAllowsInsecureHTTPLoadsNSExceptionRequiresForwardSecrecyNSExceptionMinimumTLSVersionTLSv1.2NSThirdPartyExceptionAllowsInsecureHTTPLoadsNSThirdPartyExceptionRequiresForwardSecrecyNSThirdPartyExceptionMinimumTLSVersionTLSv1.2NSRequiresCertificateTransparency
```
***
#### Implementation Steps
**SDK Configuration**
1. For all invocation of Pokkt SDK developer will make use of methods available in pokktAds.jsfile using PokktExtensionobject.
2. Set Application Idand Security keyin Pokkt SDK. You can get it from Pokkt dashboard from your account. These are unique per app registered.
```
pe = window.plugins.pokktExtension;
pe.setPokktConfig("", "");
```
3. Set *GDPR consent* in Pokkt SDK. This must be called before calling any ad related API. Developers/Publishers must get the consent from user. For more information on GDPR please refer and . This API can again be used by publishers to revoke the consent. If this API is not called or invalid data provided then SDK will access the users personal data for ad targeting.
```
var gdprConsent =
{GDPRApplicable:,GDPRConsentAvailable:};
//GDPRApplicable true if GDPR is applicable.
//GDPRConsentAvailable true if user has given consent to use personal details
for ad targeting.
pe.setDataAccessConsent(JSON.stringify(gdprConsent));
```
4. If you are using server to server integration with Pokkt, you can also set Third Party UserIdin PokktAds.
```
pe.setThirdPartyUserId("");
```
5. When your application is under development and if you want to see Pokkt logs and other informatory messages, you can enable it by setting setDebugto true . Make sure to disable debugging before release.
```
pe.setDebug();
```
**Ad Types**
**Video**
* Video ad can be rewarded or non-rewarded. You can either cache the ad in advance or directly call show for it.
* We suggest you to cache the ad in advance so as to give seamless play behaviour, In other case it will stream the video which may lead to unnecessary buffering delays depending on the network connection.
1. To cache rewarded ad call:
```
pe.cacheRewardedVideoAd("");
```
2. To show rewarded ad call:
```
pe.showRewardedVideoAd("");
```
3. To cache non-rewarded ad call:
```
pe.cacheNonRewardedVideoAd("");
```
4. To show non-rewarded ad call:
```
pe.showNonRewardedVideoAd("");
```
5. To check if video ad is cached:
```
pe.isVideoAdCached("",