インタースティシャル広告クラスの説明 - glossom-dev/AdfurikunSDK-ReactNative GitHub Wiki
AdfurikunInterstitial(appId: string)
パラメータ | 説明 |
---|---|
appId |
アドフリくん広告枠ID |
AdfurikunInterstitial
のインスタンスを生成し、アドフリくんの初期化を行います。
AdfurikunInterstitialCallbackResult? callback;
アドフリくんからのコールバックを代入します。
type AdfurikunInterstitialCallbackResult(
type?: AdfurikunInterstitialCallbackType,
appId?: string,
adNetworkKey?: string,
errorCode?: number,
adNetworkErrorList?: AdNetworkError[]
パラメータ | 説明 |
---|---|
type |
AdfurikunInterstitialCallbackType の値が渡されます。 |
appId |
アドフリくん広告枠IDが渡されます。 |
adNetworkKey |
アドネットワークキーが渡されます。callbackがAdfurikunInterstitialCallbackType.onStartPlaying の時に値が入ります。 |
errorCode |
エラーコードが渡されます。詳細はエラーコードリファレンスを確認してください。 |
adNetworkErrorList |
アドネットワークから発生したエラー内容が渡されます。 callbackが onPrepareFailure とonFailedPlaying の時に値が入ります。アドネットワーク別エラーコード情報の詳細はAndroid・iOS |
AdfurikunInterstitialCallbackType | 説明 |
---|---|
onPrepareSuccess |
広告のロードが成功しました。 |
onPrepareFailure |
広告のロードが失敗しました。 |
onStartPlaying |
広告の再生を開始しました。 |
onFinishedPlaying |
広告の再生が完了しました。 |
onFailedPlaying |
広告の再生中にエラーが発生しました。 |
onAdClose |
広告を閉じました。 |
load()
loadWithTimeout(timeout: number)
パラメータ | 説明 |
---|---|
timeout |
読み込みの結果時間(時間単位:seconds) |
各アドネットワークの広告ロードを開始します。
loadWithTimeout
関数でロードした場合、広告の取得結果に関するコールバック
(onPrepareSuccess
またはonPrepareFailure
)は、必ずtimeout
引数で設定された時間内に呼び出されます。
詳細はベストプラクティスをご確認ください。
play()
play(customParams?: Map<string, string>)
パラメータ | 説明 |
---|---|
customParams |
任意の値をセットすることで、その値をアドフリくんのサーバーにログとして送信できます。 ※本機能は必要に応じて使用してください。機能の必要性については、サポートにお問い合わせください。 |
広告を表示します。再生準備が完了したアドネットワークの中から、1つ動画が選択されます。
isPrepared(): Promise<boolean>
広告が表示できる状態の場合はtrue、表示出来ない場合はfalseを返します。非同期で値を返します。
destroy()
アドフリくんSDKに保持されたAdfurikunInterstitial
インスタンスを破棄します。
AdfurikunInterstitial
インスタンスを使わなくなった場合、destroy
関数を呼び出して下さい。