動画リワード広告クラスの説明 - glossom-dev/AdfurikunSDK-ReactNative GitHub Wiki

AdfurikunReward

コンストラクタ

AdfurikunReward(appId: string)
パラメータ 説明
appId アドフリくん広告枠ID

AdfurikunRewardのインスタンスを生成し、アドフリくんの初期化を行います。

プロパティ

AdfurikunRewardCallbackResult? callback;

アドフリくんからのコールバックを代入します。

AdfurikunRewardCallbackResult

type AdfurikunRewardCallbackResult(
    type?: AdfurikunRewardCallbackType,
    appId?: string,
    adNetworkKey?: string,
    errorCode?: number,
    adNetworkErrorList?: AdNetworkError[],
    isRewarded?: boolean
パラメータ 説明
type AdfurikunRewardCallbackTypeの値が渡されます。
appId アドフリくん広告枠IDが渡されます。
adNetworkKey アドネットワークキーが渡されます。callbackがAdfurikunRewardCallbackType.onStartPlayingの時に値が入ります。
errorCode エラーコードが渡されます。詳細はエラーコードリファレンスを確認してください。
adNetworkErrorList アドネットワークから発生したエラー内容が渡されます。
callbackがonPrepareFailureとonFailedPlayingの時に値が入ります。
アドネットワーク別エラーコード情報の詳細はAndroid・iOS
AdfurikunRewardCallbackType 説明
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に保持されたAdfurikunRewardインスタンスを破棄します。
AdfurikunRewardインスタンスを使わなくなった場合、destroy関数を呼び出して下さい。

⚠️ **GitHub.com Fallback** ⚠️