インタースティシャル広告クラスの説明

ADFInterstitial

static void initializeWithAppID(const char* appId);

パラメータ	説明
appID	対象の広告枠ID

アドフリくんインタースティシャルの初期化を行います。 (既に読込開始している広告枠を指定した場合は、既存の読込が継続されます。)

---

static void setDelegate(const char* appId, ADFInterstitialDelegate* delegate);

パラメータ	説明
appID	対象の広告枠ID
delegate	デリゲート(後述)を実装したクラスのインスタンス

デリゲートを受け取るインスタンスを設定します。

---

static ADFInterstitialDelegate* getDelegate(const char* appId);

パラメータ	説明
appID	対象の広告枠ID

設定したデリゲートインスタンスを取得します。

---

static void detachDelegate(const char* appID);

パラメータ	説明
appID	対象の広告枠ID

設定したデリゲートインスタンスの参照を外します。

---

static bool isPrepared(const char* appId);

パラメータ	説明
appID	対象の広告枠ID

広告が表示できる状態の場合trueを返します。

---

static void load(const char* appId);
static void loadWithTimeout(const char* appId, int timeout);

パラメータ	説明
appID	対象の広告枠ID
timeout	タイムアウト(単位:seconds)

広告のロードを開始します。Timeoutが設定されていると広告読み込みの結果Callbackは必ずTimeout以内に発生します。

---

static void play(const char* appId);
static void playWithCustomParams(const char* appId, std::map<std::string, std::string> customParams);

パラメータ	説明
appID	対象の広告枠ID
customParams	イベントにcustomParams情報が送信されます

広告を表示します。再生準備が完了したアドネットワークの中から、1つ動画が選択されます。

---

static void dispose();

アドフリくんSDKに保持されたADFInterstitialインスタンスを破棄します。ADFInterstitialインスタンスを使わなくなった場合、dispose関数を呼び出して下さい。

---

ADFInterstitialDelegate

virtual void prepareSuccess(const char* appId, bool isManualMode) = 0;

パラメータ	説明
appId	広告枠ID
isManualMode	手動モード判定(true: 手動, false: 自動)

広告のロード成功時に呼ばれます。

---

virtual void startPlaying(const char* appId, const char* adnetworkKey) = 0;

パラメータ	説明
appID	広告枠ID
adnetworkKey	再生を開始したアドネットワークのアドネットワークキー

広告の再生開始時に呼ばれます。

---

virtual void finishedPlaying(const char* appId, const char* adnetworkKey) = 0;

パラメータ	説明
appID	広告枠ID
adnetworkKey	再生を開始したアドネットワークのアドネットワークキー

広告を最後まで視聴した時に呼ばれます。(アドネットワークによって呼ばれるタイミングが異なる場合がございます)

---

virtual void adClose(const char* appId, const char* adnetworkKey) = 0;

パラメータ	説明
appID	広告枠ID
adnetworkKey	再生を開始したアドネットワークのアドネットワークキー

広告を閉じた時に呼ばれます。

---

virtual void prepareFailure(const char* appId, int errorCode) = 0;

パラメータ	説明
appID	広告枠ID
error	エラー情報

■ エラーコード（Android）

タイプ	コード	内容
NO_AD	0	広告の在庫がない場合
NO_NETWORK	1	オフラインまたはフライトモードの場合
LOADING	2	広告読み込み中の場合
INVALID_APP_ID	3	広告IDが登録されている内容と異なる場合
API_REQUEST_FAILURE	4	リクエストが失敗した場合
NO_SUPPORT_API_VERSION	5	API Levelが14以下の場合
PLAYER_ITEM_LOAD_FAILURE	6	広告の読み込みが失敗した場合
PLAYER_ITEM_PLAY_FAILURE	7	広告の再生が失敗した場合
OTHER_ERROR	8	その他の予期せぬエラーが発生した場合

■ エラーコード（iOS）

タイプ	コード	説明	対応方法
ADF_FETCH_ERROR_CODE_OUTOFSTOCK	203	ADNWから在庫が返却されなかった場合	広告取得に失敗するケース を確認する アドフリくん担当者に在庫状況を確認してもらう 時間をおいて読み込みをリトライするように実装する
ADF_FETCH_ERROR_CODE_NOADNETWORK	400	配信設定において利用可能なADNWが一つもなかった場合	広告取得に失敗するケース を確認する
ADF_FETCH_ERROR_CODE_API_REQUEST_FAILURE	500	配信設定の取得に失敗した場合	端末のネットワーク状況を確認する
ADF_FETCH_ERROR_CODE_ALREADY_LOADING	999	前回のLoadingがまだ完了してない場合	読み込み成功・失敗Callbackが発生した後再度読み込みをするように実装変更

広告ロード失敗時に呼ばれます。

---

virtual void failedPlaying(const char* appId, const char* adnetworkKey) = 0;

パラメータ	説明
appID	広告枠ID
adnetworkKey	再生を開始したアドネットワークのアドネットワークキー

動画の再生が失敗した場合に呼ばれます。