Skip to main content

Android SDK

Prerequisites

Before you start to integrate Vpon SDK, please make sure you already have your own Vpon Publisher Account and get your License Key. Register as a Vpon Publisher if you haven’t own your Publisher Account.

Once you have your own Publisher Account, follow the instruction below to integrate Vpon Android SDK:

  1. Import SDK to your project.
  2. Add com.vpadn.widget.VpadnActivity to your AndroidManifest.xml
  3. Add required Permission to your AndroidManifest.xml

Import SDK to your project

Vpon provides two ways to integrate our SDK. Choose one of the following two options:

Note: If you’ve integrated Vpon SDK before, check How to update SDK first.

Integrate SDK with Maven

Note: Maven is a build automation tool used primarily for Java projects. If you haven’t installed Maven in your device for development, please refer to Maven Introduction.

Add Vpon’s Maven repository in allprojects section in the project-level build.gradle file.

allprojects {
    repositories {
        jcenter()
        maven{
            url 'https://dl.bintray.com/vpon-sdk/maven'
        }
    }
}

Add the dependency with a specified version of Vpon SDK in the app-level build.gradle file (Here take SDK 4.9.1 for example).

dependencies {
    ...
    implementation 'com.vpon:vpadnSDK:4.9.1'

    // Please add Android support library as below if you are using Vpon SDK 4.8+
    // The version of the dependency will depend on the version of the compile sdk you are using
    implementation 'com.android.support:appcompat-v7:28.0.0'
}

Note: You can revise 'com.vpon:vpadnSDK:4.7.0' to 'com.vpon:vpadnSDK:4.9.+' to import the latest SDK in version 4.7.

Integrate SDK manually

Please follow the instruction below to integrate Vpon SDK to your application manually:

  1. Download latest Vpon SDK here
  2. Import Vpon SDK to your Android Studio project

Android Studio

  1. Find libs in your Android project (Directory：Project Name -> app -> libs)

  2. Right click on libs and choose to Reveal in Finder

  3. Move the SDK (.jar / .aar) to libs (You can also grab the file into libs in IDE)

  4. Go back to your Android project and you will see the SDK (.jar / .aar) we just added shows in the [libs] folder. Right click on the SDK (.jar) and choose Add as library to link reference.

Open build.gradle in App-level, modify dependencies as below:

dependencies {
    ...
    implementation fileTree(include: ['*.jar', '*.aar'], dir: 'libs')
}

Please check the build.gradle to see if the .jar / .aar file show in the dependencies as the picture below:

VpadnActivity

Add com.vpadn.widget.VpadnActivity to your AndroidManifest.xml.

<activity
  android:name="com.vpadn.widget.VpadnActivity"
  android:configChanges="orientation|keyboardHidden|navigation|keyboard|screenLayout|uiMode|screenSize|smallestScreenSize"
  android:theme="@android:style/Theme.Translucent"
  android:hardwareAccelerated="true">
</activity>

Note: EVERY attribute is required!

Permission

Add permissions below to your AndroidManifest.xml.

<!-- Required Permissions -->
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

<!-- Optional Permissions. Use for optimize ad performance -->
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>

Since we started to support Video ads from Vpon SDK 4, we recommend that you can add the scripts below to your Activity which contain ads to accelerate hardward performance.

<activity
  android:name="com.vpadn.example.MainActivity"
  android:label="@string/app_name"
  android:configChanges="keyboardHidden|orientation"
  android:hardwareAccelerated="true">
  <intent-filter>
    <action android:name="android.intent.action.MAIN"/>
    <category android:name="android.intent.category.LAUNCHER"/>
  </intent-filter>
</activity>

3rd-party Library

Vpon SDK start to import 3rd-party Library - Retrofit from 4.8.0, please follow the steps below to import Retrofit:

  1. Import Retrofit manually: Download Retrofit here and import the .jar file to your project.
  2. Import Retrofit with Maven: Please add the snippet below to your build.gradle in App-level to import Retrofit.
dependencies {
    ...
    implementation 'com.squareup.retrofit2:retrofit:2.4.0'
}

Proguard Configuration

If your app need obfuscateed before release, please add settings below：

-dontwarn c.**
-dontwarn com.vpon.**
-dontwarn vpadn.**
-keep class c.**{ *; }
-keep class com.vpon.** { *; }
-keep class vpon.** { *; }
-keep class com.vpadn.** { *; }
-keep class vpadn.** { *; }

<!-- ----------- acquired since 4.8.0 start --------- -->
-dontnote retrofit2.Platform
-dontwarn retrofit2.Platform$Java8
-dontwarn okhttp3.internal.platform.*
-keepattributes Exceptions
-keepattributes Signature
-dontwarn okio.**
-dontwarn javax.annotation.**
<!-- ----------- acquired since 4.8.0 end --------- -->

Tips

For more ad types, please refer to: