SDK の移行

このページでは、最新バージョンと以前のバージョンへの移行について説明します。

SDK v21 への移行

To avoid potential build failures with version 21.0.0 of the Google Mobile Ads SDK (slated for an early 2022 release), follow the checks and guidelines introduced in this guide.

Update minSdkVersion to 19 or higher

Starting from version 21.0.0, the Google Mobile Ads SDK requires all apps to be on a minimum Android API level 19 to run. To adjust the API level, change the value of minSdkVersion in your app’s build file to 19 or higher.

Enforce strict nullability

In preparation for enforcing strict nullability, @NonNull annotations are added in all the APIs that previously did not explicitly define nullability.

This change may break the Kotlin apps and apps that use Java null checking frameworks if there are null safety violations and did not previously handle null values in a safe way (see the Kotlin documentation on Null-safety ).

Removal of addNetworkExtras() method

The addNetworkExtras() method that passes extra parameters as a NetworkExtras instance to a specific ad network adapter was deprecated in SDK version 20.3.0, and will be removed in version 21.0.0. Use the addNetworkExtrasBundle() method from the same AdRequest.Builder class instead.

Removal of location methods

The following location methods will be removed in version 21.0.0:

The setLocation(Location location) method in the AdRequest.Builder class that sets the user's location for mediation targeting purposes.
The getLocation() method in the AdRequest class that returns the user's location targeting information previously passed to the setLocation(Location location) method.
The getLocation() method in the MediationAdConfiguration class that returns the location of the user, if defined by the AdRequest.

The location data is not used by Google to target ads. You should use third-party APIs to provide the information to third-party ad networks if required.

Custom event interfaces deprecation

Custom events enable publishers using AdMob mediation to add waterfall mediation for an ad network that isn't one of AdMob's supported ad networks.

All the custom event interfaces are deprecated in favor of the Adapter class and MediationAdLoadCallback interface.

The table below lists the corresponding class or interface that should be used for each custom event interface starting from version 21.0.0:

v20.0.0 Interfaces	v21.0.0 Class/ Interface
CustomEvent	Adapter
CustomEventBanner
CustomEventInterstitial
CustomEventNative
CustomEventBannerListener	Adapter, MediationAdLoadCallback
CustomEventInterstitialListener
CustomEventListener
CustomEventNativeListener

SDK v20 への移行

バージョン 20.0.0 では、互換性を破る多数の変更が加えられる予定です。バージョン 19.7.0 では、新しい API が多く導入され、バージョン 20.0.0 のリリースに向けて、多くのクラスが非推奨になりました。このガイドでは、バージョン 19.7.0 で導入された主な変更と、バージョン 20.0.0（2021 年初頭）のリリース内容について説明しています。

全画面フォーマットの API の更新

バージョン 20.0.0 以降では、インタースティシャル広告、リワード広告、リワードインタースティシャル広告、アプリ起動時広告の各広告フォーマットが、一貫性のある API 設計に従うように標準化されます。

全画面フォーマットの API では、以下の原則が使用されます。

静的な読み込みメソッド
類似した読み込みコールバックまたはハンドラメカニズム
プレゼンテーションコールバックの FullScreenContentCallback クラスへの依存

従来の RewardedVideoAd API の削除

最新版の RewardedAd API は 2019 年 3 月に初めて導入され、その後 18 か月間にわたってリワード広告用 API として推奨されています。一度に複数のリワード広告を読み込むことができるなど、従来の RewardedVideoAd API にさらなる改善が行われています。

従来の RewardedVideoAd API は、SDK バージョン 20.0.0 で削除されます。

アダプティブバナーの導入に合わせてスマートバナーのサポートを終了

アダプティブバナー広告の導入に合わせて、スマートバナー広告のサポートを終了しました。アダプティブバナーでは、パフォーマンスと広告の幅を設定する際の柔軟性が向上しています。全幅表示のバナーを引き続き使用したい場合は、以下のコードスニペットに示されるようにアダプティブバナーを使用してください。

Java

public class MyActivity extends AppCompatActivity {
  ...
  private AdSize getFullWidthAdaptiveSize() {
    Display display = getWindowManager().getDefaultDisplay();
    DisplayMetrics outMetrics = new DisplayMetrics();
    display.getMetrics(outMetrics);

    float widthPixels = outMetrics.widthPixels;
    float density = outMetrics.density;

    int adWidth = (int) (widthPixels / density);
    return AdSize.getCurrentOrientationAnchoredAdaptiveBannerAdSize(this, adWidth);
  }
}

Kotlin

class MyActivity : AppCompatActivity() {
  ...
  private val adaptiveAdSize: AdSize
    get() {
      val display = windowManager.defaultDisplay
      val outMetrics = DisplayMetrics()
      display.getMetrics(outMetrics)

      val density = outMetrics.density

      var adWidthPixels = ad_view_container.width.toFloat()
      if (adWidthPixels == 0f) {
        adWidthPixels = outMetrics.widthPixels.toFloat()
      }

      val adWidth = (adWidthPixels / density).toInt()
      return AdSize.getCurrentOrientationAnchoredAdaptiveBannerAdSize(this, adWidth)
    }
}

アプリ終了時のコールバックの削除

ProcessLifecycleOwner との兼ね合いで、すべての広告フォーマットの onAdLeftApplication コールバックが削除されました。OS レベルの API を使用すると、広告のインタラクションによるものであるかどうかに関係なく、ユーザーがアプリから離れるたびに通知が届きます。

なお、onAdLeftApplication コールバックは広告クリックハンドラを意図したものではなく、このコールバックを使用してクリック数に関するレポートを作成しても正確な指標は生成されませんでした（AdChoices アイコンのクリックで外部ブラウザが起動された場合、コールバックは呼び出されるものの、クリックはカウントされない、など）。

クラス名の変更

以下の表は、変更または削除された具体的なクラス名を示しています。概要は次のとおりです。

UnifiedNativeAd に関連するほとんどのクラスの名前が NativeAd に変更されました。
MobileAds.Settings、NativeExpressAdView、NativeAppInstallAd、NativeContentAd、InstreamAd のクラスとビューが削除されました。
Publisher プレフィックスを持つすべてのクラスが AdManager プレフィックスに置き換えられました。
InterstitialAd のパッケージ名が変更されました。

19.5.0 クラス	20.0.0 クラス
com.google.android.gms.ads.	com.google.android.gms.ads.
reward.RewardedVideoAd	rewarded.RewardedAd
reward.RewardedVideoAdListener	rewarded.RewardedAdLoadCallback および FullScreenContentCallback
reward.RewardItem	rewarded.RewardItem
rewarded.RewardedAdCallback	OnUserEarnedRewardListener
formats.UnifiedNativeAdView	nativead.NativeAdView
formats.UnifiedNativeAd	nativead.NativeAd
formats.UnifiedNativeAdAssetNames	nativead.NativeAdAssetNames
formats.UnifiedNativeAd.OnUnifiedNativeAdLoadedListener	nativead.NativeAd.OnNativeAdLoadedListener
formats.AdChoicesView	nativead.AdChoicesView
formats.NativeAd.AdChoicesInfo	nativead.NativeAd.AdChoicesInfo
formats.MediaView	nativead.MediaView
formats.NativeAdViewHolder	nativead.NativeAdViewHolder
formats.NativeAdOptions	nativead.NativeAdOptions
formats.NativeCustomTemplateAd	nativead.NativeCustomFormatAd
formats.NativeCustomTemplateAd.OnCustomTemplateAdLoadedListener	nativead.NativeCustomFormatAd.OnCustomFormatAdLoadedListener
MobileAds.Settings	削除済み
doubleclick.PublisherAdRequest	admanager.AdManagerAdRequest
doubleclick.PublisherAdView	admanager.AdManagerAdView
formats.PublisherAdViewOptions	formats.AdManagerAdViewOptions
doubleclick.PublisherInterstitialAd	admanager.AdManagerInterstitialAd
InterstitialAd	interstitial.InterstitialAd
NativeExpressAdView	削除済み
instream.InstreamAd	削除済み
mediation.admob.AdMobExtras	削除済み
Correlator	削除済み
search.SearchAdRequest	削除済み
Interface AdRequest.TagForUnderAgeOfConsent	削除済み
Interface AdRequest.MaxAdContentRating	削除済み
formats.NativeAppInstallAd	native.NativeAd
formats.NativeAppInstallAdView	native.NativeAdView
mediation.NativeAppInstallAdMapper	mediation.UnifiedNativeAdMapper
formats.NativeContentAd	native.NativeAd
formats.NativeContentAdView	native.NativeAdView
mediation.NativeContentAdMapper	mediation.UnifiedNativeAdMapper

削除または置換されたメソッド

以下の表は、バージョン 20.0.0 の具体的な変更点を示しています。概要は次のとおりです。

古い初期化メソッドが MobileAds クラスから削除されました。
AdRequest.Builder() クラスの一部のメソッドが削除されたか、RequestConfiguration クラスに移動されました。
RewardedAd API と InterstitialAd API が、すべての全画面フォーマットに合わせて更新されました。
Correlator 機能が削除されました。

クラス	v19.5.0 API	v20.0.0 API	備考
AdSize	getPortraitBannerAdSizeWithWidth()	getPortraitAnchoredAdaptiveBannerAdSize()
	getLandscapeBannerAdSizeWithWidth()	getLandscapeAnchoredAdaptiveBannerAdSize()
	getCurrentOrientationBannerAdSizeWithWidth()	getCurrentOrientationAnchoredAdaptiveBannerAdSize()
MobileAds	initialize(Context, String)	MobileAds.initialize(Context, OnInitializationCompleteListener)	アプリ ID が AndroidManifest.xml に設定されるようになりました。
	initialize(Context, String, MobileAds.Settings)	initialize(Context, OnInitializationCompleteListener)	Settings クラスのサポートが終了しました。
	getRewardedVideoAdInstance()	削除済み	代わりに RewardedAd API を使用してください。
AdListener	onAdFailedToLoad(int)	onAdFailedToLoad(LoadAdError)
AdListener	onAdLeftApplication()	削除済み	全画面の広告フォーマットは AdListener の代わりに FullscreenContentCallback を使用します。FullscreenContentCallback には同等のメソッドはありません。このメソッドは AdListener から削除されました。
VideoController	getAspectRatio()	MediaContent.getAspectRatio()
AdRequest	getGender()	削除済み
	getBirthday()	削除済み
	getNetworkExtras()	削除済み
	setManualImpressionsEnabled()	削除済み
	updateCorrelator()	削除済み	広告コンテンツのフィルタリングをご覧ください。
AdRequest.Builder	setBirthday()	削除済み
	setGender()	削除済み
	setIsDesignedForFamilies()	削除済み	ガイドをご確認ください。
	addTestDevice()	RequestConfiguration.Builder.setTestDeviceIds()	テスト広告の有効化をご覧ください。
	tagForChildDirectedTreatment()	RequestConfiguration.Builder.setTagForChildDirectedTreatment()	広告コンテンツのフィルタリングをご覧ください。
	setTagForUnderAgeOfConsent()	RequestConfiguration.Builder.setTagForUnderAgeOfConsent()
	setMaxAdContentRating()	RequestConfiguration.Builder.setMaxAdContentRating()
AdView	getMediationAdapterClassName()	ResponseInfo.getMediationAdapterClassName()	ResponseInfo オブジェクトが AdView メソッド getResponseInfo() を介して利用できるようになりました。
NativeAdOptions	setImageOrientation()	setMediaAspectRatio()
NativeAdOptions	getImageOrientation	getMediaAspectRatio()
RewardedAd	loadAd(AdRequest, RewardedAdLoadCallback)	RewardedAd.load(Context, String, AdRequest, RewardedAdLoadCallback)	RewardedAd で、他の全画面フォーマットと同じ静的な読み込みのアプローチが使用されるようになりました。
	loadAd(PublisherAdRequest, RewardedAdLoadCallback)	RewardedAd.load(Context, String, AdManagerAdRequest, RewardedAdLoadCallback)	RewardedAd で、他の全画面フォーマットと同じ静的な読み込みのアプローチが使用されるようになりました。
	isLoaded()	削除済み	静的な読み込みメソッドのコールバックにより、読み込み済みの広告が提供されます。
	show(Activity, RewardedAdCallback)	show(Activity, OnUserEarnedRewardListener)	この表示メソッドは、より広範な全画面フォーマットのアプローチに基づいています。
RewardedAdLoadCallback	onRewardedAdFailedToLoad(int)	onAdFailedToLoad(LoadAdError)
	onRewardedAdFailedToLoad(LoadAdError)	onAdFailedToLoad(LoadAdError)
	onRewardedAdLoaded()	onAdLoaded(RewardedAd)
AppOpenAdLoadCallback	onAppOpenAdFailedToLoad(int)	onAdFailedToLoad(LoadAdError)
	onAppOpenAdFailedToLoad(LoadAdError)	onAdFailedToLoad(LoadAdError)
	onAppOpenAdLoaded(AppOpenAd)	onAdLoaded(AppOpenAd)
RewardedInterstitialAdLoadCallback	onRewardedInterstitialAdFailedToLoad(int)	onAdFailedToLoad(LoadAdError)
	onRewardedInterstitialAdFailedToLoad(LoadAdError)	onAdFailedToLoad(LoadAdError)
	onRewardedInterstitialAdLoaded(RewardedInterstitialAd)	onAdLoaded(RewardedInterstitialAd)
InterstitialAd	新しい InterstitialAd()	InterstitialAd.load(Context, String, AdRequest, InterstitialAdLoadCallback)	InterstitialAd で、他の全画面フォーマットと同じ静的な読み込みのアプローチが使用されるようになりました。
InterstitialAd	setAdListener()		InterstitialAd で、他の全画面フォーマットと同じ静的な読み込みのアプローチが使用されるようになりました。
DynamicHeightSearchAdRequest	getNetworkExtras()	削除済み	NetworkExtras クラスのサポートが終了しました。
AdLoader	forContentAd()	削除済み
	forAppInstallAd()	削除済み
	withCorrelator()	削除済み
	getMediationAdapterClassName()	削除済み