API

ここでは、Michao!!のAPIリファレンスを提供します。

API リファレンス

主要メソッド

メソッド説明パラメータ戻り値
window.alm.defineAdSlot広告枠を定義。このメソッドを必ず最初に実行してください。placementId: string, tagId: stringPromise<void>
window.alm.render広告を表示tagId: stringPromise<void>
window.alm.getAdTracker広告トラッカーを取得tagId: stringPromise<AdTracker>
window.alm.clear広告枠をクリアtagId: stringvoid

AdTracker メソッド

メソッド説明パラメータ
trackイベントを監視eventName: string, callback: () => void
stopTrackイベント監視を停止eventName: string, callback: () => void

イベント一覧

イベント名定数説明
リワード付与window.alm.Events.REWARDEDユーザーがリワードを獲得した
広告読み込みエラーwindow.alm.Events.AD_LOADING_FAILED広告の読み込みに失敗した
インプレッションwindow.alm.Events.IMPRESSION広告が表示された
広告が閉じられたwindow.alm.Events.AD_CLOSED広告が閉じられた
広告がユーザーによって閉じられたwindow.alm.Events.AD_USER_CLOSED広告がユーザーによって閉じられた
広告描画開始window.alm.Events.AD_RENDERING_STARTED広告描画を開始した
広告描画完了window.alm.Events.AD_RENDERING_COMPLETED広告描画を完了した
広告描画失敗window.alm.Events.AD_RENDERING_FAILED広告描画に失敗した
広告描画成功window.alm.Events.AD_RENDERING_SUCCEEDED広告描画に成功した
動画広告再生終了window.alm.Events.AD_VIDEO_COMPLETED動画広告の再生が終了した (動画広告) * 現在はインバナー・インページフォーマットのみ