バナー広告 - Ad Control Help Center

概要

バナー広告は画面の一部に表示される矩形の広告です。XMLレイアウトとコードの両方で使用できます。

主な特徴

画面の上部、下部、または中央に固定配置可能
画像および動画広告に対応
XMLレイアウトとプログラム方式の両方に対応
リスナーによる広告イベント処理

開発環境ではテストユニットIDを使用してください：PUBLIC_TEST_UNIT_ID_320_100

XMLレイアウト実装

XMLレイアウトでAdropBannerを定義し、ActivityまたはFragmentからロードする方式です。

1. XMLレイアウト定義

FrameLayoutまたは他のコンテナにAdropBannerを配置します。

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <!-- メインコンテンツ -->
    <TextView
        android:id="@+id/content"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="メインコンテンツ"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintEnd_toEndOf="parent" />

    <!-- バナー広告コンテナ -->
    <FrameLayout
        android:id="@+id/banner_container"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintEnd_toEndOf="parent">

        <io.adrop.ads.banner.AdropBanner
            android:id="@+id/adrop_banner"
            android:layout_width="320dp"
            android:layout_height="100dp"
            android:layout_gravity="center"
            app:adrop_unit_id="YOUR_UNIT_ID" />

    </FrameLayout>

</androidx.constraintlayout.widget.ConstraintLayout>

2. Activityからロード

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import io.adrop.ads.banner.AdropBanner
import io.adrop.ads.banner.AdropBannerListener
import io.adrop.ads.model.AdropErrorCode

class MainActivity : AppCompatActivity() {
    private var banner: AdropBanner? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // 1. XMLで定義したバナービューを取得
        banner = findViewById(R.id.adrop_banner)

        // 2. リスナー設定
        banner?.listener = object : AdropBannerListener {
            override fun onAdReceived(banner: AdropBanner) {
                println("バナー広告の受信成功")
            }

            override fun onAdFailedToReceive(banner: AdropBanner, errorCode: AdropErrorCode) {
                println("バナー広告の受信失敗: $errorCode")
            }

            override fun onAdImpression(banner: AdropBanner) {
                println("バナー広告のインプレッション")
            }

            override fun onAdClicked(banner: AdropBanner) {
                println("バナー広告がクリックされました")
            }
        }

        // 3. 広告をロード
        banner?.load()
    }

    override fun onDestroy() {
        super.onDestroy()
        // 4. メモリ解放
        banner?.destroy()
        banner = null
    }
}

import android.os.Bundle;
import androidx.appcompat.app.AppCompatActivity;
import io.adrop.ads.banner.AdropBanner;
import io.adrop.ads.banner.AdropBannerListener;
import io.adrop.ads.model.AdropErrorCode;
import org.jetbrains.annotations.NotNull;

public class MainActivity extends AppCompatActivity {
    private AdropBanner banner;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 1. XMLで定義したバナービューを取得
        banner = findViewById(R.id.adrop_banner);

        // 2. リスナー設定
        banner.setListener(new AdropBannerListener() {
            @Override
            public void onAdReceived(@NotNull AdropBanner banner) {
                System.out.println("バナー広告の受信成功");
            }

            @Override
            public void onAdFailedToReceive(@NotNull AdropBanner banner, @NotNull AdropErrorCode errorCode) {
                System.out.println("バナー広告の受信失敗: " + errorCode);
            }

            @Override
            public void onAdImpression(@NotNull AdropBanner banner) {
                System.out.println("バナー広告のインプレッション");
            }

            @Override
            public void onAdClicked(@NotNull AdropBanner banner) {
                System.out.println("バナー広告がクリックされました");
            }
        });

        // 3. 広告をロード
        banner.load();
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        // 4. メモリ解放
        if (banner != null) {
            banner.destroy();
            banner = null;
        }
    }
}

XML属性

属性	説明	必須
`app:adrop_unit_id`	広告ユニットID	O
`app:adrop_context_id`	コンテキストターゲティング用のコンテキストID
`android:layout_width`	バナーの幅 (dp)	O
`android:layout_height`	バナーの高さ (dp)	O

プログラム方式での実装

コードで直接AdropBannerインスタンスを作成してビューに追加する方式です。

import android.os.Bundle
import android.widget.FrameLayout
import androidx.appcompat.app.AppCompatActivity
import io.adrop.ads.banner.AdropBanner
import io.adrop.ads.banner.AdropBannerListener
import io.adrop.ads.model.AdropErrorCode

class MainActivity : AppCompatActivity() {
    private var banner: AdropBanner? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // 1. バナーインスタンスを作成
        banner = AdropBanner(this, "YOUR_UNIT_ID").apply {
            // 2. リスナー設定
            listener = object : AdropBannerListener {
                override fun onAdReceived(banner: AdropBanner) {
                    println("バナー広告の受信成功")
                }

                override fun onAdFailedToReceive(banner: AdropBanner, errorCode: AdropErrorCode) {
                    println("バナー広告の受信失敗: $errorCode")
                }

                override fun onAdImpression(banner: AdropBanner) {
                    println("バナー広告のインプレッション")
                }

                override fun onAdClicked(banner: AdropBanner) {
                    println("バナー広告がクリックされました")
                }
            }
        }

