AdfurikunSDK 導入方法(Android)

ファイル名やバージョン番号などが例です、実際のバージョンとファイルを設定してください。 'root'はアプリのルートフォルダーです

SDKのZipファイル内容物

libs
- adfurikunsdk.aar
- adnetwork.aar
- adfurikunsdk-adnw-*.gradle
- adfurikunsdk-support-*.gradle
SampleJava
README.txt

事前準備

アプリのminSdkVersionを14(Android4.0)以上に設定、詳しくは付録Cをご参考に
事前にZipファイルを解凍し、libsフォルダーをroot/app直下にコピー

基本Step

SDKの導入
AdNetworkの導入
Support Libraryの導入
AndroidManifest.xmlの設定
ProGuardの設定

1. SDKの導入

root/app/build.gradleを設定する

① Maven方式

x.y.zは実際のバージョンへ書き替えてください

//設定箇所root/build.gradle
allprojects {
    repositories {
        maven { url 'https://github.com/adfurikun/adfurikun_maven/raw/master' }
    }
}

//設定箇所root/app/build.gradle
dependencies {
    implementation 'jp.adfully:adfurikunsdk:x.y.z'
}

② AAR方式

//設定箇所root/app/build.gradle
dependencies {
    implementation files('libs/adfurikunsdk.aar')
}

AARの導入方式について、AndroidStudioからインポートする方法も有ります、 Android公式ドキュメントをご参考に
今後AdfurikunSDKのバイナリーはAARフォーマットのみ提供致します JARを使いたい方は：付録Aをご参考に

2. AdNetworkの導入

//設定箇所root/app/build.gradle
apply from: 'libs/adfurikunsdk-adnw-local.gradle'
apply from: 'libs/adfurikunsdk-adnw-maven.gradle'

既にMaven方式で公開しているAdNetworkが*-maven.gradleにあります、Maven以外の導入方法はアドフリくん側サポート致しません、各AdNetwork公式ドキュメントをご参照ください
Maven方式サポートしていないAdNetworkが*-local.gradleに纏めました
上記のgradleファイルの内容をコピーし、applyしなく直接build.gradleにペストてもOK
使わないAdNetworkは各gradleファイルからコメントアウトすればOK
gradleファイル中のAdNetworkバージョンは最小必要バージョンである、更新が来たら上げても大体問題ないですが AdfurikunSDkとの接合テストまだやっていない為、バグがでるかもしれません。その場合どうぞ気軽にご連絡ください

3. Support Libraryの導入

① 通常の場合

//設定箇所root/app/build.gradle
apply from: 'libs/adfurikunsdk-support-legacy.gradle'

② AndroidXを使う場合

//設定箇所root/app/build.gradle
apply from: 'libs/adfurikunsdk-support-androidx.gradle'

③ Dependency Treeを吐きだすコマンド

./gradlew app:dependencies

AndroidXは次世代のサポートライブラリーです:https://developer.android.com/jetpack/androidx/ compileSdkVersionを28以上に設定できたら、早目にAndroidXに移行する方がお勧めします
AdfurikunSDKはKotlin言語を使っている為、kotlin-stdlibに依存します、kotlin-stdlibのバージョンはkotlin言語のバージョンと一致しなければなりません。gradleファイルに設定しているバージョンは最小必要バージョンであり、アプリ側はそれより高いバージョンを使っているであれば、あげても影響がありません。逆の場合はアプリのkotlin言語バージョンを上げる必要がある。アプリ側はJava言語を使ってる場合はそのままのkotlin-stdlibバージョンで大丈夫、特に設定する必要有りません
サポートライブラリーのバージョンについて、アプリ使っている他のサポートライブラリーと一致する必要があります、 gradleファイルに記載しているバージョンは最低必要バージョンであり、それより高いバージョンであれば、上げても影響はありません。逆の場合はアプリ側のサポートライブラリーのバージョンを上げる必要がある
各AdNetworkが依存しているサポートライブラリーは重複した可能性が高い為、特定のAdNetwork使わなくても、他に別のAdNetwork参照される可能性があり、コメントアウトする際dependency treeを参照し、十分ご注意ください

4. AndroidManifest.xmlの設定

下記のファイルの中：
sample/app/src/main/AndroidManifest.xml

"AdNetwork 設定開始"から
"AdNetwork 設定終了"まで

全部の内容をアプリのAndroidManifest.xmlにコピー

Google Mobile Ads SDK version 17.0.0からの必須設定
AdfurikunSDKがActivity宣言とパーミッション定義がAARファイルに内蔵しています
多くのAdNetworkがActivity宣言をAARファイルに内蔵していますが、それをしていない方もある。バイナリーがAARを提供しているにもかかわらず、AdNetworkによってActivity宣言すべき場合があります
もしそのAdNetworkが使わなければ、Activity宣言もコピーする必要なし

5. ProGuardの設定

アプリ側ProGuardを使う場合のみ設定必要

下記のファイルの中：
sample/app/proguard-rules.pro

"動画リワード ProGuard設定"から
ファイルの最後まで

全部の内容をアプリのproguard-rules.proにコピー

SDK検証

SDK導入後、テストモードにてSDKが正常に導入されているかを、下記手順にてチェックすることができます

① AndroidManifest.xmlのテストモード設定をtrueにします

<!-- アドフリくんデバッグログ -->
<meta-data
    android:name="adfurikun_test"
    android:value="true" />

② SDKを初期化する（詳しくは”実装方法”をご参考に）

AdfurikunSdk.init()
//或いは
mReward = new AdfurikunMovieReward()

③ アプリを実行してログを確認します

******** AdfurikunAdNetworkChecker start ********
******** AdfurikunAdNetworkChecker finish ********

④ アプリで使用するAdNetworkの「Result」の個所の「Adapter」、「Activity」、「MetaData」、「Permission」が全てOKになっていることをご確認ください。

*** Result ***
Adapter:OK
Activity:OK
MetaData:OK
Permission:OK

NGの場合は、下記をご確認ください。

項目	対応方法
Adapter	該当AdNetworkを配置します
Activity	Activitesの項目に必須なActivityが表示されます --MISSINGとなっているActivityをAndroidManifest.xmlに追加してください
MetaData	MetaDataの項目に必須なMetaDataが表示されます --MISSINGとなっているMetaDataをAndroidManifest.xmlに追加してください
Permission	Permissionの項目に必須なPermissionが表示されます --MISSINGとなっているPermissionをAndroidManifest.xml追加してください

*アドフリくんで使用できる全てのアドネットワークの検証がされます。アプリでご使用されないアドネットワークの結果がNGでも問題ございません。

付録

A. AARからJARファイルを取得

aarファイルの拡張子を".zip"に変更し、解凍します
classes.jarファイルを"adfurikunsdk-x.y.z.jar"にリネーム
AndroidManifest.xmlの内容をご自分のプロジェクト設定にコピー
proguard.txtの内容をご自分のプロジェクト設定にコピー
resフォルダーに画像など有れば、ご自分のプロジェクトresフォルダーにコピー

B. 64Kを超えるメソット数に逹した時の設定

AdfurikunSDK1.13.0以降、64Kを超えるメソッド数に逹して、minSdkVersionが21以下の場合MultiDexの設定が必要です。詳しくはAndroid公式ドキュメントをご参考に

C. minSdkVersion / targetSdkVersion / compileSdkVersionの設定

minSdkVersionはアプリが実行されるAndroidプラットフォーム最小バージョン、詳しくはAndroid公式ドキュメントをご参考に
targetSdkVersionについて、2018年8月から、GooglePlayストアに提出される全てのアプリとゲームは、APIレベル26以上（Android 8.0 Oreo）に設定することが必須化になります
compileSdkVersionは常に最新に設定した方がおすすめします

SDK 導入方法