串接准备

在开始串接 SDK 前，请确认您已经拥有 Vpon 开发商帐号，并已经取得您的 License Key。如果您还没完成注册，请先注册帐号。

取得 Vpon 开发商帐号后，请参考以下说明完成 Vpon Android SDK 的串接：

导入 SDK 到您的专案中
加入所需的 3rd-party Library
在 AndroidManifest.xml 中宣告 com.vpadn.widget.VponActivity
在 AndroidManifest.xml 中设定必要的 Permission
在 Application 或 MainActivity 初始化 SDK

导入 SDK

您可以使用 Gradle 来导入 Vpon SDK。

开启 Android Studio Project 层级的 build.gradle 档案，在下方所示在 allprojects 的 repositories 加入 Maven Repository

allprojects {
    repositories {
        maven{
            url 'https://m.vpon.com/sdk/android/maven'
        }
    }
}

加入 Maven Repository 后，即可在 App 层级下的 build.gradle 加入 Vpon SDK 指定版本的编译相依性

dependencies {
    ...
    implementation 'com.vpon:vpadnSDK:latest.release'
}

3rd-party Library

从 4.8.0 版开始，Vpon SDK 引入第三方的 Library － Retrofit，请参考以下方法导入 Retrofit：

手动下载导入：由此直接下载 Retrofit 的 jar 档并导入专案中
透过 Maven 导入：在 App 层级下的 build.gradle 的 dependencies 中加入以下内容导入 Retrofit:

dependencies {
    implementation 'com.squareup.retrofit2:retrofit:2.6.2'
    implementation 'org.jetbrains.kotlin:kotlin-stdlib:1.6.21'
    implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4'

    <!-- Import required Google Play Service -->
    implementation 'com.google.android.gms:play-services-ads-identifier:17.0.0'
    <!-- Import required dependency if you are using Vpon SDK v5.3.2 and above -->
    implementation 'com.google.android.gms:play-services-appset:16.0.0'
}

宣告 VpadnActivity

请在您的 AndroidManifest.xml 加入以下内容：

<!-- Please add below script if you're using SDK v5.0.2 or above-->
<activity android:name="com.vpon.ads.VponAdActivity"
android:configChanges="orientation|keyboardHidden|navigation|keyboard|screenLayout|uiMode|screenSize|smallestScreenSize"
android:theme="@android:style/Theme.Translucent"
android:hardwareAccelerated="true"/>

Note：上面每一个属性都不能少,其值都需要相同！

此外，由于 Vpon SDK 4 开始支援影音形式的广告，建议您在放广告的 Activity 中加入硬体加速，请参考如下：

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

加入 Permission

请在您的 AndroidManifest.xml 加入以下 Permission：

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

初始化 SDK

为了提高 SDK 的效能，请在 Application 或 MainActivity 初始化 SDK：

// Initial SDK in Application
public class CustomApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        VponMobileAds.initialize(getBaseContext());
    }
}

Proguard Configuration

如果您的 App 使用 Vpon Android SDK v5.0.2 或以下版本的 SDK，请在 Proguard Config 中增加以下设定：

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

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

Tips

关于更多广告形式的呈现，请参考：

Android - 串接说明