API¶

Setup / ユーザーID¶

reproio('setup', token, options)¶

token: string (必須)
- Reproの管理画面にある SDKトークン を設定してください。
options: object

オプション:

Key	Value	説明
disable_ip_list	array (string)	除外したいグローバルIPを設定できます。（e.g. ["111.111.1.1"]）
log_level	string	"info", "warn", "error", "none" のいずれかが選択できます。 (デフォルト: 'default')
opt_out_by_default	boolean	"true", "false" のいずれかが選択できます。 (デフォルト: false)
silver_egg_uid_storage_key	string	シルバーエッグレコメンドメッセージのためのユーザーIDが登録されているCookieのキーを設定できます。
allow_webview	boolean	WebViewだと判定される環境において、Repro Webの動作を許可するか設定できます。
linker_domains	array (string)	複数の異なるドメインにまたがってユーザーの情報を引き継ぐ設定ができます。（e.g. ["example.com"]）参考: クロスドメイン・トラッキング機能
disable_linker_params_referrer_check	boolean	クロスドメインとして設定された遷移元のデータを引き継ぐ際、まず `document.referrer` を確認してクロスドメインなトラッキングとみなしてよいかを判別します。 (デフォルト: false) 参考: クロスドメイン・トラッキング機能
disable_auto_attach_linker_params	boolean	クロスドメイン・トラッキング機能をオンにするとページ内のDOMに変化があった際に自動的に新規のaタグにもパラメータを付与しますが、このオプションを "true" に設定することでこの挙動を無効にできます。 (デフォルト: false) 参考: クロスドメイン・トラッキング機能
interval_days_to_storage_expiration	integer	ユーザーの識別子を含む、Cookieに保存している各種情報の保持日数 (デフォルト: 730)
session_expiry_interval	integer	あるイベントが発生した際に、その直前のイベントからどれくらいの時間が経過していれば新しいセッションとみなすかを決める時間（秒） (デフォルト: 1800000 = 30分)
spa_mode	string	SPAモードを有効にします。ページ遷移時のイベントハンドリングが可能になります。有効な値は `'history'` , `'hash'` , `'none'` の3つです。 (デフォルト: 'none')
close_messages_on_pagechange	boolean	SPAモードのページ遷移時にメッセージを自動的に閉じます。 (デフォルト: false)
reuse_messages_on_pagechange	string	SPAモードにおいてメッセージを再利用し、毎回のページ遷移で表示可能にします。有効な値は `'unlimited'`, `'multitime'`, `'none'` です。`'unlimited'` では表示回数制限の全くないメッセージのみを再利用します。`'multitime'` の場合、複数回表示可能かつ１日あたりの回数制限のないメッセージを再利用します。この場合、同時に複数のブラウザやタブを利用しているケースではメッセージが表示回数以上に表示される可能性があります。 `'none'` の場合はメッセージの再利用を行わず、無制限表示のメッセージであっても一定間隔(標準で3分間隔)でしか表示されません。 (デフォルト: 'none')
close_messages_by_in_page_link	boolean	ページ内リンク(例: `<a href="#foo">`)をクリックした場合、表示中のメッセージをすべて閉じます。spa_mode が `hash` の場合は無視されます (デフォルト: true)
cookie_domain	string	Web SDKが記録するCookieのドメインを設定できます。省略された場合には、現在のサイトのドメインにおけるApexドメイン（ `shop.example.com` では `example.com` ）が利用されます。

例:

<script>
    !function(o,e,n){var r=[];if(window.reproio)console.info("Repro Web SDK was loaded more than once");else{window.reproio=function(){r.push(arguments)};var i=o.createElement(e),t=o.getElementsByTagName(e)[0];i.src="https://cdn.reproio.com/web/v2/repro-sdk.min.js",i.async=!0,i.crossOrigin="",i.onload=function(){window.reproio("setSnippetVersion","2.1"),r.forEach(function(o){window.reproio.apply(window.reproio,o)})},t.parentNode.insertBefore(i,t)}}(document,"script");
    reproio("setup", "YOUR_REPRO_SDK_TOKEN");
</script>

参考:　導入

reproio('setUserID', userID)¶

userID: string (必須)
- ユーザーIDを設定してください。
- setupの直前にセットするようにしてください。

reproio("setUserID", "xxxxxxxxxxxx");

参考: ユーザーID

イベントトラッキング¶

reproio('track', name, properties)¶

name: string (必須)
- イベント名を設定してください。
- ___repro___ から始まるイベント名は使用できません。
- イベント名にnullや空文字列は不可、上限は191文字です。

properties: object
- イベントの付帯情報としてプロパティを設定できます。
- key: string
- value: string | integer | double | date

例:

// Custom event
reproio("track", "Finished tutorial");


