Kameleoon.API.Personalizations - Kameleoon Documentation

このモジュールは、ライブなパーソナライゼーションにアクセスするメソッドを提供します。

disable

disable() メソッドは、パーソナライゼーションを無効としてマークします。ポップインのようなインタラクティブな要素に対して使用します。ユーザーが要素を閉じたときに disable() を呼び出して、パーソナライゼーションのステータスを更新します。Kameleoon は、ネイティブの非カスタムインターフェース要素に対してこの呼び出しを自動的に実装します。

let personalizationID = 12345;
Kameleoon.API.Personalizations.disable(personalizationID);

引数

名前	型	説明
id	Number	パーソナライゼーションの ID。このフィールドは必須です。

getActive

getActive() メソッドは、現在の訪問とページに対するアクティブなパーソナライゼーションを返します。パーソナライゼーションは、そのバリエーションコードが実行され、関連付けられたアクションが引き続き表示されている場合にアクティブとなります。他の URL でトリガーされたパーソナライゼーション、またはポップインのような現在閉じられているものを取得するには、getTriggeredInVisit() を使用してください。

if (Kameleoon.API.Personalizations.getActive().length == 0) {
  Kameleoon.API.Events.trigger("No Personalizations Events");
}

戻り値

名前	型	説明
personalizations	Array	Personalization オブジェクトのリスト。

getAll

getAll() メソッドは、すべてのライブなパーソナライゼーション (実行中、ドラフト/一時停止/停止ではないもの) を返します。

Kameleoon.API.Personalizations.getAll().forEach(function (personalization) {
  if (personalization.id == 123456 && personalization.active) {
    console.log(personalization.name);
  }
});

戻り値

名前	型	説明
personalizations	Array	Personalization オブジェクトのリスト。

getById

getById() メソッドは、指定された ID のパーソナライゼーションを返します。

var personalization = Kameleoon.API.Personalizations.getById(123456);

if (personalization && personalization.active) {
  console.log(personalization.name);
}

引数

名前	型	説明
id	Number	パーソナライゼーションの ID。このフィールドは必須です。

戻り値

名前	型	説明
personalization	Object	Personalization オブジェクト。

getByName

getByName() メソッドは、指定された名前のパーソナライゼーションを返します。

var personalization = Kameleoon.API.Personalizations.getByName("MyPersonalizationName");

if (personalization && personalization.active) {
  console.log(personalization.id);
}

引数

名前	型	説明
name	String	パーソナライゼーションの名前。このフィールドは必須です。

戻り値

名前	型	説明
personalization	Object	Personalization オブジェクト。

getTriggeredInVisit

getTriggeredInVisit() メソッドは、現在の訪問中にトリガーされたすべてのパーソナライゼーションを返します。

Kameleoon.API.Personalizations.getTriggeredInVisit().forEach(function (personalization) {
  if (personalization.id == 123456) {
    console.log(personalization.name);
  }
});

戻り値

名前	型	説明
personalizations	Array	Personalization オブジェクトのリスト。

getActivatedInVisit

getActivatedInVisit() メソッドは、現在の訪問中に有効化されたすべてのパーソナライゼーションを返します。

Kameleoon.API.Personalizations.getActivatedInVisit().forEach(function (personalization) {
  if (personalization.id == 123456) {
    console.log(personalization.name);
  }
});

戻り値

名前	型	説明
personalizations	Array	Personalization オブジェクトのリスト。

trigger

trigger() メソッドは、ターゲティングセグメントの条件を回避してパーソナライゼーションを強制的にトリガーします。このアクションはパーソナライゼーションを開始しますが、有効化しない可能性があります。

let personalizationID = 123456;
Kameleoon.API.Personalizations.trigger(personalizationID, true);

引数

名前	型	説明
personalizationID	Number	パーソナライゼーションの ID。このフィールドは必須です。
trackingOnly	Boolean	外部パーソナライゼーション (ターゲティングまたはトラッキングを Kameleoon が管理する) では、バリエーションアセット (JS、CSS、リダイレクト) を実行せずにトラッキングアクションのみを実行するために true に設定します。省略された場合、このメソッドはデフォルトで false になります。

API

​disable

​getActive

​getAll

​getById

​getByName

​getTriggeredInVisit

​getActivatedInVisit

​trigger

disable

getActive

getAll

getById

getByName

getTriggeredInVisit

getActivatedInVisit

trigger