# Android FiveSDK v3.2.0におけるAPI変更への対応ガイド
# 概要
Android FiveSDK v3.2.0では、SDKの公開APIをJavaからKotlinでの実装に変更しました。
また、minSdkVersionを24へ変更しました。
本ガイドでは、これらの変更に伴い既存アプリやライブラリで必要になる対応について説明します。
# 対象
本ガイドは、Android FiveSDKをv3.2.0以降へ更新する際に必要な対応を説明します。
# 必要な変更の一覧
| 呼び出し言語 | 対象 | 呼び出し側の対応 |
|---|---|---|
| 共通 | minSdkVersion | 24以上へ変更 |
| Kotlin | Kotlin Gradle Plugin | 2.1.10以降へ更新 |
| Kotlin | Java版APIのgetterメソッド(getVersion()やgetAdTitle()など)を呼び出している箇所 | Kotlinのプロパティアクセスへ変更 |
| Kotlin | EventListenerのSAM変換 | ラムダから匿名objectへ変更 |
# minSdkVersionを24以上へ変更する
アプリやライブラリのminSdkVersionが23以下の場合は、24以上へ変更してください。
Android FiveSDK v3.2.0のminSdkVersionは24です。
すでに24以上を指定している場合は、変更する必要はありません。
# 変更例
# Kotlin Gradle Pluginを更新する
Android FiveSDKを参照するKotlinコードがある場合は、Kotlin Gradle Pluginを2.1.10以降へ更新してください。
Android FiveSDK v3.2.0はKotlin 2.1.10でコンパイルされており、Kotlin metadata version 2.1.0を含みます。 Kotlin 1.9系のコンパイラではこのメタデータを読み込めないため、Android FiveSDKを参照するKotlinコードがコンパイルできません。
JavaのみからAndroid FiveSDKを呼び出すアプリでは、Kotlin Gradle Pluginを追加する必要はありません。
# 変更例
# Kotlinコードでgetterメソッド呼び出しをプロパティアクセスへ変更する
Java版Android FiveSDKのgetterメソッドをKotlinコードから呼び出している場合は、Kotlinのプロパティアクセスへ変更してください。
Java版Android FiveSDKの利用時からKotlinのプロパティ構文で呼び出していたコードは、変更する必要がありません。 Javaコードからのgetter呼び出しも、従来どおり利用できます。
例えば、getVersion()はversionに、getAdTitle()はadTitleに変更します。
| クラス | 変更前のKotlinコード | 変更後のKotlinコード |
|---|---|---|
FiveAd | fiveAd.getVersion() | fiveAd.version |
FiveAd | FiveAd.getSdkVersion() | FiveAd.sdkVersion |
FiveAd | FiveAd.getSingleton() | FiveAd.singleton |
FiveAdCustomLayout | ad.getAdvertiserName() | ad.advertiserName |
FiveAdCustomLayout | ad.getLogicalWidth() | ad.logicalWidth |
FiveAdCustomLayout | ad.getLogicalHeight() | ad.logicalHeight |
FiveAdNative | ad.getContentViewLogicalWidth() | ad.contentViewLogicalWidth |
FiveAdNative | ad.getContentViewLogicalHeight() | ad.contentViewLogicalHeight |
FiveAdNative | ad.getAdMainView() | ad.adMainView |
FiveAdNative | ad.getButtonText() | ad.buttonText |
FiveAdNative | ad.getAdTitle() | ad.adTitle |
FiveAdNative | ad.getAdvertiserName() | ad.advertiserName |
FiveAdNative | ad.getDescriptionText() | ad.descriptionText |
FiveAdNative | ad.getLongDescriptionText() | ad.longDescriptionText |
# 変更前
val title = ad.getAdTitle()
# 変更後
val title = ad.adTitle
# KotlinコードでEventListenerをラムダから匿名objectへ変更する
次のEventListenerをKotlinのラムダで生成している場合は、匿名objectへ変更してください。
FiveAdCustomLayoutEventListenerFiveAdInterstitialEventListenerFiveAdNativeEventListener
Java interfaceだったEventListenerは、Kotlinの通常のinterfaceになりました。
Java interfaceに対して利用できたSAM変換によるラムダ生成は、通常のKotlin interfaceには適用できません。
なお、FiveAdVideoRewardEventListenerは従来からonViewError()とonReward()の2つが必須で、SAMではなかったため、この変更の対象外です。
# 変更前
val listener = FiveAdNativeEventListener { _, _ -> }
# 変更後
val listener = object : FiveAdNativeEventListener {
override fun onViewError(
fiveAdNative: FiveAdNative,
errorCode: FiveAdErrorCode,
) {
// エラー処理
}
}