Marmalade

From POKKT DOCUMENTATION
Jump to: navigation, search

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.zipdownloaded 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.

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />
    • 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.

    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
    <uses-permission android:name="android.permission.WAKE_LOCK" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.WRITE_CALENDAR" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.CALL_PHONE" />
    <uses-permission android:name="android.permission.SEND_SMS" />
    • 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.

<activity
   android:name="com.pokkt.sdk.userinterface.presenter.activity.PokktAdActivity"
   android:configChanges="keyboard|keyboardHidden|navigation|orientation|screenLayout|uiMode|screenSize|smallestScreenSize"
   android:hardwareAccelerated="true"
   android:label=”Pokkt”
   android:screenOrientation="landscape"
   android:windowSoftInputMode="stateAlwaysHidden|adjustUnspecified" />

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.

<service
   android:name="com.pokkt.sdk.notification.NotificationService"
   android:exported="false"
   android:label="PokktNotificationService" />

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("<Pokkt Application ID>", "<Pokkt Security Key>");
  3. If you are using server to server integration with Pokkt, you can also set Third Party UserIdin PCPokktAds.

    PCPokktAds::setThirdPartyUserId("<Third party user Id>");
  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(<true>);

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("<ScreenName>");
  2. To show rewarded ad call:

    PCPokktAds::showRewardedVideoAd("<ScreenName>");
Non Rewarded
  1. To cache non-rewarded ad call:

    PCPokktAds::cacheNonRewardedVideoAd("<ScreeName>");
  2. To show non-rewarded ad call:

    PCPokktAds::showNonRewardedVideoAd("<ScreeName>");

You can check if ad is available or not before making c ache or show request.

PCPokktAds::checkRewardedVideoAdAvailability("<ScreeName>");
PCPokktAds::checkNonRewardedVideoAdAvailability("<ScreeName>");
Interstitial
Rewarded
  1. To cache rewarded ad call:

    PCPokktAds::cacheRewardedInterstitialAd("<ScreeName>");
  2. To show rewarded ad call:

    PCPokktAds::showNonRewardedInterstitialAd("<ScreeName>");
Non Rewarded
  1. To cache non-rewarded ad call:

    PCPokktAds::cacheNonRewardedInterstitialAd("<ScreeName>");
  2. To show non-rewarded ad call:

    PCPokktAds::showNonRewardedInterstitialAd("<ScreeName>");

You can check if ad is available or not before making c ache or show request.

PCPokktAds::checkRewardedInterstitialAdAvailability("<ScreeName>");
PCPokktAds::checkNonRewardedInterstitialAdAvailability("<ScreeName>");

There are two ways to load banners:

  1. Load banner

    PCPokktAds::loadBanner(<screenName>”, <BannerPosition>);

    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(<ScreenName>,<Height>,<Width>,<x>,<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:

    PCPokktAds::destroyBanner()
  4. You can also set banner to auto-refresh using:

    PCPokktAds::setBannerAutoRefresh(<true/false>)

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( "<Google Analytics Id>");
PCPokktAds::setAnalyticDetail(analyticsDetail);
Flurry Analytics

Flurry application key can be obtained from Flurry dashboard.

PCPokktAnalyticsDetails* analyticsDetail = new AnalyticsDetails();
analyticsDetail->eventType = ”FLURRY”;
analyticsDetail->flurryApplicationKey("<Flurry Application Key>");
PCPokktAds::setAnalyticDetail(analyticsDetail);
MixPanel Analytics

MixPanel project token can be obtained from MixPanel dashboard.

PCPokktAnalyticsDetails* analyticsDetail = new AnalyticsDetails();
aanalyticsDetail->eventType = “MIXPANEL”;
analyticsDetail->mixPanelProjectToken( "<MixPanel Project Token>");
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("<productId>");
pcIAPDetails -> purchaseData("<purchaseData>");
pcIAPDetails -> purchaseSignature("<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.

    Basic-filters.jpg

    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.

    Message.jpg

  2. Schedule notification

    Daily

    Daily.jpg

    Weekly

    Weekly.jpg

    Monthly

    Monthly.jpg