        // 3. ビュー階層に追加
        val container = findViewById<FrameLayout>(R.id.banner_container)
        val params = FrameLayout.LayoutParams(
            FrameLayout.LayoutParams.MATCH_PARENT,
            FrameLayout.LayoutParams.WRAP_CONTENT
        )
        container.addView(banner, params)

        // 4. 広告をロード
        banner?.load()
    }

    override fun onDestroy() {
        super.onDestroy()
        // 5. メモリ解放
        banner?.destroy()
        banner = null
    }
}

import android.os.Bundle;
import android.widget.FrameLayout;
import androidx.appcompat.app.AppCompatActivity;
import io.adrop.ads.banner.AdropBanner;
import io.adrop.ads.banner.AdropBannerListener;
import io.adrop.ads.model.AdropErrorCode;
import org.jetbrains.annotations.NotNull;

public class MainActivity extends AppCompatActivity {
    private AdropBanner banner;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 1. バナーインスタンスを作成（unitIdはコンストラクタで必須）
        banner = new AdropBanner(this, "YOUR_UNIT_ID");

        // 2. リスナー設定
        banner.setListener(new AdropBannerListener() {
            @Override
            public void onAdReceived(@NotNull AdropBanner banner) {
                System.out.println("バナー広告の受信成功");
            }

            @Override
            public void onAdFailedToReceive(@NotNull AdropBanner banner, @NotNull AdropErrorCode errorCode) {
                System.out.println("バナー広告の受信失敗: " + errorCode);
            }

            @Override
            public void onAdImpression(@NotNull AdropBanner banner) {
                System.out.println("バナー広告のインプレッション");
            }

            @Override
            public void onAdClicked(@NotNull AdropBanner banner) {
                System.out.println("バナー広告がクリックされました");
            }
        });

        // 3. ビュー階層に追加
        FrameLayout container = findViewById(R.id.banner_container);
        FrameLayout.LayoutParams params = new FrameLayout.LayoutParams(
            FrameLayout.LayoutParams.MATCH_PARENT,
            FrameLayout.LayoutParams.WRAP_CONTENT
        );
        container.addView(banner, params);

        // 4. 広告をロード
        banner.load();
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        // 5. メモリ解放
        if (banner != null) {
            banner.destroy();
            banner = null;
        }
    }
}

AdropBannerの初期化

コンストラクタ

Context

必須

ActivityまたはApplicationのContext

val banner = AdropBanner(context, "YOUR_UNIT_ID")

AdropBanner banner = new AdropBanner(context, "YOUR_UNIT_ID");

ユニットIDの設定

String

必須

Adropコンソールで作成したユニットID

banner.setUnitId("YOUR_UNIT_ID")

banner.setUnitId("YOUR_UNIT_ID");

広告のロード

バナーを画面に追加した後、load()メソッドを呼び出して広告をリクエストします。

banner.load()

banner.load();

バナーが画面に表示されている時点でload()を呼び出してください。表示されていない状態でロードすると、インプレッションが正確に測定されない場合があります。

リスナーの実装

AdropBannerListenerインターフェースは広告のライフサイクルイベントを処理します。

onAdReceived（必須）

広告の受信に成功した時に呼び出されます。

override fun onAdReceived(banner: AdropBanner) {
    println("バナー広告の受信成功")
    // ローディングインジケーターを非表示にするなどの処理
}

@Override
public void onAdReceived(@NotNull AdropBanner banner) {
    System.out.println("バナー広告の受信成功");
    // ローディングインジケーターを非表示にするなどの処理
}

onAdFailedToReceive（必須）

広告の受信に失敗した時に呼び出されます。

override fun onAdFailedToReceive(banner: AdropBanner, errorCode: AdropErrorCode) {
    println("バナー広告の受信失敗: $errorCode")
    // エラー処理および代替コンテンツの表示
}

@Override
public void onAdFailedToReceive(@NotNull AdropBanner banner, @NotNull AdropErrorCode errorCode) {
    System.out.println("バナー広告の受信失敗: " + errorCode);
    // エラー処理および代替コンテンツの表示
}

AdropErrorCode

エラーの種類を示すコード。詳細はリファレンスを参照してください。

onAdImpression（オプション）

広告が画面に表示された時に呼び出されます。

override fun onAdImpression(banner: AdropBanner) {
    println("バナー広告のインプレッション")
    // インプレッション分析ログなどの処理
}

@Override
public void onAdImpression(@NotNull AdropBanner banner) {
    System.out.println("バナー広告のインプレッション");
    // インプレッション分析ログなどの処理
}

onAdClicked（必須）

ユーザーが広告をクリックした時に呼び出されます。

override fun onAdClicked(banner: AdropBanner) {
    println("バナー広告がクリックされました")
    // クリック分析ログなどの処理
}

@Override
public void onAdClicked(@NotNull AdropBanner banner) {
    System.out.println("バナー広告がクリックされました");
    // クリック分析ログなどの処理
}

onAdVideoStart（オプション）

動画バナー広告で動画再生が開始された時に呼び出されます。

override fun onAdVideoStart(banner: AdropBanner) {
    println("バナー動画再生開始")
}

@Override
public void onAdVideoStart(@NotNull AdropBanner banner) {
    System.out.println("バナー動画再生開始");
}

onAdVideoEnd（オプション）

動画バナー広告で動画再生が終了した時に呼び出されます。

override fun onAdVideoEnd(banner: AdropBanner) {
    println("バナー動画再生終了")
}

@Override
public void onAdVideoEnd(@NotNull AdropBanner banner) {
    System.out.println("バナー動画再生終了");
}

コンテキストIDの設定

コンテキストターゲティングのためにコンテキストIDを設定できます。

// contextIdは読み取り専用 — コンストラクタで設定
val banner = AdropBanner(this, "YOUR_UNIT_ID", "article_sports")

// contextIdは読み取り専用 — コンストラクタで設定
AdropBanner banner = new AdropBanner(this, "YOUR_UNIT_ID", "article_sports");

コンテキストIDは広告をロードする前に設定する必要があります。

ライフサイクル管理

destroy()

バナーを使用しなくなった時は、必ずdestroy()を呼び出してリソースを解放してください。

override fun onDestroy() {
    super.onDestroy()
    banner?.destroy()
    banner = null
}

@Override
protected void onDestroy() {
    super.onDestroy();
    if (banner != null) {
        banner.destroy();
        banner = null;
    }
}

destroy()を呼び出さないとメモリリークが発生する可能性があります。

広告サイズ

バナー広告はユニットに設定したサイズに合わせてビューのサイズを指定する必要があります。

一般的なバナーサイズ

サイズ	用途
320 x 50	小型バナー
320 x 100	中型バナー
16:9比率	動画バナー

XMLでサイズを指定

<io.adrop.ads.banner.AdropBanner
    android:id="@+id/adrop_banner"
    android:layout_width="320dp"
    android:layout_height="100dp"
    app:adrop_unit_id="YOUR_UNIT_ID" />

コードでサイズを指定

val params = FrameLayout.LayoutParams(
    dpToPx(320), // 幅
    dpToPx(100)   // 高さ
)
container.addView(banner, params)

// dpをpxに変換するユーティリティ関数
fun dpToPx(dp: Int): Int {
    val density = resources.displayMetrics.density
    return (dp * density).toInt()
}

FrameLayout.LayoutParams params = new FrameLayout.LayoutParams(
    dpToPx(320), // 幅
    dpToPx(100)   // 高さ
);
container.addView(banner, params);

// dpをpxに変換するユーティリティ関数
private int dpToPx(int dp) {
    float density = getResources().getDisplayMetrics().density;
    return (int) (dp * density);
}

テストユニットID

開発およびテスト時は以下のテストユニットIDを使用してください。

広告タイプ	テストユニットID	サイズ
バナー (320x50)	`PUBLIC_TEST_UNIT_ID_320_50`	320 x 50
バナー (320x100)	`PUBLIC_TEST_UNIT_ID_320_100`	320 x 100
カルーセルバナー	`PUBLIC_TEST_UNIT_ID_CAROUSEL`	可変
バナー動画 (16:9)	`PUBLIC_TEST_UNIT_ID_BANNER_VIDEO_16_9`	16:9比率
バナー動画 (9:16)	`PUBLIC_TEST_UNIT_ID_BANNER_VIDEO_9_16`	9:16比率

使用例

val banner = AdropBanner(this, "PUBLIC_TEST_UNIT_ID_320_100")

AdropBanner banner = new AdropBanner(this, "PUBLIC_TEST_UNIT_ID_320_100");

<io.adrop.ads.banner.AdropBanner
    android:id="@+id/adrop_banner"
    android:layout_width="320dp"
    android:layout_height="100dp"
    app:adrop_unit_id="PUBLIC_TEST_UNIT_ID_320_100" />

動画再生制御

動画バナー広告の場合、play()とpause()を使用してビデオ再生を手動で制御できます。

play()

動画の再生を再開します。ポップアップが閉じたり、アプリがバックグラウンドから復帰してバナーが再び表示されるときに呼び出してください。

banner?.play()

banner.play();

pause()

動画の再生を一時停止します。バナーがポップアップで隠れたり、アプリがバックグラウンドに移行するときに呼び出してください。

banner?.pause()

banner.pause();

例：バックグラウンド/フォアグラウンドの処理

override fun onResume() {
    super.onResume()
    banner?.play()
}

override fun onPause() {
    super.onPause()
    banner?.pause()
}

@Override
protected void onResume() {
    super.onResume();
    if (banner != null) {
        banner.play();
    }
}

@Override
protected void onPause() {
    super.onPause();
    if (banner != null) {
        banner.pause();
    }
}

play()とpause()は動画バナー広告にのみ影響します。画像バナーには効果がありません。

カスタムクリック処理

デフォルトでは、SDKはユーザーがバナー広告をクリックすると自動的に遷移先URLを開きます。クリックイベントを自分で処理したい場合（例：確認ダイアログの表示、分析ログの記録後に遷移など）、useCustomClickを使用できます。

Boolean

デフォルト:"false"

trueに設定すると、SDKはクリック時に自動的に遷移先URLを開きません。onAdClickedイベントのみ発火し、open()を手動で呼び出す必要があります。

// 1. カスタムクリック処理を有効化
banner?.useCustomClick = true

// 2. リスナーでクリック処理
banner?.listener = object : AdropBannerListener {
    override fun onAdClicked(banner: AdropBanner) {
        // カスタムロジック実行（ダイアログ表示、分析ログなど）
        println("広告クリック — 遷移先URLを開く")
        banner.open()
    }

    // ... 他のリスナーメソッド
}

// 1. カスタムクリック処理を有効化
banner.setUseCustomClick(true);

// 2. リスナーでクリック処理
banner.setListener(new AdropBannerListener() {
    @Override
    public void onAdClicked(@NotNull AdropBanner banner) {
        // カスタムロジック実行（ダイアログ表示、分析ログなど）
        System.out.println("広告クリック — 遷移先URLを開く");
        banner.open();
    }

    // ... 他のリスナーメソッド
});

open()

広告の遷移先URLを開きます。カスタムURLを渡して別のURLを開くこともできます。

// デフォルトの遷移先URLを開く
banner?.open()

// カスタムURLを開く
banner?.open("https://example.com")

// デフォルトの遷移先URLを開く
banner.open();

// カスタムURLを開く
banner.open("https://example.com");

open()はuseCustomClickがtrueに設定されている場合のみ動作します。useCustomClickがfalse（デフォルト）の場合、SDKが自動的にURLを開きます。

ベストプラクティス

1. メモリ管理

ActivityやFragmentが終了する時は必ずバナーを解放してください。

override fun onDestroy() {
    super.onDestroy()
    banner?.destroy()
    banner = null
}

@Override
protected void onDestroy() {
    super.onDestroy();
    if (banner != null) {
        banner.destroy();
        banner = null;
    }
}

2. 画面の可視性

バナーが画面に表示されている時に広告をロードしてください。

override fun onResume() {
    super.onResume()
    banner?.load()
}

@Override
protected void onResume() {
    super.onResume();
    if (banner != null) {
        banner.load();
    }
}

3. エラー処理

広告ロード失敗時の適切なエラー処理を実装してください。

override fun onAdFailedToReceive(banner: AdropBanner, errorCode: AdropErrorCode) {
    when (errorCode) {
        AdropErrorCode.ERROR_CODE_NETWORK -> {
            println("ネットワークエラー：接続を確認してください")
        }
        AdropErrorCode.ERROR_CODE_AD_NO_FILL -> {
            println("表示可能な広告がありません")
        }
        else -> {
            println("広告ロード失敗: $errorCode")
        }
    }
}

@Override
public void onAdFailedToReceive(@NotNull AdropBanner banner, @NotNull AdropErrorCode errorCode) {
    if (errorCode == AdropErrorCode.ERROR_CODE_NETWORK) {
        System.out.println("ネットワークエラー：接続を確認してください");
    } else if (errorCode == AdropErrorCode.ERROR_CODE_AD_NO_FILL) {
        System.out.println("表示可能な広告がありません");
    } else {
        System.out.println("広告ロード失敗: " + errorCode);
    }
}

4. RecyclerViewでの使用

RecyclerViewでバナーを使用する時は、ViewHolderで適切に管理してください。

class BannerViewHolder(view: View) : RecyclerView.ViewHolder(view) {
    private val banner: AdropBanner = view.findViewById(R.id.adrop_banner)

    fun bind() {
        banner.listener = object : AdropBannerListener {
            // リスナー実装
        }
        banner.load()
    }

    fun recycle() {
        banner.destroy()
    }
}

// アダプター内で
override fun onViewRecycled(holder: BannerViewHolder) {
    holder.recycle()
}

class BannerViewHolder extends RecyclerView.ViewHolder {
    private AdropBanner banner;

    public BannerViewHolder(View view) {
        super(view);
        banner = view.findViewById(R.id.adrop_banner);
    }

    public void bind() {
        banner.setListener(new AdropBannerListener() {
            // リスナー実装
        });
        banner.load();
    }

    public void recycle() {
        banner.destroy();
    }
}

// アダプター内で
@Override
public void onViewRecycled(BannerViewHolder holder) {
    holder.recycle();
}

完全な例

Kotlinの例

import android.os.Bundle
import android.view.View
import android.widget.FrameLayout
import android.widget.ProgressBar
import android.widget.Toast
import androidx.appcompat.app.AppCompatActivity
import io.adrop.ads.banner.AdropBanner
import io.adrop.ads.banner.AdropBannerListener
import io.adrop.ads.model.AdropErrorCode

class BannerActivity : AppCompatActivity() {
    private var banner: AdropBanner? = null
    private lateinit var progressBar: ProgressBar

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_banner)

        progressBar = findViewById(R.id.progress_bar)
        setupBanner()
    }

    private fun setupBanner() {
        // 1. バナーインスタンスを作成
        // contextIdは読み取り専用プロパティ — コンストラクタで設定
        banner = AdropBanner(this, "YOUR_UNIT_ID", "article_sports").apply {
            // 2. リスナー設定
            listener = object : AdropBannerListener {
                override fun onAdReceived(banner: AdropBanner) {
                    println("バナー広告の受信成功")
                    progressBar.visibility = View.GONE
                }

                override fun onAdFailedToReceive(banner: AdropBanner, errorCode: AdropErrorCode) {
                    println("バナー広告の受信失敗: $errorCode")
                    progressBar.visibility = View.GONE

                    // エラー処理
                    when (errorCode) {
                        AdropErrorCode.ERROR_CODE_NETWORK -> {
                            showToast("ネットワーク接続を確認してください")
                        }
                        AdropErrorCode.ERROR_CODE_AD_NO_FILL -> {
                            println("表示可能な広告がありません")
                        }
                        else -> {
                            showToast("広告を読み込めませんでした")
                        }
                    }
                }

                override fun onAdImpression(banner: AdropBanner) {
                    println("バナー広告のインプレッション")
                }

                override fun onAdClicked(banner: AdropBanner) {
                    println("バナー広告がクリックされました")
                }
            }
        }

        // 3. ビュー階層に追加
        val container = findViewById<FrameLayout>(R.id.banner_container)
        val params = FrameLayout.LayoutParams(
            dpToPx(320),
            dpToPx(100)
        )
        container.addView(banner, params)

        // 4. 広告をロード
        progressBar.visibility = View.VISIBLE
        banner?.load()
    }

    private fun dpToPx(dp: Int): Int {
        val density = resources.displayMetrics.density
        return (dp * density).toInt()
    }

    private fun showToast(message: String) {
        Toast.makeText(this, message, Toast.LENGTH_SHORT).show()
    }

    override fun onDestroy() {
        super.onDestroy()
        // 5. メモリ解放
        banner?.destroy()
        banner = null
    }
}

