Rtoaster.js／Rtoaster.Popup.js パラメータ、メソッド一覧

Rtoaster.js 4.6.2　Rtoaster.Popup.js 3.5.1

一覧に掲載するパラメータ、メソッドの仕様は、
現状最新バージョン Rtoaster.js 4.6.2 および Rtoaster.Popup.js 3.5.1 の内容となります。

▼ 目次

Rtoaster.jsパラメータ

Rtoaster.callback

1.概要

　レコメンド実行時のコールバック関数を指定します。（デフォルト：undefined）

2.仕様

《動作》

レコメンドが返されたレコメンド場所毎に以下を引数として呼び出されます。

レコメンドが行われたエレメントID
表示枠数が設定されたレコメンドが返された場合は親エレメントID

以下の場合に、1度だけ引数なしとして呼び出されます。

レコメンド処理が完了
トラッキングがタイムアウト、エラー、オプトアウトの場合
レコメンドの応答、タイムアウト、エラー、指定されたエレメントIDがページに存在しない場合
Rtoaster.hide()が呼び出され、ページのonloadイベントまでにレコメンドコードが実行されなかった場合

《設定値》

コールバック関数

3.記述例

<script type="text/javascript">
  Rtoaster.callback = function(e){

      --ここに任意のJavascriptを記載--

  };
</script>

4.関連記事

レコメンド表示後にJavascriptを実行する

Rtoaster.timeout

1.概要

　Rtoasterのタイムアウト時間（ミリ秒）を指定します。（デフォルト：2000)

2.仕様

《動作》

Rtoaster基本コードに記述することで、タイムアウト時間を調整します。
指定しなかった場合、タイムアウト時間はデフォルトの2000ミリ秒程度となり、
1〜2秒程度でタイムアウトします。
トラッキングのタイムアウトもこの値が使用されます。
コールバック関数が指定されている場合はタイムアウト時に実行されます。

《設定値》

タイムアウト時間（ミリ秒単位）

3.記述例

<script type="text/javascript">
 Rtoaster.timeout = 5000;
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
 Rtoaster.track();
</script>

4.関連記事

レコメンド表示のタイムアウトを設定する

Rtoaster.permit

1.概要

　Rtoasterの初期実行許可状態を設定します。（デフォルト：true）

2.仕様

《動作》

Rtoaster基本コードに記述することでオプトインモードとオプトアウトモードを切り替えます。

オプトアウトモード（デフォルト）
サイト訪問者の同意を得ること無くトラッキング・レコメンドが動作します。
Rtoaster.optout()を実行し、_rt.opt=OというCookieが存在する限り
トラッキング・レコメンドが停止します。
ブラウザのCookieを削除するか、Rtoaster.optin()を実行すると
トラッキング・レコメンドが再開します。
オプトインモード
Rtoaster.optin()を実行し、_rt.opt=IというCookieが発行されるまで
トラッキング・レコメンドは動作しません。
ブラウザのCookieを削除するか、Rtoaster.optout()を実行すると
トラッキング・レコメンドが停止します。

《設定値》

true ：オプトアウトモード
false：オプトインモード

3.記述例

<script type="text/javascript">
 Rtoaster.permit = false;
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
 Rtoaster.track();
</script>

4.関連記事

Rtoaster action+の初期実行許可状態を設定する

Rtoaster.jsメソッド

以下のメソッドはRtoaster.init()を実行前でもご利用いただけます。

Rtoaster.getParameter()

1.概要

　指定したURLのパラメーター値を取得します。

2.仕様

《引数について》

引数	型	説明
パラメータ名（必須）	String	取得したいURLのパラメータ名

《動作》

引数で指定された名称のURLのパラメーター値を取得します。
指定されたパラメーターがURLに存在しない場合は、空文字列が返ります。

3.記述例

<script type="text/javascript">
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
 var refid = Rtoaster.getParameter("refid");
 if (refid) {
 Rtoaster.track({ "refid": refid });
 } else {
 Rtoaster.track();
 }
</script>

Rtoaster.isPermitted()

1.概要

　Rtoasterの動作に関する同意状況を取得します。

2.仕様

《動作》

Rtoasterのトラッキングやレコメンドの実行に同意されている場合はtrue、
同意していない場合はfalseが返ります。

3.記述例

