イネーブラーとは、スタジオの中心的なコード ライブラリです。クリエイティブの頭脳と考えることができます。コンポーネントと API 呼び出しはすべて、イネーブラーを介する必要があります。イネーブラー ライブラリは、すべてのリッチメディア クリエイティブに必要です。イネーブラーを追加すると、自動的にクリエイティブで次の条件が整います。
- 標準指標データ(表示時間、インプレッション数、インタラクション時間など)を得るための標準的なトラッキング機能が実装される
- 動画やエキスパンド機能など、複雑な機能に対応できるようになる
イネーブラーを追加する
HTML ファイルの <head> タグに、イネーブラーにリンクするスクリプトタグを追加します。
<script src="https://s0.2mdn.net/ads/studio/Enabler.js"></script>
これにより、グローバル名前空間に「Enabler
」という名のシングルトン オブジェクトができます。このオブジェクトのメソッドを呼び出すには、Enabler.isInitialized()、Enabler.exit()
などを呼び出します。
クリエイティブのサイズを設定する
画像や動画とは異なり、HTML ドキュメントそのものにサイズはありません。広告を適切なサイズで表示するには、広告サイズのメタタグを HTML の head セクションに追加します。
以下のメタタグの例をコピーして、クリエイティブ サイズに合わせて幅と高さを変更します。
300x250 クリエイティブ用の広告サイズのメタタグの例
<meta name="ad.size" content="width=300,height=250">
省略可: エキスパンド フラグを設定する
いくつかのオプションのメソッドを使用して、エキスパンド広告の動作を設定できます。これらのメソッドを使用する必要がある場合は、イネーブラー初期化コードの前に指定します。メソッドは次の 3 つです。
Enabler.setExpandingPixelOffsets(left:number, top:number, opt_expandedWidth:number, opt_expandedHeight:number)
エキスパンド広告のステージ オフセットを設定します。-
Enabler.setIsMultiDirectional(value:Boolean)
広告を複数の方向に展開できるようにします。 -
Enabler.setStartExpanded(startExpanded:Boolean)
広告が読み込まれた時点で展開された状態になり、ユーザーが展開しなくてよいようにします。
これらのメソッドの詳細については、スタジオの HTML5 SDK をご覧ください。
イネーブラーの初期化を待つ
イネーブラーの初期化が完了するまで、広告内のいずれの要素も自動的に実行されることはありません。このため、すべてが正しく読み込まれてイネーブラーのメソッドにアクセスできるようになってからユーザーは広告を操作することになります。
JavaScript で、イネーブラーの isInitialized
メソッドを使用してイネーブラーが初期化されたことを確認します。このメソッドは、true または false を返します。true の場合、関数を呼び出して開始します。この例では、enablerInitHandler()
を呼び出します。false の場合、フォールバックを呼び出して、イネーブラーの INIT
イベントをリッスンします。
// true の場合、関数を開始する。false の場合、INIT をリッスンする。
window.onload = function() {
if (Enabler.isInitialized()) {
enablerInitHandler();
} else {
Enabler.addEventListener(studio.events.StudioEvent.INIT, enablerInitHandler);
}
}
function enablerInitHandler() {
// ポライトロードまたはアニメーションを開始し、
// 画像アセットを読み込んで、イネーブラー メソッドを呼び出すか、
// 他の Studio モジュールを実装する。
}
イネーブラーの初期化が完了したら、アニメーションを開始し、画像アセットを読み込んで、トラッキング メソッドを呼び出すか、他の Studio モジュールを実装します。
イネーブラーを更新する
イネーブラーの新しいバージョンがリリースされると、クリエイティブのイネーブラーのバージョンが古いという警告が Studio の管理画面に表示されます。イネーブラーを最新バージョンにアップグレードするには、クリエイティブのメイン HTML アセットを再度アップロードします。