Javaの例

import android.os.Bundle;
import android.view.View;
import android.widget.FrameLayout;
import android.widget.ProgressBar;
import android.widget.Toast;
import androidx.appcompat.app.AppCompatActivity;
import io.adrop.ads.banner.AdropBanner;
import io.adrop.ads.banner.AdropBannerListener;
import io.adrop.ads.model.AdropErrorCode;
import org.jetbrains.annotations.NotNull;

public class BannerActivity extends AppCompatActivity {
    private AdropBanner banner;
    private ProgressBar progressBar;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_banner);

        progressBar = findViewById(R.id.progress_bar);
        setupBanner();
    }

    private void setupBanner() {
        // 1. バナーインスタンスを作成（コンテキストID付き）
        banner = new AdropBanner(this, "YOUR_UNIT_ID", "article_sports");

        // 2. リスナー設定
        banner.setListener(new AdropBannerListener() {
            @Override
            public void onAdReceived(@NotNull AdropBanner banner) {
                System.out.println("バナー広告の受信成功");
                progressBar.setVisibility(View.GONE);
            }

            @Override
            public void onAdFailedToReceive(@NotNull AdropBanner banner, @NotNull AdropErrorCode errorCode) {
                System.out.println("バナー広告の受信失敗: " + errorCode);
                progressBar.setVisibility(View.GONE);

                // エラー処理
                if (errorCode == AdropErrorCode.ERROR_CODE_NETWORK) {
                    showToast("ネットワーク接続を確認してください");
                } else if (errorCode == AdropErrorCode.ERROR_CODE_AD_NO_FILL) {
                    System.out.println("表示可能な広告がありません");
                } else {
                    showToast("広告を読み込めませんでした");
                }
            }

            @Override
            public void onAdImpression(@NotNull AdropBanner banner) {
                System.out.println("バナー広告のインプレッション");
            }

            @Override
            public void onAdClicked(@NotNull AdropBanner banner) {
                System.out.println("バナー広告がクリックされました");
            }
        });

        // 3. ビュー階層に追加
        FrameLayout container = findViewById(R.id.banner_container);
        FrameLayout.LayoutParams params = new FrameLayout.LayoutParams(
            dpToPx(320),
            dpToPx(100)
        );
        container.addView(banner, params);

        // 4. 広告をロード
        progressBar.setVisibility(View.VISIBLE);
        banner.load();
    }

    private int dpToPx(int dp) {
        float density = getResources().getDisplayMetrics().density;
        return (int) (dp * density);
    }

    private void showToast(String message) {
        Toast.makeText(this, message, Toast.LENGTH_SHORT).show();
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        // 5. メモリ解放
        if (banner != null) {
            banner.destroy();
            banner = null;
        }
    }
}

XMLレイアウト

activity_banner.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <TextView
        android:id="@+id/title"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="バナー広告の例"
        android:textSize="24sp"
        android:textStyle="bold"
        android:layout_marginTop="32dp"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintEnd_toEndOf="parent" />

    <ProgressBar
        android:id="@+id/progress_bar"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:visibility="gone"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <FrameLayout
        android:id="@+id/banner_container"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_margin="16dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintEnd_toEndOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

一括ロード (loads)

AdropBanner.loads()を使用すると、1回の呼び出しで複数のバナー広告をまとめてリクエストできます。カルーセルやページネーション付きフィード、広告プールのプリフェッチなどに有用です。

シグネチャ

AdropBanner.loads(
    context: Context,
    unitId: String,
    contextId: String? = null,
    listener: AdropBannerListener,
)

AdropBanner.loads(context, "YOUR_UNIT_ID", null, listener);

使用方法

AdropBanner.loads(
    context = this,
    unitId = "YOUR_UNIT_ID",
    contextId = null,
    listener = object : AdropBannerListener {
        // バッチ成功 — 最大5個の準備済みバナーが渡されます。
        override fun onAdsReceived(banners: List<AdropBanner>) {
            banners.forEach { banner ->
                // ビュー階層へ追加 (ViewPager2、RecyclerViewなど)
                container.addView(banner)
            }
        }

        // バッチ失敗
        override fun onAdsFailedToReceive(errorCode: AdropErrorCode) {
            println("バッチロード失敗: $errorCode")
        }

        // 単体用コールバックはloads経路では呼ばれません。
        override fun onAdReceived(banner: AdropBanner) { /* batch path */ }
        override fun onAdFailedToReceive(banner: AdropBanner, errorCode: AdropErrorCode) {}

        // クリック/インプレッション/動画コールバックは各インスタンスで通常通り呼ばれます。
        override fun onAdClicked(banner: AdropBanner) {
            println("バナークリック: ${banner.creativeId}")
        }

        override fun onAdImpression(banner: AdropBanner) {
            println("バナーインプレッション: ${banner.creativeId}")
        }
    },
)

AdropBanner.loads(this, "YOUR_UNIT_ID", null, new AdropBannerListener() {
    @Override
    public void onAdsReceived(@NotNull List<AdropBanner> banners) {
        for (AdropBanner banner : banners) {
            container.addView(banner);
        }
    }

    @Override
    public void onAdsFailedToReceive(@NotNull AdropErrorCode errorCode) {
        System.out.println("バッチロード失敗: " + errorCode);
    }

    // 単体用コールバック — バッチ経路では使用されません。
    @Override
    public void onAdReceived(@NotNull AdropBanner banner) { }

    @Override
    public void onAdFailedToReceive(@NotNull AdropBanner banner, @NotNull AdropErrorCode errorCode) { }

    @Override
    public void onAdClicked(@NotNull AdropBanner banner) {
        System.out.println("バナークリック: " + banner.getCreativeId());
    }

    @Override
    public void onAdImpression(@NotNull AdropBanner banner) {
        System.out.println("バナーインプレッション: " + banner.getCreativeId());
    }
});

リスナーコールバック

コールバック	呼び出されるタイミング
`onAdsReceived(banners)`	バッチ配信完了。各`AdropBanner`にはリスナーがすでに付与され、広告データが適用されています。
`onAdsFailedToReceive(errorCode)`	リクエスト拒否、ネットワーク失敗、または表示可能な広告がなかった場合 (`ERROR_CODE_AD_NO_FILL`)。
`onAdClicked` / `onAdImpression` / `onAdVideoStart` / `onAdVideoEnd`	単体`load()`と同様に、各バナーごとに呼ばれます。

単体onAdReceived / onAdFailedToReceiveコールバックはloads()経路では呼ばれません。バッチ結果は必ずonAdsReceived / onAdsFailedToReceiveで受け取ってください。

制約事項

呼び出しあたり最大5個。 サーバーがそれ以上を返しても先頭の5個のみ配信されます。
バックフィルは適用されません。 ダイレクト広告が埋まらない場合、バックフィル設定に関わらずonAdsFailedToReceiveがERROR_CODE_AD_NO_FILLで呼ばれます。
onAdsReceived内でdestroy()を呼ばないでください。 まず各バナーをビュー階層に付加し、その後親Activity.onDestroy()(または同等のタイミング)でdestroy()してください。
onAdsReceivedは広告データが適用され次第発火し、単体load()と同じ動作です — ビューに付加後にクリエイティブが描画されます。

バックフィル広告

バックフィル広告が有効な場合、ダイレクト広告がないときに自動的にバックフィル広告がロードされます。isBackfilledプロパティでバックフィル広告かどうかを確認できます。

banner.listener = object : AdropBannerListener {
    override fun onAdReceived(banner: AdropBanner) {
        if (banner.isBackfilled) {
            println("バックフィル広告がロードされました")
        } else {
            println("ダイレクト広告がロードされました")
        }
    }

    override fun onAdFailedToReceive(banner: AdropBanner, errorCode: AdropErrorCode) {
        when (errorCode) {
            AdropErrorCode.ERROR_CODE_AD_NO_FILL -> {
                println("ダイレクト広告なし、バックフィルをリクエスト中...")
            }
            AdropErrorCode.ERROR_CODE_AD_BACKFILL_NO_FILL -> {
                println("バックフィル広告も利用不可")
            }
            else -> {
                println("広告ロード失敗: $errorCode")
            }
        }
    }
}

banner.setListener(new AdropBannerListener() {
    @Override
    public void onAdReceived(@NotNull AdropBanner banner) {
        if (banner.isBackfilled()) {
            System.out.println("バックフィル広告がロードされました");
        } else {
            System.out.println("ダイレクト広告がロードされました");
        }
    }

    @Override
    public void onAdFailedToReceive(@NotNull AdropBanner banner, @NotNull AdropErrorCode errorCode) {
        if (errorCode == AdropErrorCode.ERROR_CODE_AD_NO_FILL) {
            System.out.println("ダイレクト広告なし、バックフィルをリクエスト中...");
        } else if (errorCode == AdropErrorCode.ERROR_CODE_AD_BACKFILL_NO_FILL) {
            System.out.println("バックフィル広告も利用不可");
        } else {
            System.out.println("広告ロード失敗: " + errorCode);
        }
    }
});

バックフィル広告を使用するには、io.adrop:adrop-ads-backfill依存関係を追加する必要があります。

バックフィル広告のプリロード (preload)

SDK 1.17.0から、AdropBanner.preload()でバックフィルバナー広告をプリロードしておくことができます。同じユニットIDと同じサイズでload()したバナーが、ダイレクト広告なしでバックフィル広告に切り替わると、バックフィル広告を再度リクエストせず、プリロードしておいた広告をすぐに表示します。 load()はpreloadに関係なく、まずダイレクト広告をリクエストします。ダイレクト広告が表示された場合、プリロードしておいた広告はそのまま残ります。preloadを呼び出さなければ、動作はこれまでと同じです。

動作条件

io.adrop:adrop-adsとio.adrop:adrop-ads-backfillの両方が1.17.0以降である必要があります。
現在表示するダイレクト広告がないとサーバーからアプリに通知されている状態でのみ、バックフィル広告を受信します。それ以外の場合は、バックフィル広告をリクエストせずにERROR_CODE_AD_PRELOAD_SKIPPEDで終了します。ダイレクト広告のキャンペーンがあるアプリでは正常な結果です。
アプリのインストール直後、アプリキーを変更した直後、setUIDで別のユーザーに切り替えた直後は、サーバーの応答を受信するまでERROR_CODE_AD_PRELOAD_SKIPPEDで終了します。
テストユニットIDでは常にERROR_CODE_AD_PRELOAD_SKIPPEDで終了します。

使用方法

バナーを表示するActivityをcontextに渡し、バナーがある画面を表示する直前に呼び出してください。プリロードした広告は使用されないと30分後に破棄されるため、すぐに表示するバナーに対してのみ呼び出してください。結果を待ってからload()する必要はありません。まだ受信中の場合は、load()がその結果を待って使用します。

import io.adrop.ads.banner.AdropBanner
import io.adrop.ads.banner.AdropBannerListener
import io.adrop.ads.model.AdropErrorCode
import io.adrop.ads.model.CreativeSize

AdropBanner.preload(
    context = this, // バナーを表示するActivity
    unitId = "YOUR_UNIT_ID",
    adSize = CreativeSize(320.0, 50.0), // 省略すると320x50
    listener = object : AdropBannerListener {
        override fun onAdPreloadReceived(unitId: String, contextId: String?) {
            println("プリロード完了: $unitId")
        }

        override fun onAdPreloadFailedToReceive(unitId: String, contextId: String?, errorCode: AdropErrorCode) {
            // ERROR_CODE_AD_PRELOAD_SKIPPEDは正常な結果です。
            // ここでpreloadをすぐに再度呼び出さないでください。
            println("プリロードされませんでした: $errorCode")
        }

        // preloadでは呼び出されません。
        override fun onAdReceived(banner: AdropBanner) {}
        override fun onAdClicked(banner: AdropBanner) {}
        override fun onAdFailedToReceive(banner: AdropBanner, errorCode: AdropErrorCode) {}
    },
)

import io.adrop.ads.banner.AdropBanner;
import io.adrop.ads.banner.AdropBannerListener;
import io.adrop.ads.model.AdropErrorCode;
import io.adrop.ads.model.CreativeSize;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

AdropBanner.preload(this, "YOUR_UNIT_ID", null, new CreativeSize(320.0, 50.0), new AdropBannerListener() {
    @Override
    public void onAdPreloadReceived(@NotNull String unitId, @Nullable String contextId) {
        System.out.println("プリロード完了: " + unitId);
    }

    @Override
    public void onAdPreloadFailedToReceive(@NotNull String unitId, @Nullable String contextId, @NotNull AdropErrorCode errorCode) {
        // ERROR_CODE_AD_PRELOAD_SKIPPEDは正常な結果です。
        // ここでpreloadをすぐに再度呼び出さないでください。
        System.out.println("プリロードされませんでした: " + errorCode);
    }

    // preloadでは呼び出されません。
    @Override
    public void onAdReceived(@NotNull AdropBanner banner) { }

    @Override
    public void onAdClicked(@NotNull AdropBanner banner) { }

    @Override
    public void onAdFailedToReceive(@NotNull AdropBanner banner, @NotNull AdropErrorCode errorCode) { }
});

プリロードしておいた広告を使用するには、load()するバナーのadSizeを、preloadに渡したサイズと同じに設定してください。

val banner = AdropBanner(this, "YOUR_UNIT_ID")
banner.adSize = CreativeSize(320.0, 50.0) // preloadに渡したサイズ
container.addView(banner)
banner.load()

AdropBanner banner = new AdropBanner(this, "YOUR_UNIT_ID", null);
banner.setAdSize(new CreativeSize(320.0, 50.0)); // preloadに渡したサイズ
container.addView(banner);
banner.load();

プリロードした広告が使われる条件

同じユニットIDと同じサイズ: load()するバナーのadSize（指定していない場合は画面に配置されたビューのサイズ、dp）が、preloadに渡したサイズと同じである必要があります。サイズが異なる場合、プリロードした広告はそのまま残り、load()は通常どおりバックフィル広告をリクエストします。
同じActivity: preloadに渡したActivityとは別のActivityで作成したバナーには使用されません（例：スプラッシュActivityでpreloadし、メインActivityでload()）。preloadに渡したActivityが終了すると、プリロードした広告も破棄されます。
一度だけ使用: プリロードした広告は、1回のload()で使用されるとなくなります。再度プリロードするには、preloadをもう一度呼び出してください。
有効期間と個数: 30分以内に使用されなかった広告は破棄されます。同じユニット・サイズには1個のみ保持し、バナーは異なるユニット・サイズの組み合わせを最大5個まで保持します。5個を超えると、最も早く受信した広告から破棄します。
再度呼び出す場合: 同じユニット・サイズで再度呼び出しても、新たにリクエストしません。受信済みの広告がある場合は新しいリクエストなしでonAdPreloadReceivedが呼び出され、受信中の場合はそのロードの結果（成功または失敗）がそのまま伝えられます。広告を更新する用途には使用できません。ただし、その間にユーザーの同意状態が変わった場合や、別のActivityを渡して呼び出した場合は、既存の広告を破棄して新たに受信します。
同意状態の変更: プリロードした後にユーザーの同意状態が変わると、その広告はload()に使用されません。

