Slideshowad NPM

cb-slideshowad-js

複数のバナー広告を組み合わせて「スライドショー動画広告」を実装するためのjQueryプラグイン。

About

複数のバナー広告を組み合わせることによって、動画のように見せるスライドショー動画広告を手軽に実装できます。広告をリッチに見せることができ、広告のクリック率を向上させることができます。また静止画像では実現できなかった広告にストーリーを持たせるということが可能となり広告の訴求力を高めます。

「フェイドインフェイドアウト」、「フリップ（縦 / 横）」、「スライド（前 / 後 / 左 / 右）」の3種類のスライドショータイプに対応しています（デフォルトはフェイドインフェイドアウトタイプ）。

主にアフィリエイトサービスの広告を使用することを想定しているので、アフィリエイトサービスからそのまま広告をコピーして実装できるようになっています。

Demo

https://maechabin.github.io/cb-slideshowad-js/

Download

こちらのページからダウンロードするか、[git clone]コマンドでローカルにコピーします。

$ git clone git@github.com:maechabin/cb-slideshowad-js.git 任意のディレクトリ名

npm経由でも入手可能です。

$ npm install --save slideshowad

機能の実装に使用するファイルは以下のjsファイルとなります。

./dist/jquery.slideshowad.js

Usage

1. jQueryと当プラグインの読み込み

jQuery本体とdistディレクトリ内の「jquery.slideshowad.js」をページに読み込みます。

<script src="https://code.jquery.com/jquery-1.12.0.min.js"></script>
<script src="./dist/jquery.slideshowad.js"></script>

2. スライドショー動画広告を表示させる要素を準備

htmlファイル内にスライドショー動画広告を表示させる要素を作成し、任意のclass名またはid名を付けます。

<div class="slideshowad-images">

</div>

作成した要素に対して、以下のスタイルを指定します。（ページ表示時に、設定した広告の画像が表示されるのを防ぐためです。）

.slideshowad-images {
  display: none;
}

3. スライドショーさせる広告を設定

上記で作成した要素内にスライドショーさせる広告タグ（リンク, 画像, インプレッション計測用画像）を順に貼り付けます。貼り付けた順番にスライドショーが実行されます。貼り付ける広告の数に制限はありません。（貼り付ける広告の画像はできるだけ同じサイズのものとすることを推奨します）

<div class="slideshowad-images">
  <!-- 1つ目の広告 -->
  <a href="http://example.com/">
    <img src="http://exapmle.com/example1.png" width="300" height="200">
  </a>
  <img src="http://example.com/img1.gif" width="1" height="1">
  <!-- 2つ目の広告 -->
  <a href="http://example.com/">
    <img src="http://exapmle.com/example2.png" width="300" height="200">
  </a>
  <img src="http://example.com/img2.gif" width="1" height="1">
  <!-- 3つ目の広告 -->
  <a href="http://example.com/">
    <img src="http://exapmle.com/example3.png" width="300" height="200">
  </a>
  <img src="http://example.com/img3.gif" width="1" height="1">
</div>

設定する広告タグは以下の形式（img要素を持ったa要素）となります。a要素には必ずhref属性、img要素にはwidth属性、height属性を設定するようにしてください（width属性、height属性がないと画像の表示サイズに不具合が生じる場合があります）。インプレッションを計測するためのimg要素はあってもなくても問題ありません。（多くのアフィリエイトサービスの広告タグは以下の形式となっていることが多いです）

<!-- スライドショーの対象となる広告タグの形式 -->

<!-- 広告の飛び先URL（href属性必須） -->
<a href="http://example.com/">
    <!-- 広告の画像（width属性/height属性必須） -->
  <img src="http://exapmle.com/example.png" width="300" height="200">
</a>
<!-- インプレッション計測用のimg要素（任意） -->
<img src="http://example.com/img.gif" width="1" height="1">

4. プラグインを実行

ステップ2で作成した要素に対して、.slideShowAd()メソッドを実行します。

$('.slideshowad-images').slideShowAd();

Option

slideShowType {String} スライドショー動画広告のスライドショーのタイプを以下より指定します。デフォルト値は、fade。

'fade': フェイドインフェイドアウト
'flipY': Y軸を軸に横方向へのフリップ
'flipX': X軸を軸とする縦方向のフリップ
'slideLeft': 左から右へのスライド
'slideRight': 右から左へのスライド
'slideTop': 上から下へのスライド
'slideBottom': 下から上へのスライド
'none': エフェクトなしのスライドショー

width {String} スライドショー動画広告を表示させる要素の「幅」を指定します。CSSでwidthに指定できる値で指定します。デフォルト値は、1つ目の広告として貼り付けた画像のサイズの幅となります。

height {String} スライドショー動画広告を表示させる要素の「高さ」を指定します。CSSでheightに指定できる値で指定します。デフォルト値は、1つ目の広告として貼り付けた画像のサイズの高さとなります。

interval {Number} スライドショーの間隔を指定します。数値（単位はミリ秒)で指定します。デフォルト値は5000（5秒）。

targetBlank {Boolean} リンク先を別ウィンドウで表示するかしないか指定します。trueにするとリンク先を別ウィンドウで表示します。デフォルト値はfalse。

オプションの指定方法は以下の通りです。slideShowAd()メソッドの引数にオブジェクトリテラル形式でオプションを指定します。

// 幅300px、高さ250px、スライドショーの間隔を8秒に設定
$('.slideshowad-images').slideShowAd({
  'width': '300px',
  'height': '250px',
  'interval': '8000'
});

// スライドショータイプを横方向のフリップタイプ、リンク先を別ウィンドウで表示させる設定
$('.slideshowad-images').slideShowAd({
  'slideShowType': 'flipY',
  'targetBlank': true
});