インストールガイド

対応環境

動作する Android のAPIレベルは 16 (Android 4.1)以上 になります。

Android Studioへの導入

RFP Android SDKライブラリの追加

build.gradle に以下を追加し、Sync Projects with Gradle Files を実行。

repositories {
    maven { url 'https://raw.github.com/fout/RFP-Android-SDK/master/repos/' }
}

dependencies {
    implementation 'jp.fout.rfp.android.sdk:rfp-sdk:x.x.x'
}

Google Play Servicesライブラリの追加

  1. Google Play Services SDK をまだインストールしていない場合は SDK Manager からインストールする。

  2. RFP-Android-SDK を使用するモジュールの build.gradle の dependencies 配下に、 implementation 'com.google.android.gms:play-services-base:11.0.+' を追記する。 Google Play Servicesのバージョンは8.3以降を対象としています。(弊社での動作確認は主に11以降で行っています。)

  3. RFP-Android-SDK を使用するプロジェクトの build.gradle の android, defaultConfig 配下の minSdkVersion を 16 （play-services バージョンに依存するので適宜調整してください）に修正する。

  4. Sync Projects with Gradle Files を実行。

ご利用になる Google Play Service のバージョンによっては Google の Maven リポジトリを追加する必要があります。

allprojects {
    repositories {
        google()

        // If you're using a version of Gradle lower than 4.1, you must instead use:
        // maven {
        //     url 'https://maven.google.com'
        // }
        // An alternative URL is 'https://dl.google.com/dl/android/maven2/'
    }
}

AndroidManifestへの追加設定

AndroidManifest.xmlに次の内容を記述ください。

<!-- 必要なパーミッション -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

<application>
    <!--  google play serviceのライブラリを使うための記述 -->
    <meta-data
        android:name="com.google.android.gms.version"
        android:value="@integer/google_play_services_version" />
</application>

ExoPlayerライブラリの追加 (オプション)

アプリケーションを動画広告に対応するには別途ExoPlayerライブラリの導入が必要となります。

導入予定のアプリにおいて、すでにExoPlayerを導入されている場合は、お使いのバージョンに合わせたSDKをご利用いただけます。

ExoPlayerのバージョンは2.9〜2.18を対象としています。

ExoPlayer 2.9以降では、 compileOptions.targetCompatibility を JavaVersion.VERSION_1_8 にする必要があります。

android {
    // ...
    defaultConfig {
        //...
        compileOptions {
            // sourceCompatibilityについてはJava 7でも問題ありません
            sourceCompatibility JavaVersion.VERSION_1_7
            targetCompatibility JavaVersion.VERSION_1_8
        }
    }
}

動画広告の再生には動画広告SDKの追加が必要です。 また、 exoplayer-core および exoplayer-hls の導入が必要です。

dependencies {
    // for rfp-video-sdk
    // Using exoplayer2.18
    implementation 'jp.fout.rfp.android.sdk:rfp-video-sdk-exoplayer218:x.x.x'
    implementation 'com.google.android.exoplayer:exoplayer-core:2.18.+'
    implementation 'com.google.android.exoplayer:exoplayer-hls:2.18.+'
}

以上で Android Studio への導入は完了です。