<script type="text/javascript"> if (Rtoaster.isPermitted()) { // オプトアウト用フォームを表示する
    show_optout_form(); } else { // オプトイン用フォームを表示する show_optin_form(); } </script>

4.関連記事

オプトイン／オプトアウトの状態を取得する

Rtoaster.Cookie.get()

1.概要

　指定したCookieに格納されている値を取得します。

2.仕様

《引数について》

引数	型	説明
Cookie名（必須）	String	取得したいCookie名取得時に自動的にURIデコードを行い、値がダブルクォーテーションで囲まれている場合は除去します。

《動作》

引数で指定された名称のCookieに格納されている値を取得します。
指定されたCookieが存在しない場合は、空文字列が返ります。
Cookieが存在してもhttpOnly属性が指定されているCookieは、
Javascriptから参照できないため空文字列が返ります。
同様にsecure属性が指定されている場合はhttpページから参照できません。

3.記述例

<script type="text/javascript">
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX", Rtoaster.Cookie.get("ログインCookie"));
 Rtoaster.track();
</script>

4.関連記事

Rtoaster.init()

1.概要

Rtoasterタグが動作するための初期化を行います。
Rtoaster.jsを読み込んで最初に実行する必要があります。

2.仕様

《引数について》

引数	型	説明
トラッキングID （必須）	String	ご契約プロパティ毎に発行されるトラッキングID（RTA-XXXX-XXXXXXXXXXXX）の値
移行先ユーザーID	String	お客様のWebシステム側で発行しているユーザーID ログイン時の1回のみ指定すれば、_rt.uidがこの値に書き換わるので、毎回指定する必要はありません。
移行元ユーザーID	String	移行元ユーザーID お客様のWebシステム側で発行しているユーザーIDをさらに別のコード体系等に移行したい場合を想定用途としています。

《動作》

Rtoasterの内部状態を初期化します。
このメソッドを実行しないと後述のメソッドは全て動作しません。

3.記述例

基本

<script type="text/javascript">
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
 Rtoaster.track();
</script>

ログイン連携の場合

<script type="text/javascript">
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX", "ユーザーIDのHASH値など");
 Rtoaster.track();
</script>

4.関連記事

以下のメソッドはRtoaster.init()を実行後にご利用いただけます。

Rtoaster.optin()

1.概要

　トラッキングやレコメンドをオプトインします。

2.仕様

《引数について》

引数	型	説明
コールバック関数	Function	オプトイン実行後に呼び出されるコールバック関数

《動作》

オプトイン用のカスタム変数（_rt.of=1）をセットしてトラッキングリクエストを実行します。
オプトインモードの場合は上記Cookieが存在しない場合はトラッキングを実施しません。
上記の通りCookieによる制御であるため、同じユーザーIDでも別のブラウザでオプトインするためには、そのブラウザで再度このメソッドを実行する必要があります。

3.記述例

<button id="optin" onclick="Rtoaster.optin(function(){location.reload()})">Rtoasterによるトラッキングを許可する</button>

4.関連記事

オプトイン

Rtoaster.optout()

1.概要

　トラッキングやレコメンドをオプトアウトします。

2.仕様

《引数について》

引数	型	説明
コールバック関数	Function	オプトアウト実行後に呼び出されるコールバック関数

《動作》

オプトアウト用のカスタム変数（_rt.of=0）をセットしてトラッキングリクエストを実行します。
オプトアウトCookieが存在する場合はトラッキングを実施しません。
上記の通りCookieによる制御であるため、同じユーザーIDでも別のブラウザでオプトアウトされるためには、そのブラウザで再度このメソッドを実行する必要があります。

3.記述例

<button id="optout" onclick="Rtoaster.optout(function(){location.reload()})">Rtoasterによるトラッキングを拒否する</button>

4.注意点

Rtoaster.init()の実行やページのリロードを行わずに、Rtoaster.optout()とRtoaster.optin()を呼び出した場合、以前のユーザーIDが再利用されます。
これはオプトアウト直後にオプトインを実行したことから、オプトアウトのキャンセルとして扱うことによる挙動となります。

5.関連記事

オプトアウト

Rtoaster.Cart.add()

1.概要

　カートページURL正規表現にマッチしないページで、カートへアイテムを個別に追加します。

2.仕様

《引数について》

引数	型	説明
アイテムコード (必須)	String	カートへ追加するアイテムコード複数指定する場合は引数を追加します。

《動作》

引数で指定されたアイテムコードがカートに存在しない場合に追加します。
カートページURL正規表現にマッチした場合は、既存のカート洗い替え処理が行われた後に追加処理が実行されます。
後述の注意点の通り、トラッキングの前後によって挙動が異なります。

3.記述例

指定したアイテムコードをカートへ追加する場合

<button onclick=“Rtoaster.Cart.add('itemCodeA')">カートへ追加</button>

カートページURL正規表現設定を行わずにアイテムコードをカートへ追加する場合

<script type="text/javascript">
  Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
  Rtoaster.Cart.add("itemCode1", "itemCode2", "itemCode3");
  Rtoaster.track();
</script>

4.注意点

カートページURL正規表現にマッチした場合は、既存のカート洗い替え処理が行われた後に追加処理が実行されます。
※意図した挙動にならない可能性があるため併用は非推奨です。
Rtoaster.track()前にカートへの追加と削除が同時に実行された場合は、実行順に関係なく追加処理が行われた後に削除処理が実行されます。
※処理結果は削除が優先されるため、カートのクリア(引数が未指定のRtoaster.Cart.remove())と追加を同時に行うことはできません。
最大の表示枠数を超えて追加した場合は、表示枠数を超えたアイテムは表示されません。
Rtoaster.track()前に実行するとRtoaser.track()とまとめてリクエストされます。
Rtoaster.track()後に実行した場合はイベントトラッキングが非同期で実行されることにご注意ください。（※1）

5.関連記事

残留カート内履歴関連設定

Rtoaster.Cart.remove()

1.概要

カートページURL正規表現にマッチしないページで、カートからアイテムを個別に削除します。

2.仕様

《引数について》

引数	型	説明
アイテムコード	String	カートから削除するアイテムコード複数指定する場合は引数を追加します。未指定の場合はカートをクリアします。

《動作》

引数で指定されたアイテムコードがカートに存在する場合は削除し、引数が未指定の場合はカートをクリアします。
後述の注意点の通り、トラッキングの前後によって挙動が異なります。

3.記述例

指定したアイテムコードをカートから削除する場合

<button onclick=“Rtoaster.Cart.remove('itemCodeA')">カートから削除</button>

カートをクリアする場合

<button onclick="Rtoaster.Cart.remove()">カートを空にする</button>

カートページURL正規表現設定を行わずにカートから削除と追加を行う場合

<script type="text/javascript">
　Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
　Rtoaster.Cart.remove(“itemCodeA”, “itemCodeB");
　Rtoaster.Cart.add(“itemCodeC");
　Rtoaster.track();
</script>

4.注意点

カートページURL正規表現にマッチした場合は、既存のカート洗い替え処理が行われた後に削除処理が実行されます。
※意図した挙動にならない可能性があるため併用は非推奨です。
Rtoaster.track()前にカートへの追加と削除が同時に実行された場合は、実行順に関係なく追加処理が行われた後に削除処理が実行されます。
※処理結果は削除が優先されます。
Rtoaster.track()前に実行するとRtoaser.track()とまとめてリクエストされます。
Rtoaster.track()後に実行した場合はイベントトラッキングが非同期で実行されることにご注意ください。（※1）

5.関連記事

残留カート内履歴関連設定

Rtoaster.History.add()

1.概要

アイテム閲覧学習を行います。
アイテムコード取得正規表現にマッチしない場合でも閲覧学習が行われます。

2.仕様

《引数について》

引数	型	説明
アイテムコード (必須)	String	閲覧学習を行うアイテムコード

《動作》

引数で指定されたアイテムコードの閲覧学習を行い、レコメンドの際のターゲットアイテムコードとしてセットします。
後述の注意点の通り、トラッキングの前後によって挙動が異なります。

3.記述例

アイテムコード取得正規表現設定を行わずに閲覧学習を行う場合

<script type="text/javascript">
　Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
　Rtoaster.History.add("itemCodeA");
　Rtoaster.track();
</script>

4.注意点

アイテムコード取得正規表現にマッチした場合でも、Rtoaster.History.add()による閲覧学習が優先されます。
※アイテムコード取得正規表現の結果は無視されます。
Rtoaster.History.add()とRtoaster.item()の両方が実行されると、レコメンドの際のターゲットアイテムは最後に実行されたアイテムコードが利用されます。
Rtoaster.History.remove()と同時に実行することはできません。
※Rtoaster.History.add()による閲覧学習は無視されます。
Rtoaster.track()前に実行するとRtoaser.track()とまとめてリクエストされます。
Rtoaster.track()後に実行した場合はイベントトラッキングが非同期で実行されることにご注意ください。（※1）

5.関連記事

閲覧学習コード

Rtoaster.History.remove()

1.概要

　アイテム閲覧履歴を削除します。

2.仕様

《引数について》

引数	型	説明
アイテムコード	String	閲覧履歴から削除するアイテムコード未指定の場合は全ての閲覧履歴を削除します。

《動作》

引数で指定されたアイテムコードを閲覧履歴から削除し、
引数が未指定の場合は全ての閲覧履歴を削除します。
後述の注意点の通り、トラッキングの前後によって挙動が異なります。

3.記述例

<script type="text/javascript" src="//js.rtoaster.jp/Rtoaster.js"></script>
<script type="text/javascript">
 Rtoaster.History.remove("itemCode");
</script>

4.注意点

Rtoaster.track()前に実行するとRtoaser.track()とまとめてリクエストされます。
Rtoaster.track()後に実行した場合はイベントトラッキングが非同期で実行されることにご注意ください。（※1）

5.関連記事

ユーザーの閲覧履歴を削除する

Rtoaster.track()

1.概要

　トラッキングを実行します。

2.仕様

《引数について》

これらの引数を同時に使用するとき、順番は問われません。
どちらを先に指定しても問題なく動作します。

引数	型	説明
カスタム変数（旧：アプリキー）	Object	スコアルールの条件にて利用できるカスタム変数をJSのオブジェクトで指定します。マルチバイト文字の利用は非推奨です。
疑似URLパス	String	指定することで、指定されたパスにユーザーがアクセスしたとRtoasterが認識します。 SPAなどで利用することを想定しています。
コールバック関数	Function	トラッキングリクエスト実行後に呼び出されるコールバック関数トラッキングがエラーとなった場合も実行されます。

3.記述例

通常のトラッキング

<script type="text/javascript">
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
 Rtoaster.track();
</script>

カスタム変数を指定

<script type="text/javascript">
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
 Rtoaster.track({ a: 1, b: "foo" });
</script>

疑似パスとコールバック関数

<script type="text/javascript">
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
 Rtoaster.track("/dummy/path.html", function() {location.href = "http://www.rtoaster.com/seminars/";});
</script>

4.注意点

Rtoaster.init()でトラッキングIDをセットせずにRtoaster.track()を実行すると、"not initilized"というエラーが発生します。
Rtoaster.track()を呼び出した時点では、トラッキングリクエストが発行・処理されているとは限りません。（※1）
カスタム変数（旧：アプリキー）の最大長は、ブラウザの最大URL長の制限に依存します。
※パフォーマンスに影響があるため、最大1KB/リクエスト程度までを推奨します。

5.関連記事

Rtoaster.event()

1.概要

　PVを加算しないイベントトラッキングを実行します。

2.仕様

《引数について》

これらの引数を同時に使用するとき、引数を記載する順不同です。
どちらを先に指定しても問題なく動作します。

引数	型	説明
カスタム変数（旧：アプリキー）	Object	スコアルールの条件にて利用できるカスタム変数をJSのオブジェクトで指定します。マルチバイト文字の利用は非推奨です。
疑似URLパス	String	指定することで、指定されたパスにユーザーがアクセスしたとRtoasterが認識します。 SPA名等で利用することを想定しています。
コールバック関数	Function	トラッキングリクエスト実行後に呼び出されるコールバック関数トラッキングがエラーとなった場合も実行されます。

3.記述例

基本のイベントトラッキング

<script type="text/javascript">
 Rtoaster.event();
</script>

カスタム変数を指定

<script type="text/javascript">
 Rtoaster.event({ "linkId": 1, "downloadName": "foo.pdf" });
</script>

疑似パスとコールバック関数

<script type="text/javascript">
 Rtoaster.event("/dummy/path.html", function() { tabSelect(1); });
</script>

4.注意点

イベントトラッキングの場合はリファラは通知されません。
そのため、スコアルールでリファラ条件は利用できません。
ページ内で一度もRtoaster.track()を実行せずにRtoaster.event()を実行すると"not tracked"というエラーが発生します。
一度でもRtoaster.track()が実行されていれば、2度目のRtoaster.init()後にRtoaster.track()を実行せずにRtoaster.event()が実行可能です。
Rtoaster.event()を呼び出した時点では、イベントトラッキングのリクエストが発行・処理されているとは限りません。（※1）
カスタム変数（アプリキー)の最大長はブラウザの最大URL長の制限に依存しますが、
パフォーマンスの劣化等を回避するため、推奨は1KB/リクエスト程度までとなります。
- 一部の記号や全角文字を利用すると、UTF-8でパーセントコーディングされる影響で1文字あたり3bytesから15bytesとなります。
現状Rtoaster APIではイベントトラッキングをご利用いただくことはできません。

Rtoaster.hide()

1.概要

　デフォルトコンテンツをレコメンドが実行されるまで非表示にします。

2.仕様

《引数について》

引数	型	説明
エレメントID	String	引数なしの場合はタグの挿入位置の親エレメントを非表示にします。（非推奨）動的に生成されるエレメントでは利用できないので、その場合は引数にエレメントIDを渡します。引数のエレメントIDは複数指定可能です。

《動作》

Rtoasterが動作するまでデフォルトコンテンツが表示されないよう一時的に非表示にします。
レコメンドの書き換えが行われなかった場合にはwindow.onloadイベント後からRtoaster.timeout時間後に再表示し、再表示後はRtoaster.recommend()やRtoaster.recommendNow()が実行されても無視されます。

3.記述例

引数なし

<div id="element_id">
 <script type="text/javascript">Rtoaster.hide()</script>
 デフォルトコンテンツ
</div>

エレメントIDを指定

<div id="element_id">
 デフォルトコンテンツ
</div>
<script type="text/javascript">Rtoaster.hide("element_id")</script>

4.注意点

引数なしのRtoaster.hide()は内部でdocument.write()を利用しており、
レコメンド場所直下に静的に埋め込む場合のみ利用可能です。
ページの読み込みが完了した後に引数なしのRtoaster.hide()が動作した場合、
ページが表示されなくなる可能性があります。
引数なしのRtoaster.hide()はページのレンダリングや並列処理に影響があるため、
パフォーマンスの観点から利用は非推奨となっております。
動的に生成されるエレメントや非同期に処理を行う場合は、
引数ありのRtoaster.hide("element_id")を利用する必要があります。

5.関連記事

レコメンド表示前に通常のHTMLコンテンツを表示させない

Rtoaster.item()

1.概要

アイテムの閲覧・購買情報学習や、カート内アイテムを確認するページ等における
複数アイテム閲覧時のアイテム軸自動レコメンドで、閲覧中のアイテムを指定する際に使用します。

2.仕様

《引数について》

「閲覧中のアイテムコード」または「閲覧中のアイテム情報を格納したJSON」のいずれか1つを指定してください。
両方を指定することはできません。

引数	型	説明
引数（必須）	String	アイテム閲覧学習時閲覧中のアイテムコード
引数（必須）	Object	購買情報学習時・複数アイテム指定アイテム軸自動レコメンド閲覧中のアイテム情報を格納したJSON

《動作》

アイテム閲覧学習時
- 引数で渡されたアイテムコードをRtoaster.track()実行時にカスタム変数「item_code」の値としてRtoasterに送信します。
- 同ページ内で2回目以降に実行したRtoaster.track()では送信されません。
購買情報学習時・複数アイテム指定アイテム軸自動レコメンド
- 引数で渡されたJSON情報をカスタム変数としてRtoasterに送信します。

3.記述例

アイテム閲覧学習

<script type="text/javascript" src="//rt.rtoaster.jp/Rtoaster.js"></script>
<script type="text/javascript">
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
 Rtoaster.item("itemCode");
 Rtoaster.track();
</script>

(中略)

<script type="text/javascript">
 Rtoaster.recommendNow("element_id",…);
</script>

※レコメンドを実行しない場合、レコメンドコードは不要です。
※Rtoaster.recommendNow()の直前でRtoaster.item()を実行する必要はありません。

複数アイテム指定アイテム自動レコメンド

<script type="text/javascript">
 Rtoaster.item({
 "item1_code" : "itemCode 1",
 ・
 ・
 ・
 "itemn_code" : "itemCode n" 
 });
 Rtoaster.recommendNow("element_id",…);
</script>

購買完了ページ等で購買学習とレコメンドを同時に行う場合

<script type="text/javascript">
 var appKey = {
  "subtotal" : "小計",
  "item1_code" : "itemCode 1",
　"item1_price" : "アイテム1の単価",
　"item1_qty" : "アイテム1の個数",
　 ・
　 ・
　 ・
　"itemn_code" : "itemCode n",
　"itemn_price" : "アイテムnの単価",
　"itemn_qty" : "アイテムnの個数" 
 };
</script>

(中略)

<script type="text/javascript" src="//rt.rtoaster.jp/Rtoaster.js"></script>
<script type="text/javascript">
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
 Rtoaster.track(appKey);
</script>

(中略)

<script type="text/javascript">
 Rtoaster.item(appKey);
 Rtoaster.recommendNow("element_id",…);
</script>

4.注意点

アイテム閲覧学習に利用する場合はRtoaster.track()より前に記述する必要があります。
複数のアイテムコードを閲覧学習することはできません。

5.関連記事

Rtoaster.category()

1.概要

　以下のレコメンド方法のカテゴリフィルタに使用するカテゴリを指定します。

ユーザー軸自動レコメンド（閲覧・購買）
閲覧履歴に基づくリアルタイムレコメンド（閲覧・購買）
ランキング（閲覧・購買）
残留カート内履歴に基づく自動レコメンド（閲覧・購買）

2.仕様

《引数について》

引数	型	説明
1階層目のカテゴリ（必須）	String	フィルタリングに使用する1階層目のカテゴリ
2階層目のカテゴリ	String	フィルタリングに使用する2階層目のカテゴリ
3階層目のカテゴリ	String	フィルタリングに使用する3階層目のカテゴリ
4階層目のカテゴリ	String	フィルタリングに使用する4階層目のカテゴリ
5階層目のカテゴリ	String	フィルタリングに使用する5階層目のカテゴリ

《動作》

各引数には1階層目から順にカテゴリの値を指定しますが、低階層のカテゴリを指定しない場合や存在しない場合は、そのカテゴリを省略することが可能です。
カテゴリを指定しない階層がある場合、その階層に引数には空文字（""）を指定します。

3.記述例

第1階層目のカテゴリのみ指定する場合（2～5階層目のカテゴリを省略）

<script type="text/javascript">
 Rtoaster.category("category1");
 Rtoaster.recommendNow("element_id",…);
</script>

カテゴリを3階層目のみ指定する場合

<script type="text/javascript">
 Rtoaster.category("", "", "category3");
 Rtoaster.recommendNow("element_id",…);
</script>

4.注意点

URLからカテゴリが取得できるページで使用された場合、本メソッドで指定されたカテゴリが優先して使用されます。
（本メソッドを使用した場合、URLから取得可能なカテゴリは一切無視されます）

5.関連記事

カテゴリ取得コード

Rtoaster.omit()

1.概要

アイテム軸自動レコメンド、アイテム軸外部リストレコメンド、ユーザー軸自動レコメンド、
ユーザー軸外部リストレコメンドの結果から除外するアイテムコードを指定します。

2.仕様

《引数について》

引数	型	説明
アイテムコード（必須）	String	除外するアイテムコード複数指定する場合は引数を追加してください。

《動作》

アイテム軸自動レコメンド、アイテム軸外部リストレコメンド、
ユーザー軸自動レコメンド、ユーザー軸外部リストレコメンドの結果から、
指定したアイテムコードを除外します。
その他の自動レコメンドの結果、ルール用リストには適用されません。

3.記述例

アイテムA,B,Cをレコメンドの結果から除外する場合

<script type="text/javascript">
  Rtoaster.omit("アイテムA", "アイテムB", "アイテムC");
  Rtoaster.recommendNow("element_id",…);
</script>

Rtoaster.price()

1.概要

　アイテム/ユーザー軸自動レコメンドの価格フィルタに使用する値を指定します。

2.仕様

《引数について》

引数	型	説明
価格フィルタの下限値（必須）	Number	下限値を設定しない場合、0が指定されます。
価格フィルタの上限値	Number	上限値を設定しない場合、省略可能です。

《動作》

引数に価格の下限値と上限値を指定すると、その価格帯のアイテムのみが自動レコメンドの結果として表示されます。
フィルタリングする価格により、自動レコメンドの結果が表示されなくなる可能性があります。

3.記述例

価格が500～1000の商品を自動レコメンドの結果として表示する場合

<script type="text/javascript">
 Rtoaster.price(500, 1000);
 Rtoaster.recommendNow("element_id",…);
</script>

価格が1000以下の商品を自動レコメンドの結果として表示する場合

<script type="text/javascript">
 Rtoaster.price(0, 1000);
 Rtoaster.recommendNow("element_id",…);
</script>

価格が500以上の商品を自動レコメンドの結果として表示する場合

<script type="text/javascript">
 Rtoaster.price(500);
 Rtoaster.recommendNow("element_id",…);
</script>

4.関連記事

価格フィルタ

Rtoaster.target()

1.概要

アイテム軸/アイテム軸外部リストレコメンドのターゲットアイテムコードをレコメンド場所毎に指定します。

2.仕様

《引数について》

引数	型	説明
レコメンド場所毎のターゲットアイテムコード（必須）	Object	対象のエレメントIDを名前、アイテムコードを値としてObject型(JSON)で指定します。 1つのエレメントIDに対して複数のアイテムコードは指定できません。また、同じエレメントIDを重複して指定することはできません。レコメンド場所がアイテム軸自動レコメンド、アイテム軸外部リストレコメンド以外の場合は、指定した内容は無視されます。

《動作》

アイテム軸自動レコメンド/アイテム軸外部リストレコメンドで、エレメントID毎にターゲットアイテムを指定します。
このメソッドでターゲットアイテムが指定されていないレコメンド場所はアイテムコード取得正規表現で取得、または、Rtoaster.item()で指定されたアイテムコードをターゲットアイテムとして使用します。
アイテムマスタに存在しないアイテムコードが指定された場合はターゲットアイテムが未指定として処理されます。

3.記述例

レコメンド場所毎にターゲットアイテムを指定する

<script type="text/javascript">
  Rtoaster.target({ "element_id1": "itemCodeA", "element_id2": "itemCodeB" });
  Rtoaster.recommendNow("element_id1","element_id2");
</script>

1.概要

レコメンドをDOMContentLoaded、または、onloadイベント発生まで待ってから実行します。
（イベント発生後の場合は即時実行）
基本コード内に記述することが可能ですが、他のトラッキングコードなどより後に実行されるため、
レコメンド表示のタイムラグが大きくなります。
タグマネージャー経由でRtoasterを利用するなど、レコメンド対象のエレメントIDよりも先に
レコメンドコードが実行される可能性がある場合は、本メソッドの使用を推奨します。

2.仕様

《引数について》

引数	型	説明
エレメントID (親エレメントID) （必須）	String	複数指定する場合は引数を追加してください。

3.記述例

基本コード内に記述可能。

<script type="text/javascript">
 Rtoaster.init("RTA-XXXX-XXXXXXXXXXXX");
 Rtoaster.track();
 Rtoaster.recommend("element_id",…);
</script>

4.注意点

DOMContentLoaded、または、onloadイベント発生時に登録順で処理が行われるため、同イベントに対してRtoasterより先に処理が登録されている場合はレコメンドの実行がより大きく遅延する可能性があります。
Rtoaster.recommendNow()とは異なり、レコメンド対象のエレメントIDが存在するかはDOMの読み込み完了後に行われるため、head内などページ上部で実行しても問題ありません。

Rtoaster.recommendNow()

1.概要

ページの読み込み完了を待たずレコメンドを即時実行します。
全てのレコメンド場所の最後に記述する必要がありますが、ファーストビューでレコメンドを
表示するなど、表示遅延を極力減らしたい場合は本メソッドの使用を推奨します。

2.仕様

《引数について》

引数	型	説明
エレメントID (親エレメントID) （必須）	String	複数指定する場合は引数を追加してください。

3.記述例

全てのレコメンド場所の後に記述する。

<div id="element_id1">
 デフォルト表示
</div>
<ol id="element_id2">
 <li id="element_id2_1"/>
 <li id="element_id2_2"/>
 <li id="element_id2_3"/>
 <li id="element_id2_4"/>
 <li id="element_id2_5"/>
</ol>
<script type="text/javascript">
 Rtoaster.recommendNow("element_id1", "element_id2");
</script>

4.注意点

Rtoaster.recommendNow()を呼び出した時点では、レコメンドリクエストが発行・処理されているとは限りません。（※1）
Rtoaster.recommendNow()を呼び出した時点で対象のエレメントIDが付与されたDOMが存在していなければ、レコメンドが実行されません。
レコメンドコードがレコメンド対象のエレメント内部に存在する場合は正常に動作しない可能性があるため、レコメンド対象のエレメントの後に記述する必要があります。

5.関連記事

Rtoasterレコメンドコード

Rtoaster.click()

1.概要

指定したエレメントID（サブエレメントID）のコンテンツがクリックされたものとして
Rtoasterに認識させます。
カルーセルなどでレコメンドを書き込んだエレメントとは異なるエレメントに表示される場合の
クリック計測には本メソッドを使用します。

2.仕様

《引数について》

引数	型	説明
エレメントID （サブエレメントID）（必須）	String	レコメンド場所が複数枠の場合はサブエレメントIDを渡します。

《動作》

指定したエレメントID（サブエレメントID）がクリックされた場合に作成するレコメンドセッションIDのCookie（_rt.sid）を作成します。
通常はレコメンドコンテンツのクリックイベントハンドラでレコメンドセッションIDのCookie（_rt.sid）を作成しますが、例えばカルーセル表示のライブラリ等で画面表示されるものとレコメンドのエレメントが異なるといった理由によりクリックイベントを検出できない場合に、本メソッドを使用します。

3.記述例

エレメントID TopMain をクリックしたと認識させたい場合

<div onClick="Rtoaster.click('TopMain')">
 ここをクリックした（次に基本コードが読まれた）とき TopMain がクリックされたと判定される
</div>

Rtoaster.listen()

1.概要

レコメンド（Rtoaster.recommend()、Rtoaster.recommendNow()）の結果取得時の、
コールバック関数を設定します。
同じエレメントIDで複数回セットした場合は、設定順に全てのコールバック関数が呼び出されます。

2.仕様

《引数について》

引数	型	説明
エレメントID （必須）	String	レコメンド場所のエレメントID
コールバック関数（必須）	Function	レコメンド場所書き換え後に実行するコールバック関数

3.記述例

<script type="text/javascript">
  Rtoaster.listen(element_id, function(e) {

  // element_idで指定されたレコメンド場所のHTMLがレコメンドにより書き換えられた際に
  // 呼び出される任意のJavaScriptを記載してください

  });
</script>

4.関連記事

レコメンド表示後に複数回Javascriptを実行する

Rtoaster.Popup.jsパラメータ

Rtoaster.Popup.closeIconSrc

1.概要

　閉じるボタンの画像URLを指定します。

2.仕様

《動作》

閉じるボタンとして表示される画像を変更します。
空文字を指定した場合は閉じるボタンが非表示となります。
閉じるボタンのみクリックした場合、クリック計測は行いません。

《設定値》

画像URLかデータ、または、非表示にしたい場合は空文字

3.記述例

異なる画像に差し替える場合

<script type="text/javascript">
 Rtoaster.Popup.closeIconSrc = "/img/btn_close.png";
</script>

非表示の場合

<script type="text/javascript">
 Rtoaster.Popup.closeIconSrc = "";
</script>

4.関連記事

Rtoaster.Popup.jsメソッド

Rtoaster.Popup.register()

1.概要

　ポップアップのレコメンド場所を登録します。

2.仕様

《引数について》

引数	型	説明
エレメントID （必須）	String	ポップアップのレコメンド場所となるエレメントID

3.記述例

<script type="text/javascript">
 Rtoaster.Popup.register("element_id");
 Rtoaster.recommendNow("element_id");
</script>

4.注意点

対象のエレメントIDが付与されたDOMは必要ありません。
Rtoaster.Popup.register()のメソッドの中には、1つ分のエレメントIDしか登録できませんのでご注意ください。
基本コードを挿入せずにレコメンドコードのみを挿入した場合、JavaScriptエラーが発生しますのでご注意ください。

5.関連記事

Rtoaster.Popup.close()

1.概要

指定したエレメントIDのポップアップを閉じます。
ポップアップのレコメンドコンテンツ内で利用することを想定用途とします。

2.仕様

《引数について》

引数	型	説明
エレメメントID （必須）	String	閉じたいポップアップのエレメントID
クリック計測無効化フラグ	Boolean	true クリック計測を無効化します。ポップアップ内で何らかのクリックを行い、トラッキングが行われずにこのメソッドが実行された場合は計測が行われませんので、ご注意ください。 false（デフォルト）クリック計測を行います。パラメータが未指定の場合はデフォルトでクリック計測が行われます。

3.記述例

<input type="button" value="閉じる" onclick="Rtoaster.Popup.close('element_id',true)">

4.関連記事

注意事項

※1 非同期処理の注意点

Rtoaster.track()、Rtoaster.recommend()、Rtoaster.recommendNow()、Rtoaster.track()後のRtoaster.Cart.add()、Rtoaster.Cart.remove()、Rtoaster.History.add()、Rtoaster.History.remove()は、リクエストの呼び出しを準備しますが、メソッドの呼び出し後にリクエストが呼ばれている・レスポンスが返っているとは限りません。

これらのメソッドの後に、ページの移動・リロードを呼び出す時などはご注意ください。

記述例

<script type="text/javascript">
 Rtoaster.track();
 location.href = "<Redirect URL>";
</script>

location.hrefによるリダイレクトの時点ではRtoaster.track()のサーバーリクエストは実行されていない可能性があります。
リクエスト完了を待ってから実行したい場合は、Rtoaster.track()のコールバック機能を利用してください。

記述例

<script type="text/javascript">
 Rtoaster.track(function() { location.href = "<Redirect URL>" });
</script>

Rtoaster.recommend()やRtoaster.recommendNow()はRtoaster.callbackやRtoaster.listen()を利用することでコールバックが行えますが、Rtoaster.Cart.add()、Rtoaster.Cart.remove()、Rtoaster.History.add()、Rtoaster.History.remove()についてはコールバックは行えません。

※2 レコメンドコンテンツ内のスクリプトに関する注意点

Rtoasterレコメンドコンテンツ内のスクリプト実装は、通常サポート対象外となります。

《制限事項》

srcで指定された外部ファイルの読み込みは同一ドメインに限定されます。
- 異なるドメインの外部ファイルを読み込もうとした場合はエラーとなります（開発ツールのコンソールに出力される）。
- Access-Control-Allow-Originヘッダにより制御できる可能性がありますが、動作保証対象外となります。
- jQueryなどの外部ライブラリは、レコメンドコンテンツ内ではなく元のHTMLで事前に読み込む必要があります。
レコメンドコンテンツ内のスクリプトが実行されるのはレコメンド場所を書き換える前のため、レコメンドコンテンツ内のDOMは操作できません。
- レコメンドコンテンツ内のid属性を指定しても取得できません。
- レコメンドコンテンツ内のDOM操作を行いたい場合はRtoaster.listen()やRtoaster.callbackの仕組みで行うことを検討してください。

■ Rtoaster.jsパラメータ一覧

■ Rtoaster.jsメソッド一覧

■ Rtoaster.Popup.jsパラメータ一覧

■ Rtoaster.Popup.jsメソッド一覧

■ 注意事項

Rtoaster.jsパラメータ

Rtoaster.callback

Rtoaster.timeout

Rtoaster.permit

Rtoaster.jsメソッド

Rtoaster.getParameter()

Rtoaster.isPermitted()

Rtoaster.Cookie.get()

Rtoaster.init()

Rtoaster.optin()

Rtoaster.optout()

Rtoaster.Cart.add()

Rtoaster.Cart.remove()

Rtoaster.History.add()

Rtoaster.History.remove()

Rtoaster.track()

Rtoaster.event()

Rtoaster.hide()

Rtoaster.item()

Rtoaster.category()

Rtoaster.omit()

Rtoaster.price()

Rtoaster.target()

Rtoaster.recommend()

Rtoaster.recommendNow()

Rtoaster.click()

Rtoaster.listen()

Rtoaster.Popup.jsパラメータ

Rtoaster.Popup.closeIconSrc

Rtoaster.Popup.jsメソッド

Rtoaster.Popup.register()

Rtoaster.Popup.close()

注意事項

※1 非同期処理の注意点

※2 レコメンドコンテンツ内のスクリプトに関する注意点