結果コールバック

AdropBannerListenerに次のコールバックが追加されました。どちらも任意実装で、preloadを呼び出すたびに、いずれか一方がメインスレッドで1回呼び出されます。preloadでは、ほかのリスナーコールバックは呼び出されません。

コールバック	呼び出されるタイミング
`onAdPreloadReceived(unitId, contextId)`	プリロードが完了したとき。その結果を待っていた`load()`がすでに使用している場合もあります。
`onAdPreloadFailedToReceive(unitId, contextId, errorCode)`	プリロードできなかったとき

contextIdは、preloadに渡した値をそのまま返します。プリロードした広告の選択には使用されません。

失敗コード

エラーコード	説明
`ERROR_CODE_AD_PRELOAD_SKIPPED`	ダイレクト広告が表示される可能性があるか、まだ確認されていないため、バックフィル広告をリクエストしませんでした。正常な結果のため、次の画面を表示する直前に再度呼び出してください。
`ERROR_CODE_AD_NO_FILL`	1.17.0以降のバックフィル依存関係がないか、ユニットにバックフィルが設定されていないか、SDKがその設定をまだ受信していません。しばらくしてから再度呼び出してください。バックフィル依存関係がない場合は、引き続きこのコードで終了します。
`ERROR_CODE_AD_BACKFILL_NO_FILL`	バックフィル広告がありません。
`ERROR_CODE_INTERNAL`	リクエストが中断されたか（例：受信中にpreloadに渡したActivityが終了した）、内部エラーが発生しました。後で再度呼び出してください。
`ERROR_CODE_INITIALIZE`	SDKが初期化されていません。`Adrop.initialize()`の対象国に属さないデバイスでも、このコードで終了します。
`ERROR_CODE_INVALID_UNIT`	ユニットIDが空です。

失敗コールバック内でpreloadをすぐに再度呼び出さないでください。バックフィル依存関係がない場合のように結果が変わらないと、呼び出しが際限なく繰り返されます。次の画面を表示する前など、後で再度呼び出してください。

次のステップ

ネイティブ広告

UIに合わせてカスタマイズ可能なネイティブ広告を実装

インタースティシャル広告

全画面のインタースティシャル広告を実装

ターゲティング設定

ユーザー属性とコンテキストターゲティングを設定

リファレンス

クラス、リスナー、エラーコードを確認

​概要

​主な特徴

​XMLレイアウト実装

​1. XMLレイアウト定義

​2. Activityからロード

​XML属性

​プログラム方式での実装

​AdropBannerの初期化

​コンストラクタ

​ユニットIDの設定

​広告のロード

​リスナーの実装

​onAdReceived（必須）

​onAdFailedToReceive（必須）

​onAdImpression（オプション）

​onAdClicked（必須）

​onAdVideoStart（オプション）

​onAdVideoEnd（オプション）

​コンテキストIDの設定

​ライフサイクル管理

​destroy()

​広告サイズ

​一般的なバナーサイズ

​XMLでサイズを指定

​コードでサイズを指定

​テストユニットID

​使用例

​動画再生制御

​play()

​pause()

​例：バックグラウンド/フォアグラウンドの処理

​カスタムクリック処理

​open()

​ベストプラクティス

​1. メモリ管理

​2. 画面の可視性

​3. エラー処理

​4. RecyclerViewでの使用

​完全な例

​Kotlinの例

​Javaの例

​XMLレイアウト

​一括ロード (loads)

​シグネチャ

​使用方法

​リスナーコールバック

​制約事項

​バックフィル広告

​バックフィル広告のプリロード (preload)

​動作条件

​使用方法

​プリロードした広告が使われる条件

​結果コールバック

​失敗コード

​次のステップ

ネイティブ広告

インタースティシャル広告

ターゲティング設定

リファレンス

概要

主な特徴

XMLレイアウト実装

1. XMLレイアウト定義

2. Activityからロード

XML属性

プログラム方式での実装

AdropBannerの初期化

コンストラクタ

ユニットIDの設定

広告のロード

リスナーの実装

onAdReceived（必須）

onAdFailedToReceive（必須）

onAdImpression（オプション）

onAdClicked（必須）

onAdVideoStart（オプション）

onAdVideoEnd（オプション）

コンテキストIDの設定

ライフサイクル管理

destroy()

広告サイズ

一般的なバナーサイズ

XMLでサイズを指定

コードでサイズを指定

テストユニットID

使用例

動画再生制御

play()

pause()

例：バックグラウンド/フォアグラウンドの処理

カスタムクリック処理

open()

ベストプラクティス

1. メモリ管理

2. 画面の可視性

3. エラー処理

4. RecyclerViewでの使用

完全な例

Kotlinの例

Javaの例

XMLレイアウト

一括ロード (loads)

シグネチャ

使用方法

リスナーコールバック

制約事項

バックフィル広告

バックフィル広告のプリロード (preload)

動作条件

使用方法

プリロードした広告が使われる条件

結果コールバック

失敗コード

次のステップ