フォローする

JavaScript APIでデザイン案の情報を取得する

このページについて

JavaScript APIを利用することで、エクスペリエンスの情報や
採択されたデザイン案の情報を呼び出すことができます。

  • 独自のトラッキングシステムにログを送信する際に、Kaizen Platformのデータを送信したい
  • 公式では用意されていないツール(ヒートマップツール)と連携したい

といった内容に対応することができます。

JavaScript API で採択されたデザイン案情報を取得する

サンプルコード : JavaScriptコードより後にscriptを実行する場合

<!-- Kaizen Platform JavaScript code -->
<script data-kz-key="XXXXXXXXXXXXXXXX"
  data-kz-namespace="kzs"
  src="//cdn.kaizenplatform.net/s/XX/XXXXXXXXXXXXXX.js"></script>
<!-- customized scripts -->
<script>
kzs("getVariation", function(data, state) {
  if (state == "decided") {
    sendToAnalytics({ experimentId: data.experimentId, variationId: data.variationId });
  }
});
</script>

サンプルコード : JavaScriptコードより先にscriptを実行する場合

<!-- customized scripts -->
<script>
// need this line only when calling site-js API before site-js script tag
var kzs = window.kzs || function() { var _ = window.kzs; return (_.q || (_.q = [])).push(arguments); };
 kzs("getVariation", function(data, state) {
   if (state == "decided") {
     sendToAnalytics({ experimentId: data.experimentId, variationId: data.variationId });
   }
 });
</script>
<!-- Kaizen Platform JavaScript code -->
<script data-kz-key="XXXXXXXXXXXXXXXX" data-kz-namespace="kzs" src="//cdn.kaizenplatform.net/s/XX/XXXXXXXXXXXXXX.js" ></script>

コールバック情報

kzs("getVariation", function(data, state){}); で取得できる投稿案情報は、以下です。

state

  • unmatched : どのエクスペリエンスにもマッチしなかった状態
  • matched : エクスペリエンスにマッチのみしている状態
  • decided : エクスペリエンスもデザイン案も確定した状態

data

名前要約
experimentId エクスペリエンス ID '100102'
experimentType タイプ 'singlePageTest': UIエディター
'redirectTest': スプリット URL
roundId ラウンド ID '120'
roundType ラウンド種類 'initial': 準備中
'interim': 中間ラウンド中
'competition': 競争ラウンド中
roundStateId ラウンド状態 ID '135'
roundStateType ラウンド状態名 'active': 実施中
'paused': 一時停止中
variationId 投稿案 ID '100150'
gaSlot Google アナリティクス カスタム変数のキー番号 1
gaCTrack Google アナリティクス カスタムトラッカー名 t2
scVars Adobe Analytics 変数名 eVar72, prop44
uaCDim Google ユニバーサル アナリティクス カスタムディメンションのインデックス 1
uaCTrack Google ユニバーサル アナリティクス カスタムトラッカー名 t2


該当する投稿案がない場合、全ての値が undefined のオブジェクトがコールバックされます。

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています
他にご質問がございましたら、リクエストを送信してください

0 コメント

ログインしてコメントを残してください。