# 20231115 広告イベント取得方法の変更
# 概要
本ガイドではiOS FiveSDK v2.7.20231115で導入された新しい広告イベント取得方法への移行手順を説明します。
新APIでは広告イベントの取得に関して次の変更が導入されました。
- 広告フォーマットごとに異なるコールバックプロトコルを提供
- （動画リワード広告）リワード付与イベントを提供
以下ではこれらの変更に対応する方法について説明します。
# 広告フォーマットごとに異なるコールバックプロトコルを提供
旧APIでは広告フォーマットが何であれ同じコールバックプロトコルを提供していました。 新APIでは広告フォーマットごとに異なるコールバックプロトコルを提供します。
NOTE
広告オブジェクトのロード完了を通知する FADLoadDelegate コールバックプロトコルについては移行作業は必要ありません。
各フォーマットごとに広告イベント取得コードを新APIに書き換えてください。 新旧APIの対応表および書き換えBefore-Afterのサンプルコードを以下に示します。
# カスタムレイアウト広告
# 新旧API対応表
| 広告イベント | 種別 | 旧API | 新API |
|---|---|---|---|
| エラー | 動画・静止画共通 | fiveAd:didFailedToShowAdWithError: | fiveCustomLayoutAd:didFailedToShowAdWithError: |
| インプレッション | 動画・静止画共通 | fiveAdDidImpression: | fiveCustomLayoutAdDidImpression: |
| クリック | 動画・静止画共通 | fiveAdDidClick: | fiveCustomLayoutAdDidClick: |
| カスタムレイアウト広告ビュー除去 | 動画・静止画共通 | fiveAdDidClose: | fiveCustomLayoutAdViewDidRemove: |
| 再生開始 | 動画広告のみ | fiveAdDidStart: | fiveCustomLayoutAdDidPlay: |
| 一時停止 | 動画広告のみ | fiveAdDidPause: | fiveCustomLayoutAdDidPause: |
| 再生完了 | 動画広告のみ | fiveAdDidViewThrough: | fiveCustomLayoutAdDidViewThrough: |
| 再生再開 | 動画広告のみ | fiveAdDidResume: | 廃止 (fiveCustomLayoutAdDidPlay: に統合) |
| リプレイ | 動画広告のみ | fiveAdDidReplay: | 廃止 (fiveCustomLayoutAdDidPlay: に統合) |
| ストール | 動画広告のみ | fiveAdDidStall: | 廃止 |
| ストール復帰 | 動画広告のみ | fiveAdDidRecover: | 廃止 |
# Before(旧API)
# After(新API)
# 動画リワード広告
# 新旧API対応表
| 広告イベント | 種別 | 旧API | 新API |
|---|---|---|---|
| エラー | 動画・静止画共通 | fiveAd:didFailedToShowAdWithError: | fiveVideoRewardAd:didFailedToShowAdWithError: |
| リワード | 動画・静止画共通 | 該当なし (fiveAdDidClose: に統合) | fiveVideoRewardAdDidReward: |
| インプレッション | 動画・静止画共通 | fiveAdDidImpression: | fiveVideoRewardAdDidImpression: |
| クリック | 動画・静止画共通 | fiveAdDidClick: | fiveVideoRewardAdDidClick: |
| フルスクリーン広告ビューオープン | 動画・静止画共通 | 該当なし | fiveVideoRewardAdFullScreenDidOpen: |
| フルスクリーン広告ビュークローズ | 動画・静止画共通 | fiveAdDidClose: | fiveVideoRewardAdFullScreenDidClose |
| 再生開始 | 動画広告のみ | fiveAdDidStart: | fiveVideoRewardAdDidPlay: |
| 一時停止 | 動画広告のみ | fiveAdDidPause: | fiveVideoRewardAdDidPause: |
| 再生完了 | 動画広告のみ | fiveAdDidViewThrough: | fiveVideoRewardAdDidViewThrough |
| 再生再開 | 動画広告のみ | fiveAdDidResume: | 廃止 (fiveVideoRewardAdDidPlay: に統合) |
| リプレイ | 動画広告のみ | fiveAdDidReplay: | 廃止 (fiveVideoRewardAdDidPlay: に統合) |
| ストール | 動画広告のみ | fiveAdDidStall: | 廃止 |
| ストール復帰 | 動画広告のみ | fiveAdDidRecover: | 廃止 |
# Before(旧API)
# After(新API)
# インタースティシャル広告
# 新旧API対応表
| 広告イベント | 種別 | 旧API | 新API |
|---|---|---|---|
| エラー | 動画・静止画共通 | fiveAd:didFailedToShowAdWithError: | fiveInterstitialAd:didFailedToShowAdWithError: |
| インプレッション | 動画・静止画共通 | fiveAdDidImpression: | fiveInterstitialAdDidImpression: |
| クリック | 動画・静止画共通 | fiveAdDidClick: | fiveInterstitialAdDidClick: |
| フルスクリーン広告ビューオープン | 動画・静止画共通 | 該当なし | fiveInterstitialAdFullScreenDidOpen: |
| フルスクリーン広告ビュークローズ | 動画・静止画共通 | fiveAdDidClose: | fiveInterstitialAdFullScreenDidClose: |
| 再生開始 | 動画広告のみ | fiveAdDidStart: | fiveInterstitialAdDidPlay: |
| 一時停止 | 動画広告のみ | fiveAdDidPause: | fiveInterstitialAdDidPause: |
| 再生完了 | 動画広告のみ | fiveAdDidViewThrough: | fiveInterstitialAdDidViewThrough: |
| 再生再開 | 動画広告のみ | fiveAdDidResume: | 廃止 (fiveInterstitialAdDidPlay: に統合) |
| リプレイ | 動画広告のみ | fiveAdDidReplay: | 廃止 (fiveInterstitialAdDidPlay: に統合) |
| ストール | 動画広告のみ | fiveAdDidStall: | 廃止 |
| ストール復帰 | 動画広告のみ | fiveAdDidRecover: | 廃止 |
# Before(旧API)
# After(新API)
# （動画リワード広告）リワード付与イベントを提供
旧APIは広告枠が閉じるタイミングのイベントをもってリワードを付与することを推奨してきました。 新APIからは独立したリワード付与イベントを提供しています。 今後はリワード付与についてはそちらの新しいイベントをご利用ください。
ユーザーにリワードを付与するコードを次のように書き換えてください。
# Before(旧API)
# After(新API)
← お問い合わせ