// Custom event with properties
reproio("track", "user review", { rating: 3 });

参考: イベントトラッキング

reproio('trackAddPaymentInfo', properties)¶

properties: object

プロパティ:

Key	Value	説明
content_id	string	商品やページを示すID
content_category	string	商品やページのカテゴリ
value	double	商品の金額
currency	string	valueに指定した値の通貨単位
extras	object	カスタムプロパティ詳細はこちら

例:

reproio("trackAddPaymentInfo", {
  value: 8000.0,
  currency: "JPY",
  content_category: "Clothing & Shoes > Mens > Clothing",
  content_id: "1234"
});

参考: イベントトラッキング

reproio('trackAddToCart', content_id, properties)¶

content_id: string (必須)
- 商品やページを示すIDを設定してください。
properties: object

プロパティ:

Key	Value	説明
content_name	string	商品やページの名前
content_category	string	商品やページのカテゴリ
value	double	商品の金額
currency	string	valueに指定した値の通貨単位
extras	object	カスタムプロパティ詳細はこちら

例:

reproio("trackAddToCart", "1234", {
  value: 5000.0,
  currency: "JPY",
  content_name: "Slim Jeans",
  content_category: "Clothing & Shoes > Mens > Clothing"
});

参考: イベントトラッキング

reproio('trackAddToWishlist', properties)¶

properties: object

プロパティ:

Key	Value	説明
content_id	string	商品やページを示すID
content_name	string	商品やページの名前
content_category	string	商品やページのカテゴリ
value	double	商品の金額
currency	string	valueに指定した値の通貨単位
extras	object	カスタムプロパティ詳細はこちら

例:

 reproio("trackAddToWishlist", {
  value: 5000.0,
  currency: "JPY",
  content_name: "Slim Jeans",
  content_category: "Clothing & Shoes > Mens > Clothing",
  content_id: "1234"
});

参考: イベントトラッキング

reproio('trackCompleteRegistration', properties)¶

properties: object

プロパティ:

Key	Value	説明
content_name	string	商品やページの名前
value	double	商品の金額
currency	string	valueに指定した値の通貨単位
status	string	登録状態
extras	object	カスタムプロパティ詳細はこちら

例:

reproio("trackCompleteRegistration", {
  value: 8000.0,
  currency: "JPY",
  content_name: "Slim Jeans",
  status: "completed"
});

参考: イベントトラッキング

reproio('trackInitiateCheckout', properties)¶

properties: object

プロパティ:

Key	Value	説明
content_id	string	商品やページを示すID
content_name	string	商品やページの名前
content_category	string	商品やページのカテゴリ
value	double	商品の金額
currency	string	valueに指定した値の通貨単位
num_items	integer	同一の商品の購入数
extras	object	カスタムプロパティ詳細はこちら

例:

reproio("trackInitiateCheckout", {
  value: 8000.0,
  currency: "JPY",
  content_name: "Slim Jeans",
  content_category: "Clothing & Shoes > Mens > Clothing",
  content_id: "1234"
});

参考: イベントトラッキング

reproio('trackLead', properties)¶

properties: object

プロパティ:

Key	Value	説明
content_name	string	商品やページの名前
content_category	string	商品やページのカテゴリ
value	double	商品の金額
currency	string	valueに指定した値の通貨単位
extras	object	カスタムプロパティ詳細はこちら

例:

reproio("trackLead", {
  value: 8000.0,
  currency: "JPY",
  content_name: "Slim Jeans",
  content_category: "Clothing & Shoes > Mens > Clothing"
});

参考: イベントトラッキング

reproio('trackPurchase`, content_id, value, currency, properties)¶

content_id: string (必須)
- 商品やページを示すIDを設定してください。
value: double (必須)
- 商品の金額を設定してください。
currency: string (必須)
- valueに指定した値の通貨単位を設定してください。
properties: object

プロパティ:

Key	Value	説明
content_name	string	商品やページの名前
content_category	string	商品やページのカテゴリ
num_items	integer	同一の商品の購入数
extras	object	カスタムプロパティ詳細はこちら

例:

reproio("trackPurchase", "1234", 8000.0, "JPY", {
  content_name: "Slim Jeans",
  content_category: "Clothing & Shoes > Mens > Clothing",
  num_items: 2
});

参考: イベントトラッキング

reproio('trackSearch', properties)¶

properties: object

プロパティ:

Key	Value	説明
content_id	string	商品やページを示すID
content_category	string	商品やページのカテゴリ
value	double	商品の金額
currency	string	valueに指定した値の通貨単位
search_string	string	ユーザーが入力した検索文字列
extras	object	カスタムプロパティ詳細はこちら

例:

reproio("trackSearch", {
  value: 3000.0,
  currency: "JPY",
  content_category: "Clothing & Shoes > Mens > Clothing",
  search_string: "Jeans",
  content_id: "1234"
});

参考: イベントトラッキング

reproio('trackShare', properties)¶

properties: object

プロパティ:

Key	Value	説明
content_id	string	商品やページを示すID
content_name	string	商品やページの名前
content_category	string	商品やページのカテゴリ
service_name	string	サービスの名前
extras	object	カスタムプロパティ詳細はこちら

例:

reproio("trackShare", {
  content_category: "Clothing & Shoes > Mens > Clothing",
  content_name: "Slim Jeans",
  content_id: "1234",
  service_name: "twitter"
});

参考: イベントトラッキング

reproio('trackViewContent', content_id, properties)¶

content_id: string (必須)
- 商品やページを示すIDを設定してください。
properties: object

プロパティ:

Key	Value	説明
content_name	string	商品やページの名前
content_category	string	商品やページのカテゴリ
value	double	商品の金額
currency	string	valueに指定した値の通貨単位
extras	object	カスタムプロパティ詳細はこちら

例:

reproio("trackViewContent", "1234", {
  value: 5000.0,
  currency: "JPY",
  content_name: "Slim Jeans",
  content_category: "Clothing & Shoes > Mens > Clothing"
});

参考: イベントトラッキング

ユーザープロフィール¶

reproio('setDateUserProfile', key, value)¶

key: string (必須)
- ___repro___ から始まるイベント名は使用できません。
- イベント名にnullや空文字列は不可、上限は255文字です。
value: date (必須)

例:

var now = new Date();
reproio("setDateUserProfile", "LastLogin", now);

参考: ユーザープロフィール

reproio('setDoubleUserProfile', key, value)¶

key: string (必須)
- ___repro___ から始まるイベント名は使用できません。
- イベント名にnullや空文字列は不可、上限は255文字です。
value: double (必須)

例:

reproio("setDoubleUserProfile", "Height", 176.5);

参考: ユーザープロフィール

reproio('setIntUserProfile', key, value)¶

key: string (必須)
- ___repro___ から始まるイベント名は使用できません。
- イベント名にnullや空文字列は不可、上限は255文字です。
value: integer (必須)

例:

reproio("setIntUserProfile", "Age", 25);

参考: ユーザープロフィール

reproio('setStringUserProfile', key, value)¶

key: string (必須)
- ___repro___ から始まるイベント名は使用できません。
- イベント名にnullや空文字列は不可、上限は255文字です。
value: string (必須)
- セットできる文字数の上限は255文字です。

例:

reproio("setStringUserProfile", "Job", "Developer");

参考: ユーザープロフィール

reproio('setUserEmailAddress', value)¶

value: string (必須)

例:

reproio("setUserEmailAddress", "user@example.com");

参考: ユーザープロフィール

reproio('setUserGender', value)¶

value: string (必須)
- 次の値を設定できます。: "male", "female", "other"

// set the gender as "male"
reproio("setUserGender", "male");
// set the gender as "female"
reproio("setUserGender", "female");
// set the gender as "other"
reproio("setUserGender", "other");

参考: ユーザープロフィール

デバイスID¶

reproio('getDeviceID')¶

reproio('getDeviceID');

参考: デバイスID

オプトアウト機能¶

reproio('isOptedIn')¶

返り値：

Value	説明
true	オプトイン状態を示します。
false	オプトアウト状態を示します。

reproio('isOptedIn');

参考: オプトアウト機能

reproio('optIn')¶

reproio('optIn');

参考: オプトアウト機能

reproio('optOut')¶

reproio('optOut');

参考: オプトアウト機能

クロスドメイン・トラッキング機能¶

reproio('updateLinkerParameters')¶

reproio('updateLinkerParameters');

参考: クロスドメイン・トラッキング機能

LINEユーザーIDの連携¶

reproio('linkLineID', lineUserID, lineChannelID)¶

lineUserID: string (必須)
- LINEのユーザーIDを設定してください。
lineChannelID: string (必須)
- LINEのチャネルIDを設定してください。

例:

// Set user ID first
reproio('setUserID', 'user123');

// Link LINE User ID
reproio('linkLineID', 'LINE_USER_ID', 'LINE_CHANNEL_ID');

参考: LINEユーザーIDの連携

reproio('unlinkLineID', lineUserID, lineChannelID)¶

lineUserID: string (必須)
- LINEのユーザーIDを設定してください。
lineChannelID: string (必須)
- LINEのチャネルIDを設定してください。

例:

reproio('unlinkLineID', 'LINE_USER_ID', 'LINE_CHANNEL_ID');

参考: LINEユーザーIDの連携

その他¶

reproio('version')¶

現在の SDK のバージョンを返します。