Skip to main content

Android - 串接说明

串接准备


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

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

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

导入 SDK


Vpon 提供以下两种串接广告 SDK 的方式:

Note:若您曾使用过旧版 SDK,请先阅读:如何升级 SDK 版本

精简 (搭配 Maven)


Note:Maven 是一个项目管理及项目自动建构的工具,如果您还没在开发用的装置中安装过 Maven,请参考 Maven 安装指南

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

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

加入 Maven Repository 后,即可在 App 层级下的 build.gradle 加入 Vpon SDK 指定版本的编译相依性( 此处以 SDK 4.9.1为例)

dependencies {
    ...
    implementation 'com.vpon:vpadnSDK:5.1.5'
}

Note

  • 若要更新 SDK,可改为 implementation 'com.vpon:vpadnSDK:4.9.+',即可获取 SDK 版本号 4.9 中最新的版本
  • 若您的 App 支援 targetSdkVersion 30+,请务必使用 SDK v5.1.5 以上版本

手动 (手动下载并串接)

要手动在应用程式中加入 Vpon SDK,您必须完成以下步骤:

  1. 由此下载最新版本的 Vpon SDK
  2. 在 Android Studio 专案中加入 Vpon SDK

Android Studio

  1. 在 Android 中的应用程式专案找到 libs (途径:project_name -> app -> libs)

  2. 滑鼠右键点选 libs 后,左键点选 [Reveal in Finder]

  3. 将下载下来的 jar / aar 档复制到 libs 资料夹 (也可以直接拖移 Vpon JAR 至专案的 libs)

  4. 回到 Android 专案,libs 会多出一个 Vpon 的 jar / aar 档案,对它按下右键选则 [Add as library]。也请到 app 层级下的 build.gradle 下,将 dependencies 的部份修改如下:

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

如下图所示,如果 jar / aar 档被读到了,将显示在 dependencies 中

3rd-party Library


4.8.0 版开始,Vpon SDK 引入第三方的 Library - Retrofit,请参考以下方法导入 Retrofit:

  1. 手动下载导入:由此直接下载 Retrofit 的 jar 档并导入专案中
  2. 透过 Maven 导入:在 App 层级下的 build.gradle 的 dependencies 中加入以下内容导入 Retrofit:
dependencies {
    <!-- Import Retrofit v2.6.2 if you are using Vpon SDK v5.0.2 and above -->
    implementation 'com.squareup.retrofit2:retrofit:2.6.2'
    <!-- Import Retrofit v2.4.0 if you are using Vpon SDK v4.9.1 and below -->
    implementation 'com.squareup.retrofit2:retrofit:2.4.0'

    <!-- Import required Google Play Service -->
    implementation 'com.google.android.gms:play-services-ads-identifier:17.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"/>

<!-- Please add below script if you're using SDK v4.9.1 or below -->
<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"/>


> **Note**: 上面**每一个**属性都不能少,其值都需要相同!


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


```xml
<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());
    }
}

// Initial SDK in MainActivity
public class MainActivity extends AppCompatActivity {

    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        VponMobileAds.initialize(this);
    }
}

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


关于更多广告形式的呈现,请参考: