# AdLoader API

v2.9.20241129以降のFiveSDKはAdLoader APIと呼ばれるAPIをサポートしています。 このAPIはSDKの初期化と広告ロードの方法を置きかえる新しいAPIで、v3.0.0以降では従来のAPIが非推奨となりAdLoader APIが推奨となる予定です。

AdLoader APIを利用するには、まずAdLoaderのインスタンスを取得する必要があります。 このページではAdLoaderのインスタンスの取得方法を解説します。

# FiveAdConfigオブジェクト

AdLoaderのインスタンスを取得するには、まずアプリ全体の設定を管理するFiveAdConfigオブジェクトを作る必要があります。

以下のようなコードでFiveAdConfigオブジェクトを生成します。 your-app-idは登録したアプリIDで置きかえてください。

# テストフラグの設定

FiveAdConfigにはisTestフラグが用意されています。 このフラグを設定することでテスト広告を配信するテストを行うことができます。

# AdLoaderの取得

設定したFiveAdConfigを利用してAdLoaderのインスタンスを取得します。 なお、AdLoader.forConfig の第一引数は android.content.Context です。

AdLoaderのインスタンスはSDK内部でキャッシュされており、同一の設定に対しては同じインスタンスを返します。 ただし、スレッドセーフを保証するためのコストがかかるため、基本的には一度取得したAdLoaderのインスタンスはそのまま保持しておくことをお勧めします。

TIP

v2.9.20250718以降のFiveSDKでは複数の異なる設定のAdLoaderのインスタンスを取得できる設計になっています。 ただし、現在は同一アプリに複数のアプリIDを発行しない構成になっているため、これはテスト用途以外では活用できません。 この設計は今後のアップデートを意識したものです。

AdLoaderのインスタンスを取得したら、広告をロードして表示することが可能となります。 以降のページでは広告フォーマットごとの実装方法について解説します。