オプトアウト機能¶
Web SDKによるデータ収集とWebメッセージの表示を無効にしたい場合は、オプトアウト機能を利用してください。オプトアウト状態になるとSDKの動作は以下の通りとなります。
- セッションを開始しません
- Reproのサーバにデータを送信しません
- Webメッセージを表示しません
注釈
- オプトアウトの状態はユーザー毎ではなくブラウザ毎の設定です。同一ユーザーが複数ブラウザ所持している場合、全てのブラウザでオプトアウトするにはブラウザ毎にオプトアウトの設定が必要です。
- ユーザープロフィール、イベントはオプトイン後にセットしてください。オプトアウト状態でセットしても無視されます。
警告
- オプトアウト機能はWeb SDKバージョン2 から利用できます。
オプトインの初期状態の指定¶
オプトインの初期状態はsetupのオプションに opt_out_by_default を指定することができます。
デフォルトは false となり、初期状態はオプトイン状態になります。
初期状態をオプトアウト状態にしたい場合は、true を設定してください。初期状態の指定方法は次のようになります。
オプションの設定方法
reproio("setup", "YOUR_REPRO_SDK_TOKEN", { opt_out_by_default: true });
オプトインの指定¶
オプトインを設定するには optIn APIを利用することで、オプトアウト状態からオプトイン状態に切り替えることができます。
reproio('optIn');
注釈
- オプトアウト状態からオプトイン状態に変更したタイミングでセッションを開始します。
警告
- optIn APIを呼んだ後に必ず、reproio("setup", "YOUR_REPRO_SDK_TOKEN"); を呼び出してください。
- ユーザーIDも設定する場合は、optIn APIを呼び出した後に
setUserIDを設定しその後setupを呼び出してください。
オプトイン/オプトアウトの状態を確認する¶
isOptedIn APIを利用することで、オプトイン/オプトアウトの状態を確認することができます。返り値はboolean型となります。
オプトイン状態の場合は true 、オプトアウト状態の場合は false の値が返ってきます。
reproio('isOptedIn');