統合ランチャーオプション
概要
IntegrationLauncher のインスタンスのオプション。統合ランチャーのインスタンスを作成するときには、あなたのユニークなRoktアカウントIDを渡すことが必須です。他のパラメータは任意であり、統合の動作を設定することができます。
プロパティ
accountId
• accountId : string
あなたのユニークなRoktアカウントID。RoktアカウントIDはどこで見つけられますか?を参照して、RoktアカウントIDを見つける方法を確認してください。
noFunctional (オプション)
• noFunctional? : boolean
デフォルト false
機能性クッキーに対するユーザーの好みを管理するためのブールフラグ。機能性クッキーは、サイト上で最も関連性が高く最適なカスタマーエクスペリエンスを提供し、パーソナライズを強化します。また、（例：Upsell の販売）チェックアウト内の高度な機能を支援します。実際には、この値を true に設定すると、Rokt が 1st パーティのトラッキングIDを使用することを防止します。このオプションの機能および利用の影響についての詳細。
pageInitTimestamp (オプション)
• pageInitTimestamp? : Date
SPA の仮想ページで Integration Launcher が初期化される場合、この値により初期化されたページのタイムスタンプを提供できます。これにより、Rokt はユーザーがそのページに到達するのにかかった時間などの外的要因を考慮せずに、トリガーされたページに対するロードパフォーマンスを正確に測定できます。この情報を使用して、Rokt はインテグレーションの効率に影響を与える可能性のあるロード時間の異常を検出できます。
default PerformanceNavigationTiming.responseStart
Rokt がロードパフォーマンスをどのように追跡するかについては、異常検出 を参照してください。
SPA インテグレーションの詳細については、シングルページアプリケーション を参照してください。
sandbox (オプション)
• sandbox? : boolean
default false
セッションにサンドボックス環境を使用するかどうかを示すブールフラグ。
これは本番環境で true に設定されるべきではありません。
このフラグは次のような場合に役立ちます：
- パートナーが本番環境でリファラルを生成せずに、プロダクション設定に対してユーザー受け入れテストを実施したい場合。
- サンドボックスはパートナー側の継続的インテグレーション環境で使用されます。
詳細は サンドボックスインテグレーション を参照してください。
sessionId (オプション)
• sessionId? : string
すでに生成済みのRoktセッションIDがある場合に渡すセッションID。
例えば、タグが表示されるページに訪れる前にRoktバックエンドと接続してセッションIDを生成することが可能です。この場合、以前に生成されたRoktセッションIDをこのパラメータとして提供する必要があります。これにより、Roktは両方のインタラクションをペアリングすることができます。
overrideLinkNavigation (オプション)
• overrideLinkNavigation? : boolean
default false
true に設定すると、Roktがリンクの開きを直接処理しなくなります。その代わりに、LINK_NAVIGATION_REQUEST パートナーイベントが発行されます。
このフラグは、パートナーがカスタマイズされたリンク処理を必要とするシナリオで便利です。よくあるユースケースとしては、WebView内でリンクを開く一方で、Roktや広告主からのリンクについては外部ブラウザを使用するなど、異なるリンク動作を管理することです。Roktと広告主のリンクを区別するために、パートナーはURLに "rokt.com" という部分文字列が含まれているかどうかを確認することができます。
適切なイベント処理を確保するために、タイムアウトメカニズムがあります。LINK_NAVIGATION_REQUEST イベントが3秒以内に消費されない場合 、エラーが発生します。この予防措置により、イベントを処理するためのアクティブなサブスクリプションがパートナー側に存在していることが確実になるとともに、それがない場合にはRoktに通知されます。