動画インタースティシャル広告実装手順
まだ広告枠作成、SDKダウンロードを行っていない場合、下記リンク先を参照してください。
プロジェクトにSDKを追加していない場合、以下の方法でSDKを追加してください。
動画インタースティシャル広告の実装は以下の５ステップで完了します。
まず、NendAdInterstitialVideoのインスタンスを生成します。
Kotlin
import net.nend.android.NendAdInterstitialVideo
...
class VideoActivity : AppCompatActivity() {
private lateinit var nendAdInterstitialVideo: NendAdInterstitialVideo
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
nendAdInterstitialVideo = NendAdInterstitialVideo(this, spotId, "apikey")
}
}Java
import net.nend.android.NendAdInterstitialVideo;
...
public class MainActivity extends AppCompatActivity {
private NendAdInterstitialVideo mNendAdInterstitialVideo;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
mNendAdInterstitialVideo = new NendAdInterstitialVideo(this, spotId, "apikey");
}
}| 引数名 | 型 | 説明 |
|---|---|---|
| context | Context | |
| spotId | int | 管理画面より発行されたSpotId |
| apiKey | String | 管理画面より発行されたApiKey |
loadAdメソッドで広告をロードします。
Kotlin
nendAdInterstitialVideo.loadAd()Java
mNendAdInterstitialVideo.loadAd();type プロパティでロードされた広告タイプを取得することができます。
| type | 内容 |
|---|---|
NORMAL |
通常の動画インタースティシャル広告 |
PLAYABLE |
ユーザーによる操作が可能な広告 |
isLoadedメソッドで広告のロードが完了していることを確認してから、showAdメソッドで広告を表示します。
Kotlin
if (nendAdInterstitialVideo.isLoaded) {
nendAdInterstitialVideo.showAd(this)
}Java
if (mNendAdInterstitialVideo.isLoaded()) {
mNendAdInterstitialVideo.showAd(this);
}releaseAdメソッドで動画広告用の不要なリソースを破棄します。また、広告のロード中に呼ばれた場合はそのロードのキャンセルも行います。
動画広告を使用後に不要になったタイミングや動画広告を利用しているActivityのonDestroyでreleaseAdメソッドを呼び出すようにしてください。
また、releaseAdメソッドを呼び出した後に再度動画広告を使用する場合は、NendAdInterstitialVideoのインスタンスを生成し直してください。
Kotlin
nendAdInterstitialVideo.releaseAd() // 広告を破棄Java
mNendAdInterstitialVideo.releaseAd(); // 広告を破棄必要に応じて以下のオプション機能を実装してください。
setActionListenerメソッドでNendAdVideoActionListenerのイベントリスナーを登録します。
NendAdVideoはNendAdInterstitialVideoやNendAdRewardedVideoの親クラスです。NendAdVideoActionListenerの各リスナーで渡される引数nendAdVideoはNendAdInterstitialVideoのオブジェクトになります。
| インタラクティブ広告( NendAdVideoType.PLAYABLE )では NendAdVideoPlayingStateListenerによる動画再生状態のイベント通知を受け取ることができません。 |
通常の動画インタースティシャル(NendAdVideoType.NORMAL)では動画再生時、動画停止時、動画視聴終了のタイミングで、各処理に関するコールバックを受け取ることができます。
しかしインタラクティブ広告(NendAdVideoType.PLAYABLE)は動画ではなくWebView上で動作するコンテンツのため、
動画再生時、動画停止時、動画視聴終了時という概念が存在せず、コールバックを受け取ることはできないため注意が必要です。
Kotlin
import net.nend.android.NendAdVideoActionListener
import net.nend.android.NendAdVideo
...
nendAdInterstitialVideo.setActionListener(object : NendAdVideoActionListener {
override fun onLoaded(nendAdVideo: NendAdVideo) {
// 広告のロードが完了した
when (nendAdVideo.type) {
NendAdVideoType.PLAYABLE -> Log.d(TAG, "インタラクティブ広告では動画の再生状態は通知されません")
NendAdVideoType.NORMAL -> {
nendAdInterstitialVideo.playingState()?.let {
it.playingStateListener = object : NendAdVideoPlayingStateListener {
override fun onStarted(nendAdVideo: NendAdVideo) {
// 動画の再生を開始した
}
override fun onStopped(nendAdVideo: NendAdVideo) {
// 動画の再生を停止した
}
override fun onCompleted(nendAdVideo: NendAdVideo) {
// 動画の再生が最後まで完了した
}
}
}
}
else -> Log.d(TAG, nendAdVideo.type.toString())
}
}
override fun onFailedToLoad(nendAdVideo: NendAdVideo, errorCode: Int) {
// 広告のロードに失敗した
Log.w(TAG, "errorCode: $errorCode")
}
override fun onFailedToPlay(nendAdVideo: NendAdVideo) {
// 広告の再生に失敗した
}
override fun onShown(nendAdVideo: NendAdVideo) {
// 広告を表示した
}
override fun onClosed(nendAdVideo: NendAdVideo) {
// 広告を閉じた
}
override fun onAdClicked(nendAdVideo: NendAdVideo) {
// 広告をクリックした
}
override fun onInformationClicked(nendAdVideo: NendAdVideo) {
// インフォメーションボタンをクリックした
}
})Java
import net.nend.android.NendAdVideoActionListener;
import net.nend.android.NendAdVideo;
...
mNendAdInterstitialVideo.setActionListener(new NendAdVideoActionListener() {
@Override
public void onLoaded(NendAdVideo nendAdVideo) {
// 広告のロードが完了した
switch (mNendAdInterstitialVideo.getType()) {
case PLAYABLE:
Log.d(TAG, "インタラクティブ広告では動画の再生状態は通知されません");
break;
case NORMAL:
NendAdVideoPlayingState state = mNendAdInterstitialVideo.playingState();
if (state != null) {
state.setPlayingStateListener(new NendAdVideoPlayingStateListener() {
@Override
public void onStarted(NendAdVideo nendAdVideo) {
// 動画の再生を開始した
}
@Override
public void onStopped(NendAdVideo nendAdVideo) {
// 動画の再生を停止した
}
@Override
public void onCompleted(NendAdVideo nendAdVideo) {
// 動画の再生が最後まで完了した
}
});
}
break;
default:
break;
}
}
@Override
public void onFailedToLoad(NendAdVideo nendAdVideo, int errorCode) {
// 広告のロードに失敗した
Log.d(TAG, "errorCode:" + errorCode);
}
@Override
public void onFailedToPlay(NendAdVideo nendAdVideo) {
// 広告の再生に失敗した
}
@Override
public void onShown(NendAdVideo nendAdVideo) {
// 広告を表示した
}
@Override
public void onClosed(NendAdVideo nendAdVideo) {
// 広告を閉じた
}
@Override
public void onAdClicked(NendAdVideo nendAdVideo) {
// 広告をクリックした
}
@Override
public void onInformationClicked(NendAdVideo nendAdVideo) {
// インフォメーションボタンをクリックした
}
});public void onFailedToLoad(NendAdVideo nendAdVideo, int errorCode)の引数errorCodeの情報は以下の通りです。
| エラーコード | 説明 |
|---|---|
| 204 | 配信広告なし |
| 400 | 不正なリクエスト |
| 5XX | サーバーエラー |
| 600 | SDK内部のエラー |
| 601 | 広告ダウンロード失敗 |
| 602 | フルボード広告のフォールバック失敗 |
| 603 | ネットワークが無効 |
本機能はnendSDKv10.0.0以降非推奨になりました
アプリ内のユーザーIDを設定する場合は、 setUserId メソッドで利用したいユーザーIDを文字列で設定します。
Kotlin
nendAdInterstitialVideo.setUserId("ユーザーID")Java
mNendAdInterstitialVideo.setUserId("ユーザーID");本機能はnendSDKv10.0.0以降非推奨になりました
v4.0.3のnendSDKより、動画広告のターゲティングにユーザー属性を利用できるようになりました。
利用可能なユーザー属性は以下の通りです。
- 性別
- 生年月日
- 年齢
- その他特徴（アプリ側で自由に設定可能）
Kotlin
import net.nend.android.NendAdUserFeature
...
// 単一の属性を利用する例
val feature = NendAdUserFeature.Builder()
.setBirthday(1985,1,1)
.build()
nendAdInterstitialVideo.setUserFeature(feature)
...
// 複数の属性を利用する例
val feature = NendAdUserFeature.Builder()
.setGender(NendAdUserFeature.Gender.MALE) // 性別
.setBirthday(1985, 1, 1) // 生年月日 (e.g. 1985年1月1日)
.setAge(34) // 年齢
.addCustomFeature("stringParameter", "test") // key-value形式のカスタムパラメーター
.addCustomFeature("booleanParameter", true)
.addCustomFeature("integerParameter", 100)
.addCustomFeature("doubleParameter", 123.45)
.build()
nendAdInterstitialVideo.setUserFeature(feature)
Java
import net.nend.android.NendAdUserFeature;
...
// 単一の属性を利用する例
NendAdUserFeature feature = new NendAdUserFeature.Builder()
.setBirthday(1985, 1, 1) // 生年月日 (e.g. 1985年1月1日)
.build();
mNendAdInterstitialVideo.setUserFeature(feature);
...
// 複数の属性を利用する例
NendAdUserFeature feature = new NendAdUserFeature.Builder()
.setGender(NendAdUserFeature.Gender.MALE) // 性別
.setBirthday(1985, 1, 1) // 生年月日 (e.g. 1985年1月1日)
.setAge(34) // 年齢
.addCustomFeature("stringParameter", "test") // key-value形式のカスタムパラメーター
.addCustomFeature("booleanParameter", true)
.addCustomFeature("integerParameter", 100)
.addCustomFeature("doubleParameter", 123.45)
.build();
mNendAdInterstitialVideo.setUserFeature(feature);備考:
- 生年月日と年齢の両方が設定されていた場合は、生年月日の方が優先されます
- カスタムパラメーターで設定可能な値は、文字列 or 数値 or 真偽値のみになります
- 年齢ではなく年代を設定したい場合は、カスタムパラメーターの方をご利用ください
setMuteStartPlayingメソッドでミュートの指定を行います。
デフォルトはtrueです（音声OFFで再生します）
Kotlin
nendAdInterstitialVideo.setMuteStartPlaying(false)Java
mNendAdInterstitialVideo.setMuteStartPlaying(false);在庫切れ等の事由により動画インタースティシャル広告が表示できない場合に、代わりに全画面のフルボード広告を表示するオプションです。 こちらの機能をご利用になる場合は、nend管理画面でフルボード広告の広告枠を別途ご用意いただく必要がございます。 詳細はこちらをご参照ください。
Kotlin
nendAdInterstitialVideo.addFallbackFullboard(full board spot id, "full board api key")Java
mNendAdInterstitialVideo.addFallbackFullboard(full board spot id, "full board api key");動画広告のテストモードは、次の内どちらか一方をご利用ください。
- テスト用IDを使う
- デバイスのGAID(Google Advertising ID)を管理画面上で登録する
-
アプリのログ出力を有効化します。
-
動画インタースティシャル広告のインスタンスを生成して、adbログを確認します。「Google Advertising ID = 」で出力された値を確認してください。
-
出力された値を管理画面へ登録します。